TonemapCurve
class TonemapCurve
kotlin.Any | |
↳ | android.hardware.camera2.params.TonemapCurve |
Immutable class for describing a 2 x M x 3
tonemap curve of floats.
This defines red, green, and blue curves that the CameraDevice
will use as the tonemapping/contrast/gamma curve when CaptureRequest#TONEMAP_MODE
is set to CameraMetadata#TONEMAP_MODE_CONTRAST_CURVE
.
For a camera device with MONOCHROME
capability, all 3 channels will contain the same set of control points.
The total number of points (Pin, Pout)
for each color channel can be no more than CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS
.
The coordinate system for each point is within the inclusive range [{@value #LEVEL_BLACK}, {@value #LEVEL_WHITE}].
Summary
Constants | |
---|---|
static Int |
Index of the blue color channel curve. |
static Int |
Index of the green color channel curve. |
static Int |
Index of the red color channel curve. |
static Float |
Lower bound tonemap value corresponding to pure black for a single color channel. |
static Float |
Upper bound tonemap value corresponding to a pure white for a single color channel. |
static Int |
Number of elements in a |
Public constructors | |
---|---|
TonemapCurve(red: FloatArray!, green: FloatArray!, blue: FloatArray!) Create a new immutable TonemapCurve instance. |
Public methods | |
---|---|
Unit |
copyColorCurve(colorChannel: Int, destination: FloatArray!, offset: Int) Copy the color curve for a single color channel from this tonemap curve into the destination. |
Boolean |
Check if this TonemapCurve is equal to another TonemapCurve. |
PointF! |
Get the point for a color channel at a specified index. |
Int |
getPointCount(colorChannel: Int) Get the number of points stored in this tonemap curve for the specified color channel. |
Int |
hashCode() Returns a hash code value for the object. |
String |
toString() Return the TonemapCurve as a string representation. |
Constants
CHANNEL_BLUE
static val CHANNEL_BLUE: Int
Index of the blue color channel curve.
Value: 2
CHANNEL_GREEN
static val CHANNEL_GREEN: Int
Index of the green color channel curve.
Value: 1
CHANNEL_RED
static val CHANNEL_RED: Int
Index of the red color channel curve.
Value: 0
LEVEL_BLACK
static val LEVEL_BLACK: Float
Lower bound tonemap value corresponding to pure black for a single color channel.
Value: 0.0f
LEVEL_WHITE
static val LEVEL_WHITE: Float
Upper bound tonemap value corresponding to a pure white for a single color channel.
Value: 1.0f
POINT_SIZE
static val POINT_SIZE: Int
Number of elements in a (Pin, Pout)
point;
Value: 2
Public constructors
TonemapCurve
TonemapCurve(
red: FloatArray!,
green: FloatArray!,
blue: FloatArray!)
Create a new immutable TonemapCurve instance.
Values are stored as a contiguous array of (Pin, Pout)
points.
All parameters may have independent length but should have at most CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS
* {@value #POINT_SIZE} elements and at least 2 * {@value #POINT_SIZE} elements.
All sub-elements must be in the inclusive range of [{@value #LEVEL_BLACK}, {@value #LEVEL_WHITE}].
This constructor copies the array contents and does not retain ownership of the array.
Parameters | |
---|---|
red |
FloatArray!: An array of elements whose length is divisible by {@value #POINT_SIZE} |
green |
FloatArray!: An array of elements whose length is divisible by {@value #POINT_SIZE} |
blue |
FloatArray!: An array of elements whose length is divisible by {@value #POINT_SIZE} |
Exceptions | |
---|---|
java.lang.IllegalArgumentException |
if any of input array length is invalid, or if any of the elements in the array are not in the range of [{@value #LEVEL_BLACK}, {@value #LEVEL_WHITE}] |
java.lang.NullPointerException |
if any of the parameters are null |
Public methods
copyColorCurve
fun copyColorCurve(
colorChannel: Int,
destination: FloatArray!,
offset: Int
): Unit
Copy the color curve for a single color channel from this tonemap curve into the destination.
Values are stored as packed (Pin, Pout
) points, and there are a total of getPointCount
points for that respective channel.
All returned coordinates are between the range of [{@value #LEVEL_BLACK}, {@value #LEVEL_WHITE}].
Parameters | |
---|---|
destination |
FloatArray!: an array big enough to hold at least getPointCount * POINT_SIZE elements after the offset |
offset |
Int: a non-negative offset into the array |
Exceptions | |
---|---|
java.lang.NullPointerException |
If destination was null |
java.lang.IllegalArgumentException |
If offset was negative |
java.lang.ArrayIndexOutOfBoundsException |
If there's not enough room to write the elements at the specified destination and offset. |
See Also
equals
fun equals(other: Any?): Boolean
Check if this TonemapCurve is equal to another TonemapCurve.
Two matrices are equal if and only if all of their elements are equal
.
Parameters | |
---|---|
obj |
This value may be null . |
Return | |
---|---|
Boolean |
true if the objects were equal, false otherwise |
getPoint
fun getPoint(
colorChannel: Int,
index: Int
): PointF!
Get the point for a color channel at a specified index.
The index must be at least 0 but no greater than getPointCount(int)
for that colorChannel
.
All returned coordinates in the point are between the range of [{@value #LEVEL_BLACK}, {@value #LEVEL_WHITE}].
Parameters | |
---|---|
colorChannel |
Int: CHANNEL_RED , CHANNEL_GREEN , or CHANNEL_BLUE |
index |
Int: at least 0 but no greater than getPointCount(colorChannel) |
Return | |
---|---|
PointF! |
the (Pin, Pout) pair mapping the tone for that index |
Exceptions | |
---|---|
java.lang.IllegalArgumentException |
if colorChannel or index was out of range |
See Also
getPointCount
fun getPointCount(colorChannel: Int): Int
Get the number of points stored in this tonemap curve for the specified color channel.
Parameters | |
---|---|
colorChannel |
Int: one of CHANNEL_RED , CHANNEL_GREEN , CHANNEL_BLUE |
Return | |
---|---|
Int |
number of points stored in this tonemap for that color's curve (>= 0) |
Exceptions | |
---|---|
java.lang.IllegalArgumentException |
if colorChannel was out of range |
hashCode
fun hashCode(): Int
Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap
.
The general contract of hashCode
is:
- Whenever it is invoked on the same object more than once during an execution of a Java application, the
hashCode
method must consistently return the same integer, provided no information used inequals
comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. - If two objects are equal according to the
equals
method, then calling thehashCode
method on each of the two objects must produce the same integer result. - It is not required that if two objects are unequal according to the
equals
method, then calling thehashCode
method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Return | |
---|---|
Int |
a hash code value for this object. |
toString
fun toString(): String
Return the TonemapCurve as a string representation.
"TonemapCurve{R:[(%f, %f), (%f, %f) ... (%f, %f)], G:[(%f, %f), (%f, %f) ... (%f, %f)], B:[(%f, %f), (%f, %f) ... (%f, %f)]}"
, where each (%f, %f)
respectively represents one point of the corresponding tonemap curve.
Return | |
---|---|
String |
string representation of TonemapCurve |