Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Constants](https://developer.android.com/reference/android/hardware/LutProperties#constants) \| [Methods](https://developer.android.com/reference/android/hardware/LutProperties#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/hardware/LutProperties#inhmethods)

# LutProperties

*** ** * ** ***

` public final class LutProperties `   
` extends https://developer.android.com/reference/java/lang/Object ` ` `

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.hardware.LutProperties |

<br />

*** ** * ** ***

Provides Lut properties of the device.

A Lut (Look-Up Table) is a pre-calculated table for color correction. Applications may be interested in the Lut properties exposed by this class to determine if the Lut(s) they select using `https://developer.android.com/reference/android/view/SurfaceControl.Transaction#setLuts(android.view.SurfaceControl,%20android.hardware.DisplayLuts)` are by the HWC.

<br />

## Summary

| ### Constants ||
|---|---|
| `int` | `https://developer.android.com/reference/android/hardware/LutProperties#ONE_DIMENSION` The Lut is one dimensional |
| `int` | `https://developer.android.com/reference/android/hardware/LutProperties#SAMPLING_KEY_CIE_Y` use y of CIE XYZ as the gain value of a lut |
| `int` | `https://developer.android.com/reference/android/hardware/LutProperties#SAMPLING_KEY_MAX_RGB` use max of r,g,b channel as the gain value of a Lut |
| `int` | `https://developer.android.com/reference/android/hardware/LutProperties#SAMPLING_KEY_RGB` use r,g,b channel as the gain value of a Lut |
| `int` | `https://developer.android.com/reference/android/hardware/LutProperties#THREE_DIMENSION` The Lut is three dimensional |

| ### Public methods ||
|---|---|
| ` boolean` | ` https://developer.android.com/reference/android/hardware/LutProperties#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) ` Indicates whether some other object is "equal to" this one. |
| ` int` | ` https://developer.android.com/reference/android/hardware/LutProperties#getDimension()() ` |
| ` int[]` | ` https://developer.android.com/reference/android/hardware/LutProperties#getSamplingKeys()() ` |
| ` int` | ` https://developer.android.com/reference/android/hardware/LutProperties#getSize()() ` |
| ` int` | ` https://developer.android.com/reference/android/hardware/LutProperties#hashCode()() ` Returns a hash code value for the object. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/hardware/LutProperties#toString()() ` Returns a string representation of the object. |

### Inherited methods

From class ` https://developer.android.com/reference/java/lang/Object ` ` https://developer.android.com/reference/java/lang/Object` ` https://developer.android.com/reference/java/lang/Object#clone()() `

Creates and returns a copy of this object.
` boolean` ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) `

Indicates whether some other object is "equal to" this one.
` void` ` https://developer.android.com/reference/java/lang/Object#finalize()() `

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
` final https://developer.android.com/reference/java/lang/Class<?>` ` https://developer.android.com/reference/java/lang/Object#getClass()() `

Returns the runtime class of this `Object`.
` int` ` https://developer.android.com/reference/java/lang/Object#hashCode()() `

Returns a hash code value for the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#notify()() `

Wakes up a single thread that is waiting on this object's monitor.
` final void` ` https://developer.android.com/reference/java/lang/Object#notifyAll()() `

Wakes up all threads that are waiting on this object's monitor.
` https://developer.android.com/reference/java/lang/String` ` https://developer.android.com/reference/java/lang/Object#toString()() `

Returns a string representation of the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(long timeoutMillis, int nanos) `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long)(long timeoutMillis) `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait()() `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*.

## Constants

### ONE_DIMENSION

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int ONE_DIMENSION
```

The Lut is one dimensional

<br />

Constant Value: 1 (0x00000001)

### SAMPLING_KEY_CIE_Y

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int SAMPLING_KEY_CIE_Y
```

use y of CIE XYZ as the gain value of a lut

<br />

Constant Value: 2 (0x00000002)

### SAMPLING_KEY_MAX_RGB

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int SAMPLING_KEY_MAX_RGB
```

use max of r,g,b channel as the gain value of a Lut

<br />

Constant Value: 1 (0x00000001)

### SAMPLING_KEY_RGB

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int SAMPLING_KEY_RGB
```

use r,g,b channel as the gain value of a Lut

<br />

Constant Value: 0 (0x00000000)

### THREE_DIMENSION

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int THREE_DIMENSION
```

The Lut is three dimensional

<br />

Constant Value: 3 (0x00000003)

## Public methods

### equals

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public boolean equals (Object obj)
```

Indicates whether some other object is "equal to" this one.

The `equals` method implements an equivalence relation on non-null object references:

- It is *reflexive*: for any non-null reference value `x`, `x.equals(x)` should return `true`.
- It is *symmetric*: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`.
- It is *transitive*: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`.
- It is *consistent*: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified.
- For any non-null reference value `x`, `x.equals(null)` should return `false`.

An equivalence relation partitions the elements it operates on into *equivalence classes*; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

<br />

| Parameters ||
|---|---|
| `obj` | `Object`: the reference object with which to compare. <br /> |

| Returns ||
|---|---|
| `boolean` | `true` if this object is the same as the obj argument; `false` otherwise. <br /> |

### getDimension

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getDimension ()
```

<br />

<br />

| Returns ||
|---|---|
| `int` | Value is one of the following: - `https://developer.android.com/reference/android/hardware/LutProperties#ONE_DIMENSION` - `https://developer.android.com/reference/android/hardware/LutProperties#THREE_DIMENSION` |

### getSamplingKeys

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int[] getSamplingKeys ()
```

<br />

<br />

| Returns ||
|---|---|
| `int[]` | the list of sampling keys. This value cannot be `null`. Value is one of the following: - `https://developer.android.com/reference/android/hardware/LutProperties#SAMPLING_KEY_RGB` - `https://developer.android.com/reference/android/hardware/LutProperties#SAMPLING_KEY_MAX_RGB` - `https://developer.android.com/reference/android/hardware/LutProperties#SAMPLING_KEY_CIE_Y` |

### getSize

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getSize ()
```

<br />

<br />

| Returns ||
|---|---|
| `int` | the size of the Lut for each dimension <br /> |

### hashCode

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int hashCode ()
```

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by `https://developer.android.com/reference/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 in `equals` 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 `https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)` method, then calling the `hashCode` 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 `https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)` method, then calling the `hashCode` 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.

<br />

<br />

| Returns ||
|---|---|
| `int` | a hash code value for this object. <br /> |

### toString

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String toString ()
```

Returns a string representation of the object.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | a string representation of the object. <br /> |