SurfaceControl

Kotlin |Java

class SurfaceControl : Parcelable

kotlin.Any
↳	android.view.SurfaceControl

Handle to an on-screen Surface managed by the system compositor. The SurfaceControl is a combination of a buffer source, and metadata about how to display the buffers. By constructing a Surface from this SurfaceControl you can submit buffers to be composited. Using SurfaceControl.Transaction you can manipulate various properties of how the buffer will be displayed on-screen. SurfaceControl's are arranged into a scene-graph like hierarchy, and as such any SurfaceControl may have a parent. Geometric properties like transform, crop, and Z-ordering will be inherited from the parent, as if the child were content in the parents buffer stream.

Summary

Nested classes
	`Builder` Builder class for `SurfaceControl` objects.
	`JankData` Jank information to be fed back via `OnJankDataListener`.
abstract	`OnJankDataListener` Listener interface to be informed about SurfaceFlinger's jank classification for a specific surface.
	`OnJankDataListenerRegistration` Handle to a registered OnJankDatalistener.
	`Transaction` An atomic set of changes to a set of SurfaceControl.
abstract	`TransactionCommittedListener` Interface to handle request to `SurfaceControl.Transaction.addTransactionCommittedListener(Executor,TransactionCommittedListener)`
	`TransactionStats` Transaction stats given to the listener registered in `SurfaceControl.Transaction.addTransactionCompletedListener`
	`TrustedPresentationThresholds` Threshold values that are sent with `Transaction.setTrustedPresentationCallback(SurfaceControl,TrustedPresentationThresholds,Executor,Consumer)`

Constants
static Int	`BUFFER_TRANSFORM_IDENTITY` Identity transform.
static Int	`BUFFER_TRANSFORM_MIRROR_HORIZONTAL` Mirror horizontally.
static Int	`BUFFER_TRANSFORM_MIRROR_HORIZONTAL_ROTATE_90` Mirror horizontally and rotate 90 degrees clock-wise.
static Int	`BUFFER_TRANSFORM_MIRROR_VERTICAL` Mirror vertically.
static Int	`BUFFER_TRANSFORM_MIRROR_VERTICAL_ROTATE_90` Mirror vertically and rotate 90 degrees clock-wise.
static Int	`BUFFER_TRANSFORM_ROTATE_180` Rotate 180 degrees clock-wise.
static Int	`BUFFER_TRANSFORM_ROTATE_270` Rotate 270 degrees clock-wise.
static Int	`BUFFER_TRANSFORM_ROTATE_90` Rotate 90 degrees clock-wise.

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.
Boolean	`isValid()` Check whether this instance points to a valid layer with the system-compositor.
Unit	`readFromParcel(in: Parcel!)`
SurfaceControl.OnJankDataListenerRegistration	`registerOnJankDataListener(executor: Executor, listener: SurfaceControl.OnJankDataListener)` Registers a `SurfaceControl.OnJankDataListener` to receive jank classification data about rendered frames.
Unit	`release()` Release the local reference to the server-side surface.
String	`toString()` Returns a string representation of the object.
Unit	`writeToParcel(dest: Parcel, flags: Int)` Flatten this object in to a Parcel.

Protected methods
Unit	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

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

Constants

BUFFER_TRANSFORM_IDENTITY

Added in API level 32

static val BUFFER_TRANSFORM_IDENTITY: Int

Identity transform. These transforms that can be applied to buffers as they are displayed to a window.

Value: 0

See Also

android.hardware.HardwareBuffer

BUFFER_TRANSFORM_MIRROR_HORIZONTAL

Added in API level 32

static val BUFFER_TRANSFORM_MIRROR_HORIZONTAL: Int

Mirror horizontally. Can be combined with BUFFER_TRANSFORM_MIRROR_VERTICAL and BUFFER_TRANSFORM_ROTATE_90.

Value: 1

BUFFER_TRANSFORM_MIRROR_HORIZONTAL_ROTATE_90

Added in API level 37

static val BUFFER_TRANSFORM_MIRROR_HORIZONTAL_ROTATE_90: Int

Mirror horizontally and rotate 90 degrees clock-wise. Equivalent to (BUFFER_TRANSFORM_MIRROR_HORIZONTAL | BUFFER_TRANSFORM_ROTATE_90).

Value: 5

BUFFER_TRANSFORM_MIRROR_VERTICAL

Added in API level 32

static val BUFFER_TRANSFORM_MIRROR_VERTICAL: Int

Mirror vertically. Can be combined with BUFFER_TRANSFORM_MIRROR_HORIZONTAL and BUFFER_TRANSFORM_ROTATE_90.

Value: 2

BUFFER_TRANSFORM_MIRROR_VERTICAL_ROTATE_90

Added in API level 37

static val BUFFER_TRANSFORM_MIRROR_VERTICAL_ROTATE_90: Int

Mirror vertically and rotate 90 degrees clock-wise. Equivalent to (BUFFER_TRANSFORM_MIRROR_VERTICAL | BUFFER_TRANSFORM_ROTATE_90).

Value: 6

BUFFER_TRANSFORM_ROTATE_180

Added in API level 32

static val BUFFER_TRANSFORM_ROTATE_180: Int

Rotate 180 degrees clock-wise. Cannot be combined with other transforms. Equivalent to (BUFFER_TRANSFORM_MIRROR_HORIZONTAL | BUFFER_TRANSFORM_MIRROR_VERTICAL).

Value: 3

BUFFER_TRANSFORM_ROTATE_270

Added in API level 32

static val BUFFER_TRANSFORM_ROTATE_270: Int

Rotate 270 degrees clock-wise. Cannot be combined with other transforms. Equivalent to (BUFFER_TRANSFORM_ROTATE_180 | BUFFER_TRANSFORM_ROTATE_90).

Value: 7

BUFFER_TRANSFORM_ROTATE_90

Added in API level 32

static val BUFFER_TRANSFORM_ROTATE_90: Int

Rotate 90 degrees clock-wise. Can be combined with BUFFER_TRANSFORM_MIRROR_HORIZONTAL and BUFFER_TRANSFORM_MIRROR_VERTICAL.

Value: 4

Public methods

describeContents

Added in API level 29

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`

isValid

Added in API level 29

fun isValid(): Boolean

Check whether this instance points to a valid layer with the system-compositor. For example this may be false if construction failed, or the layer was released (release).

Return
`Boolean`	Whether this SurfaceControl is valid.

readFromParcel

Added in API level 29

fun readFromParcel(in: Parcel!): Unit

registerOnJankDataListener

Added in API level 10000

fun registerOnJankDataListener(
    executor: Executor, 
    listener: SurfaceControl.OnJankDataListener
): SurfaceControl.OnJankDataListenerRegistration

Registers a SurfaceControl.OnJankDataListener to receive jank classification data about rendered frames.

Use SurfaceControl.OnJankDataListenerRegistration.removeAfter to unregister the listener.

Parameters
`executor`	Executor: The executor on which the listener will be invoked. This value cannot be `null`. Callback and listener events are dispatched through this `Executor`, providing an easy way to control which thread is used. To dispatch events through the main thread of your application, you can use `Context.getMainExecutor()`. Otherwise, provide an `Executor` that dispatches to an appropriate thread.
`listener`	SurfaceControl.OnJankDataListener: The listener to add. This value cannot be `null`.

Return
`SurfaceControl.OnJankDataListenerRegistration`	The `SurfaceControl.OnJankDataListenerRegistration` for the listener. This value cannot be `null`.

release

Added in API level 29

fun release(): Unit

Release the local reference to the server-side surface. The surface may continue to exist on-screen as long as its parent continues to exist. To explicitly remove a surface from the screen use Transaction.reparent with a null-parent. After release, isValid will return false and other methods will throw an exception. Always call release() when you're done with a SurfaceControl.

toString

Added in API level 29

fun toString(): String

Returns a string representation of the object.

Return
`String`	a string representation of the object.

writeToParcel

Added in API level 29

fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

Flatten this object in to a Parcel.

Parameters
`dest`	Parcel: The Parcel in which the object should be written. This value cannot be `null`.
`flags`	Int: Additional flags about how the object should be written. May be 0 or `PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of the following: `PARCELABLE_WRITE_RETURN_VALUE`

Protected methods

finalize

Added in API level 29

protected fun finalize(): Unit

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. A subclass overrides the finalize method to dispose of system resources or to perform other cleanup.

The general contract of finalize is that it is invoked if and when the Java virtual machine has determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, except as a result of an action taken by the finalization of some other object or class which is ready to be finalized. The finalize method may take any action, including making this object available again to other threads; the usual purpose of finalize, however, is to perform cleanup actions before the object is irrevocably discarded. For example, the finalize method for an object that represents an input/output connection might perform explicit I/O transactions to break the connection before the object is permanently discarded.

The finalize method of class Object performs no special action; it simply returns normally. Subclasses of Object may override this definition.

The Java programming language does not guarantee which thread will invoke the finalize method for any given object. It is guaranteed, however, that the thread that invokes finalize will not be holding any user-visible synchronization locks when finalize is invoked. If an uncaught exception is thrown by the finalize method, the exception is ignored and finalization of that object terminates.

After the finalize method has been invoked for an object, no further action is taken until the Java virtual machine has again determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, including possible actions by other objects or classes which are ready to be finalized, at which point the object may be discarded.

The finalize method is never invoked more than once by a Java virtual machine for any given object.

Any exception thrown by the finalize method causes the finalization of this object to be halted, but is otherwise ignored.

Exceptions
`java.lang.Throwable`	the `Exception` raised by this method

Properties

CREATOR

Added in API level 29

static val CREATOR: Parcelable.Creator<SurfaceControl!>