OverlayProperties | API reference

class OverlayProperties : Parcelable

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 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 android.view.SurfaceControl tree is power-efficient and performant.

Summary

Inherited constants

From class Parcelable

`Int`	`CONTENTS_FILE_DESCRIPTOR` Descriptor bit used with `describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`Int`	`PARCELABLE_WRITE_RETURN_VALUE` Flag for use with `writeToParcel`: 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)`". Some implementations may want to release resources at this point.

Public methods
Int	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
Array<LutProperties!>?	`getLutProperties()` Returns the lut properties of the device.
Boolean	`isCombinationSupported(dataspace: Int, format: Int)` Indicates that hardware composition of a buffer encoded with the provided `DataSpace` and android.
Boolean	`isMixedColorSpacesSupported()` Indicates that hardware composition of two or more overlays with different colorspaces is supported on the device.
Unit	`writeToParcel(dest: Parcel, flags: Int)` Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<OverlayProperties!>	`CREATOR`

Public methods

describeContents

fun describeContents(): Int

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(Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Return
`Int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `CONTENTS_FILE_DESCRIPTOR`

isMixedColorSpacesSupported

fun isMixedColorSpacesSupported(): Boolean

Indicates that hardware composition of two or more overlays with different colorspaces is supported on the device.

Return
`Boolean`	True if the device can support mixed colorspaces efficiently, false if GPU composition fallback is otherwise required.

Properties

Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.