# OverlayProperties
Added in[API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
Summary:[Inherited Constants](https://developer.android.com/reference/android/hardware/OverlayProperties#inhconstants)\|[Fields](https://developer.android.com/reference/android/hardware/OverlayProperties#lfields)\|[Methods](https://developer.android.com/reference/android/hardware/OverlayProperties#pubmethods)\|[Inherited Methods](https://developer.android.com/reference/android/hardware/OverlayProperties#inhmethods)
# OverlayProperties
*** ** * ** ***
[Kotlin](https://developer.android.com/reference/kotlin/android/hardware/OverlayProperties "View this page in Kotlin")\|Java
`
public
final
class
OverlayProperties
`
`
extends `[Object](https://developer.android.com/reference/java/lang/Object)`
``
implements
`[Parcelable](https://developer.android.com/reference/android/os/Parcelable)`
`
|---|------------------------------------|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.hardware.OverlayProperties |
*** ** * ** ***
Provides supported overlay properties of the device.
Hardware overlay is a technique to composite different buffers directly to the screen using display hardware rather than the GPU. The system compositor is able to assign any content managed by a[SurfaceControl](https://developer.android.com/reference/android/view/SurfaceControl)onto a hardware overlay if possible. Applications may be interested in the display hardware capabilities exposed by this class as a hint to determine if their[SurfaceControl](https://developer.android.com/reference/android/view/SurfaceControl)tree is power-efficient and performant.
## Summary
| ### Inherited constants |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| From interface[android.os.Parcelable](https://developer.android.com/reference/android/os/Parcelable) |-------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `int` | [CONTENTS_FILE_DESCRIPTOR](https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR) Descriptor bit used with[describeContents()](https://developer.android.com/reference/android/os/Parcelable#describeContents()): indicates that the Parcelable object's flattened representation includes a file descriptor. | | `int` | [PARCELABLE_WRITE_RETURN_VALUE](https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE) Flag for use with[writeToParcel(Parcel, int)](https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)): the object being written is a return value, that is the result of a function such as "`Parcelable someFunction()`", "`void someFunction(out Parcelable)`", or "`void someFunction(inout Parcelable)`". | |
| ### Fields ||
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------|
| ` public static final `[Creator](https://developer.android.com/reference/android/os/Parcelable.Creator)`<`[OverlayProperties](https://developer.android.com/reference/android/hardware/OverlayProperties)`>` | [CREATOR](https://developer.android.com/reference/android/hardware/OverlayProperties#CREATOR)
|
| ### Public methods ||
|----------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` int` | ` `[describeContents](https://developer.android.com/reference/android/hardware/OverlayProperties#describeContents())`() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| ` `[LutProperties[]](https://developer.android.com/reference/android/hardware/LutProperties) | ` `[getLutProperties](https://developer.android.com/reference/android/hardware/OverlayProperties#getLutProperties())`() ` Returns the lut properties of the device. |
| ` boolean` | ` `[isCombinationSupported](https://developer.android.com/reference/android/hardware/OverlayProperties#isCombinationSupported(int,%20int))`(int dataspace, int format) ` Indicates that hardware composition of a buffer encoded with the provided[DataSpace](https://developer.android.com/reference/android/hardware/DataSpace)and[ERROR(HardwareBuffer.Format/android.hardware.HardwareBuffer.Format HardwareBuffer.Format)](https://developer.android.com/)is supported on the device. |
| ` boolean` | ` `[isMixedColorSpacesSupported](https://developer.android.com/reference/android/hardware/OverlayProperties#isMixedColorSpacesSupported())`() ` Indicates that hardware composition of two or more overlays with different colorspaces is supported on the device. |
| ` void` | ` `[writeToParcel](https://developer.android.com/reference/android/hardware/OverlayProperties#writeToParcel(android.os.Parcel,%20int))`(`[Parcel](https://developer.android.com/reference/android/os/Parcel)` dest, int flags) ` Flatten this object in to a Parcel. |
| ### Inherited methods |
|-----------------------|---|
| From class` `[java.lang.Object](https://developer.android.com/reference/java/lang/Object)` ` |--------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` `[Object](https://developer.android.com/reference/java/lang/Object) | ` `[clone](https://developer.android.com/reference/java/lang/Object#clone())`() ` Creates and returns a copy of this object. | | ` boolean` | ` `[equals](https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object))`(`[Object](https://developer.android.com/reference/java/lang/Object)` obj) ` Indicates whether some other object is "equal to" this one. | | ` void` | ` `[finalize](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 `[Class](https://developer.android.com/reference/java/lang/Class)`` | ` `[getClass](https://developer.android.com/reference/java/lang/Object#getClass())`() ` Returns the runtime class of this`Object`. | | ` int` | ` `[hashCode](https://developer.android.com/reference/java/lang/Object#hashCode())`() ` Returns a hash code value for the object. | | ` final void` | ` `[notify](https://developer.android.com/reference/java/lang/Object#notify())`() ` Wakes up a single thread that is waiting on this object's monitor. | | ` final void` | ` `[notifyAll](https://developer.android.com/reference/java/lang/Object#notifyAll())`() ` Wakes up all threads that are waiting on this object's monitor. | | ` `[String](https://developer.android.com/reference/java/lang/String) | ` `[toString](https://developer.android.com/reference/java/lang/Object#toString())`() ` Returns a string representation of the object. | | ` final void` | ` `[wait](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` | ` `[wait](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` | ` `[wait](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*. | ||
| From interface` `[android.os.Parcelable](https://developer.android.com/reference/android/os/Parcelable)` ` |------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` abstract int` | ` `[describeContents](https://developer.android.com/reference/android/os/Parcelable#describeContents())`() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. | | ` abstract void` | ` `[writeToParcel](https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int))`(`[Parcel](https://developer.android.com/reference/android/os/Parcel)` dest, int flags) ` Flatten this object in to a Parcel. | ||
## Fields
### CREATOR
Added in[API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public static final Creator CREATOR
```
## Public methods
### describeContents
Added in[API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public int describeContents ()
```
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of[writeToParcel(android.os.Parcel, int)](https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)), the return value of this method must include the[CONTENTS_FILE_DESCRIPTOR](https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR)bit.
| Returns ||
|-------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `int` | a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either`0`or[CONTENTS_FILE_DESCRIPTOR](https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR)
|
### getLutProperties
Added in[API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public LutProperties[] getLutProperties ()
```
Returns the lut properties of the device.
| Returns ||
|-------------------------------------------------------------------------------------------|------------------------------------|
| [LutProperties[]](https://developer.android.com/reference/android/hardware/LutProperties) | This value cannot be`null`.
|
### isCombinationSupported
Added in[API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public boolean isCombinationSupported (int dataspace,
int format)
```
Indicates that hardware composition of a buffer encoded with the provided[DataSpace](https://developer.android.com/reference/android/hardware/DataSpace)and[ERROR(HardwareBuffer.Format/android.hardware.HardwareBuffer.Format HardwareBuffer.Format)](https://developer.android.com/)is supported on the device.
| Parameters ||
|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `dataspace` | `int`: Value is either`0`or a combination of[DataSpace.DATASPACE_UNKNOWN](https://developer.android.com/reference/android/hardware/DataSpace#DATASPACE_UNKNOWN),[DataSpace.DATASPACE_SCRGB_LINEAR](https://developer.android.com/reference/android/hardware/DataSpace#DATASPACE_SCRGB_LINEAR),[DataSpace.DATASPACE_SRGB](https://developer.android.com/reference/android/hardware/DataSpace#DATASPACE_SRGB),[DataSpace.DATASPACE_SCRGB](https://developer.android.com/reference/android/hardware/DataSpace#DATASPACE_SCRGB),[DataSpace.DATASPACE_DISPLAY_P3](https://developer.android.com/reference/android/hardware/DataSpace#DATASPACE_DISPLAY_P3),[DataSpace.DATASPACE_BT2020_HLG](https://developer.android.com/reference/android/hardware/DataSpace#DATASPACE_BT2020_HLG),[DataSpace.DATASPACE_BT2020_PQ](https://developer.android.com/reference/android/hardware/DataSpace#DATASPACE_BT2020_PQ),[DataSpace.DATASPACE_ADOBE_RGB](https://developer.android.com/reference/android/hardware/DataSpace#DATASPACE_ADOBE_RGB),[DataSpace.DATASPACE_JFIF](https://developer.android.com/reference/android/hardware/DataSpace#DATASPACE_JFIF),[DataSpace.DATASPACE_BT601_625](https://developer.android.com/reference/android/hardware/DataSpace#DATASPACE_BT601_625),[DataSpace.DATASPACE_BT601_525](https://developer.android.com/reference/android/hardware/DataSpace#DATASPACE_BT601_525),[DataSpace.DATASPACE_BT2020](https://developer.android.com/reference/android/hardware/DataSpace#DATASPACE_BT2020),[DataSpace.DATASPACE_BT709](https://developer.android.com/reference/android/hardware/DataSpace#DATASPACE_BT709),[DataSpace.DATASPACE_DCI_P3](https://developer.android.com/reference/android/hardware/DataSpace#DATASPACE_DCI_P3), and[DataSpace.DATASPACE_SRGB_LINEAR](https://developer.android.com/reference/android/hardware/DataSpace#DATASPACE_SRGB_LINEAR)
|
| `format` | `int`: Value is[HardwareBuffer.RGBA_8888](https://developer.android.com/reference/android/hardware/HardwareBuffer#RGBA_8888),[HardwareBuffer.RGBA_FP16](https://developer.android.com/reference/android/hardware/HardwareBuffer#RGBA_FP16),[HardwareBuffer.RGBA_1010102](https://developer.android.com/reference/android/hardware/HardwareBuffer#RGBA_1010102),[HardwareBuffer.RGBX_8888](https://developer.android.com/reference/android/hardware/HardwareBuffer#RGBX_8888),[HardwareBuffer.RGB_888](https://developer.android.com/reference/android/hardware/HardwareBuffer#RGB_888),[HardwareBuffer.RGB_565](https://developer.android.com/reference/android/hardware/HardwareBuffer#RGB_565),[HardwareBuffer.BLOB](https://developer.android.com/reference/android/hardware/HardwareBuffer#BLOB),[HardwareBuffer.YCBCR_420_888](https://developer.android.com/reference/android/hardware/HardwareBuffer#YCBCR_420_888),[HardwareBuffer.D_16](https://developer.android.com/reference/android/hardware/HardwareBuffer#D_16),[HardwareBuffer.D_24](https://developer.android.com/reference/android/hardware/HardwareBuffer#D_24),[HardwareBuffer.DS_24UI8](https://developer.android.com/reference/android/hardware/HardwareBuffer#DS_24UI8),[HardwareBuffer.D_FP32](https://developer.android.com/reference/android/hardware/HardwareBuffer#D_FP32),[HardwareBuffer.DS_FP32UI8](https://developer.android.com/reference/android/hardware/HardwareBuffer#DS_FP32UI8),[HardwareBuffer.S_UI8](https://developer.android.com/reference/android/hardware/HardwareBuffer#S_UI8),[HardwareBuffer.YCBCR_P010](https://developer.android.com/reference/android/hardware/HardwareBuffer#YCBCR_P010),[HardwareBuffer.YCBCR_P210](https://developer.android.com/reference/android/hardware/HardwareBuffer#YCBCR_P210),[HardwareBuffer.R_8](https://developer.android.com/reference/android/hardware/HardwareBuffer#R_8),[HardwareBuffer.R_16](https://developer.android.com/reference/android/hardware/HardwareBuffer#R_16),[HardwareBuffer.RG_1616](https://developer.android.com/reference/android/hardware/HardwareBuffer#RG_1616),[HardwareBuffer.RGBA_10101010](https://developer.android.com/reference/android/hardware/HardwareBuffer#RGBA_10101010), android.hardware.HardwareBuffer.R_12, android.hardware.HardwareBuffer.R_14, android.hardware.HardwareBuffer.RG_1212, android.hardware.HardwareBuffer.RG_1414, android.hardware.HardwareBuffer.RGBA_12121212, android.hardware.HardwareBuffer.RGBA_14141414, android.hardware.HardwareBuffer.BGRA_1010102, or android.hardware.HardwareBuffer.BGRX_1010102
|
| Returns ||
|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `boolean` | True if the device can support efficiently compositing the content described by the dataspace and format. False if GPU composition fallback is otherwise required.
|
### isMixedColorSpacesSupported
Added in[API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public boolean isMixedColorSpacesSupported ()
```
Indicates that hardware composition of two or more overlays with different colorspaces is supported on the device.
| Returns ||
|-----------|-------------------------------------------------------------------------------------------------------------------------------|
| `boolean` | True if the device can support mixed colorspaces efficiently, false if GPU composition fallback is otherwise required.
|
### writeToParcel
Added in[API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public void writeToParcel (Parcel dest,
int flags)
```
Flatten this object in to a Parcel.
| Parameters ||
|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `dest` | `Parcel`: This value cannot be`null`.
|
| `flags` | `int`: Additional flags about how the object should be written. May be 0 or[Parcelable.PARCELABLE_WRITE_RETURN_VALUE](https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE). Value is either`0`or a combination of[Parcelable.PARCELABLE_WRITE_RETURN_VALUE](https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE), and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES
|