SurfaceControlCompat.Transaction


@RequiresApi(value = 29)
class SurfaceControlCompat.Transaction : AutoCloseable


An atomic set of changes to a set of SurfaceControlCompat.

Summary

Public constructors

Public functions

SurfaceControlCompat.Transaction

Request to add a SurfaceControlCompat.TransactionCommittedListener.

SurfaceControlCompat.Transaction

Clears the frame rate which was set for the surface SurfaceControl.

open Unit

Release the native transaction object, without committing it.

Unit

Commit the transaction, clearing it's state, and making it usable as a new transaction.

Unit
@RequiresApi(value = 33)
commitTransactionOnDraw(attachedSurfaceControl: AttachedSurfaceControl)

Consume the passed in transaction, and request the View hierarchy to apply it atomically with the next draw.

SurfaceControlCompat.Transaction
@RequiresApi(value = 33)
reparent(
    surfaceControl: SurfaceControlCompat,
    attachedSurfaceControl: AttachedSurfaceControl
)

Re-parents a given SurfaceControlCompat to be a child of the AttachedSurfaceControl.

SurfaceControlCompat.Transaction
reparent(
    surfaceControl: SurfaceControlCompat,
    newParent: SurfaceControlCompat?
)

Re-parents a given SurfaceControlCompat to a new parent.

SurfaceControlCompat.Transaction
setAlpha(surfaceControl: SurfaceControlCompat, alpha: Float)

Set the alpha for a given surface.

SurfaceControlCompat.Transaction
setBuffer(
    surfaceControl: SurfaceControlCompat,
    buffer: HardwareBuffer?,
    fence: SyncFenceCompat?,
    releaseCallback: ((SyncFenceCompat) -> Unit)?
)

Updates the HardwareBuffer displayed for the SurfaceControlCompat.

SurfaceControlCompat.Transaction
setBufferTransform(
    surfaceControl: SurfaceControlCompat,
    transformation: Int
)

Sets the buffer transform that should be applied to the current buffer

SurfaceControlCompat.Transaction
setCrop(surfaceControl: SurfaceControlCompat, crop: Rect?)

Bounds the surface and its children to the bounds specified.

SurfaceControlCompat.Transaction
setDamageRegion(surfaceControl: SurfaceControlCompat, region: Region?)

Updates the region for the content on this surface updated in this transaction.

SurfaceControlCompat.Transaction
setDataSpace(surfaceControl: SurfaceControlCompat, dataSpace: Int)

Set the DataSpace for the SurfaceControl.

SurfaceControlCompat.Transaction
@RequiresApi(value = 34)
setExtendedRangeBrightness(
    surfaceControl: SurfaceControlCompat,
    currentBufferRatio: @FloatRange(from = 1.0, fromInclusive = true) Float,
    desiredRatio: @FloatRange(from = 1.0, fromInclusive = true) Float
)

Sets the desired extended range brightness for the layer.

SurfaceControlCompat.Transaction
setFrameRate(
    surfaceControl: SurfaceControlCompat,
    frameRate: Float,
    compatibility: Int,
    changeFrameRateStrategy: Int
)

Sets the intended frame rate for SurfaceControlCompat.

SurfaceControlCompat.Transaction
setLayer(surfaceControl: SurfaceControlCompat, z: Int)

Set the Z-order for a given SurfaceControlCompat, relative to it's siblings.

SurfaceControlCompat.Transaction
setOpaque(surfaceControl: SurfaceControlCompat, isOpaque: Boolean)

Indicates whether the surface must be considered opaque, even if its pixel format is set to translucent.

SurfaceControlCompat.Transaction
setPosition(surfaceControl: SurfaceControlCompat, x: Float, y: Float)

Sets the SurfaceControl to the specified position relative to the parent SurfaceControl

SurfaceControlCompat.Transaction
setScale(
    surfaceControl: SurfaceControlCompat,
    scaleX: Float,
    scaleY: Float
)

Sets the SurfaceControl to the specified scale with (0, 0) as the center point of the scale.

SurfaceControlCompat.Transaction
setVisibility(surfaceControl: SurfaceControlCompat, visible: Boolean)

Sets the visibility of a given Layer and it's sub-tree.

Public constructors

Transaction

Added in 1.0.2
Transaction()

Public functions

addTransactionCommittedListener

Added in 1.0.2
@RequiresApi(value = 31)
fun addTransactionCommittedListener(
    executor: Executor,
    listener: SurfaceControlCompat.TransactionCommittedListener
): SurfaceControlCompat.Transaction

Request to add a SurfaceControlCompat.TransactionCommittedListener. The callback is invoked when transaction is applied and the updates are ready to be presented. Once applied, any callbacks added before the commit will be cleared from the Transaction. This callback does not mean buffers have been released! It simply means that any new transactions applied will not overwrite the transaction for which we are receiving a callback and instead will be included in the next frame. If you are trying to avoid dropping frames (overwriting transactions), and unable to use timestamps (Which provide a more efficient solution), then this method provides a method to pace your transaction application.

Parameters
executor: Executor

Executor to provide the thread the callback is invoked on.

listener: SurfaceControlCompat.TransactionCommittedListener

TransactionCommittedListener instance that is invoked when the transaction has been committed.

clearFrameRate

Added in 1.0.2
fun clearFrameRate(surfaceControl: SurfaceControlCompat): SurfaceControlCompat.Transaction

Clears the frame rate which was set for the surface SurfaceControl.

This is equivalent to calling setFrameRate with 0 for the framerate and FRAME_RATE_COMPATIBILITY_DEFAULT

Note that this only has an effect for surfaces presented on the display. If this surface is consumed by something other than the system compositor, e.g. a media codec, this call has no effect.

This is only supported on Android R and above. This is ignored on older Android versions.

Parameters
surfaceControl: SurfaceControlCompat

SurfaceControlCompat to clear the frame rate

close

Added in 1.0.2
open fun close(): Unit

Release the native transaction object, without committing it.

commit

Added in 1.0.2
fun commit(): Unit

Commit the transaction, clearing it's state, and making it usable as a new transaction. This will not release any resources and SurfaceControlCompat.Transaction.close must be called to release the transaction.

commitTransactionOnDraw

Added in 1.0.2
@RequiresApi(value = 33)
fun commitTransactionOnDraw(attachedSurfaceControl: AttachedSurfaceControl): Unit

Consume the passed in transaction, and request the View hierarchy to apply it atomically with the next draw. This transaction will be merged with the buffer transaction from the ViewRoot and they will show up on-screen atomically synced. This will not cause a draw to be scheduled, and if there are no other changes to the View hierarchy you may need to call View.invalidate()

Parameters
attachedSurfaceControl: AttachedSurfaceControl

AttachedSurfaceControl associated with the ViewRoot that will apply the provided transaction on the next draw pass

reparent

Added in 1.0.2
@RequiresApi(value = 33)
fun reparent(
    surfaceControl: SurfaceControlCompat,
    attachedSurfaceControl: AttachedSurfaceControl
): SurfaceControlCompat.Transaction

Re-parents a given SurfaceControlCompat to be a child of the AttachedSurfaceControl. Children inherit transform (position, scaling) crop, visibility, and Z-ordering from their parents, as if the children were pixels within the parent Surface.

Parameters
surfaceControl: SurfaceControlCompat

Target SurfaceControlCompat instance to reparent

attachedSurfaceControl: AttachedSurfaceControl

AttachedSurfaceControl instance that acts as the new parent of the provided SurfaceControlCompat instance.

reparent

Added in 1.0.2
fun reparent(
    surfaceControl: SurfaceControlCompat,
    newParent: SurfaceControlCompat?
): SurfaceControlCompat.Transaction

Re-parents a given SurfaceControlCompat to a new parent. Children inherit transform (position, scaling) crop, visibility, and Z-ordering from their parents, as if the children were pixels within the parent Surface.

Parameters
surfaceControl: SurfaceControlCompat

Target SurfaceControlCompat instance to reparent

newParent: SurfaceControlCompat?

Parent SurfaceControlCompat that the target SurfaceControlCompat instance is added to. This can be null indicating that the target SurfaceControlCompat should be removed from the scene.

setAlpha

Added in 1.0.2
fun setAlpha(surfaceControl: SurfaceControlCompat, alpha: Float): SurfaceControlCompat.Transaction

Set the alpha for a given surface. If the alpha is non-zero the SurfaceControl will be blended with the Surfaces under it according to the specified ratio.

Parameters
surfaceControl: SurfaceControlCompat

Target SurfaceControlCompat to set the alpha of.

alpha: Float

The alpha to set. Value is between 0.0 and 1.0 inclusive.

setBuffer

Added in 1.0.2
fun setBuffer(
    surfaceControl: SurfaceControlCompat,
    buffer: HardwareBuffer?,
    fence: SyncFenceCompat? = null,
    releaseCallback: ((SyncFenceCompat) -> Unit)? = null
): SurfaceControlCompat.Transaction

Updates the HardwareBuffer displayed for the SurfaceControlCompat. Note that the buffer must be allocated with HardwareBuffer.USAGE_COMPOSER_OVERLAY as well as HardwareBuffer.USAGE_GPU_SAMPLED_IMAGE as the surface control might be composited using either an overlay or using the GPU. A presentation fence may be passed to improve performance by allowing the buffer to complete rendering while it is waiting for the transaction to be applied. For example, if the buffer is being produced by rendering with OpenGL ES then a fence created with the eglDupNativeFenceFDANDROID EGL extension API can be used to allow the GPU rendering to be concurrent with the transaction. The compositor will wait for the fence to be signaled before the buffer is displayed. If multiple buffers are set as part of the same transaction, the presentation fences of all of them must signal before any buffer is displayed. That is, the entire transaction is delayed until all presentation fences have signaled, ensuring the transaction remains consistent.

Parameters
surfaceControl: SurfaceControlCompat

Target SurfaceControlCompat to configure the provided buffer.

buffer: HardwareBuffer?

HardwareBuffer instance to be rendered by the SurfaceControlCompat instance. Use null to remove the current buffer that was previously configured on this SurfaceControlCompat instance.

fence: SyncFenceCompat? = null

Optional SyncFenceCompat that serves as the presentation fence. If set, the SurfaceControlCompat.Transaction will not apply until the fence signals.

releaseCallback: ((SyncFenceCompat) -> Unit)? = null

Optional callback invoked when the buffer is ready for re-use after being presented to the display. This also includes a SyncFenceCompat instance that consumers must wait on before consuming the buffer

setCrop

Added in 1.0.2
fun setCrop(surfaceControl: SurfaceControlCompat, crop: Rect?): SurfaceControlCompat.Transaction

Bounds the surface and its children to the bounds specified. Size of the surface will be ignored and only the crop and buffer size will be used to determine the bounds of the surface. If no crop is specified and the surface has no buffer, the surface bounds is only constrained by the size of its parent bounds.

Parameters
surfaceControl: SurfaceControlCompat

The SurfaceControlCompat to apply the crop to. This value cannot be null.

crop: Rect?

Bounds of the crop to apply. This value can be null.

Throws
kotlin.IllegalArgumentException

if crop is not a valid rectangle.

setDamageRegion

Added in 1.0.2
fun setDamageRegion(surfaceControl: SurfaceControlCompat, region: Region?): SurfaceControlCompat.Transaction

Updates the region for the content on this surface updated in this transaction. The damage region is the area of the buffer that has changed since the previously sent buffer. This can be used to reduce the amount of recomposition that needs to happen when only a small region of the buffer is being updated, such as for a small blinking cursor or a loading indicator.

Parameters
surfaceControl: SurfaceControlCompat

Target SurfaceControlCompat to set damage region of.

region: Region?

The region to be set. If null, the entire buffer is assumed dirty. This is equivalent to not setting a damage region at all.

setDataSpace

Added in 1.0.2
fun setDataSpace(surfaceControl: SurfaceControlCompat, dataSpace: Int): SurfaceControlCompat.Transaction

Set the DataSpace for the SurfaceControl. This will control how the buffer set with setBuffer is displayed.

NOTE it is strongly recommended to verify that the display supports the corresponding DataSpace in advance before configuring the data space. For example, if DataSpace.DATASPACE_DISPLAY_P3 is desired, consumers should verify that Window.isWideGamut returns true before proceeding.

Parameters
surfaceControl: SurfaceControlCompat

The SurfaceControl to update

dataSpace: Int

The DataSpace to set it to. Must be one of named android.hardware.DataSpace types.

See also
setDataSpace

setExtendedRangeBrightness

Added in 1.0.2
@RequiresApi(value = 34)
fun setExtendedRangeBrightness(
    surfaceControl: SurfaceControlCompat,
    currentBufferRatio: @FloatRange(from = 1.0, fromInclusive = true) Float,
    desiredRatio: @FloatRange(from = 1.0, fromInclusive = true) Float
): SurfaceControlCompat.Transaction

Sets the desired extended range brightness for the layer. This only applies for layers that are displaying HardwareBuffer instances with a DataSpace of DataSpace.RANGE_EXTENDED.

Parameters
surfaceControl: SurfaceControlCompat

The layer whose extended range brightness is being specified

currentBufferRatio: @FloatRange(from = 1.0, fromInclusive = true) Float

The current hdr/sdr ratio of the current buffer. For example if the buffer was rendered with a target SDR whitepoint of 100 nits and a max display brightness of 200 nits, this should be set to 2.0f.

Default value is 1.0f.

Transfer functions that encode their own brightness ranges, such as HLG or PQ, should also set this to 1.0f and instead communicate extended content brightness information via metadata such as CTA861_3 or SMPTE2086.

Must be finite &&>= 1.0f

desiredRatio: @FloatRange(from = 1.0, fromInclusive = true) Float

The desired hdr/sdr ratio. This can be used to communicate the max desired brightness range. This is similar to the "max luminance" value in other HDR metadata formats, but represented as a ratio of the target SDR whitepoint to the max display brightness. The system may not be able to, or may choose not to, deliver the requested range.

While requesting a large desired ratio will result in the most dynamic range, voluntarily reducing the requested range can help improve battery life as well as can improve quality by ensuring greater bit depth is allocated to the luminance range in use.

Default value is 1.0f and indicates that extended range brightness is not being used, so the resulting SDR or HDR behavior will be determined entirely by the dataspace being used (ie, typically SDR however PQ or HLG transfer functions will still result in HDR)

Must be finite &&>= 1.0f

setFrameRate

Added in 1.0.2
fun setFrameRate(
    surfaceControl: SurfaceControlCompat,
    frameRate: Float,
    compatibility: Int,
    changeFrameRateStrategy: Int
): SurfaceControlCompat.Transaction

Sets the intended frame rate for SurfaceControlCompat.

On devices that are capable of running the display at different refresh rates, the system may choose a display refresh rate to better match this surface's frame rate. Usage of this API won't directly affect the application's frame production pipeline. However, because the system may change the display refresh rate, calls to this function may result in changes to Choreographer callback timings, and changes to the time interval at which the system releases buffers back to the application.

This method is only supported on Android R+ and is ignored on older platform versions.

Parameters
surfaceControl: SurfaceControlCompat

The target SurfaceControlCompat that will have it's frame rate changed

frameRate: Float

The intended frame rate of this surface, in frames per second. 0 is a special value that indicates the app will accept the system's choice for the display frame rate, which is the default behavior if this function isn't called. Must be greater than or equal to 0. The frameRate param does not need to be a valid refresh rate for this device's display

  • e.g., it's fine to pass 30fps to a device that can only run the display at 60fps.

compatibility: Int

The frame rate compatibility of this surface. The compatibility value may influence the system's choice of display frame rate. This must be either FRAME_RATE_COMPATIBILITY_DEFAULT or FRAME_RATE_COMPATIBILITY_FIXED_SOURCE This parameter is ignored when frameRate is 0.

changeFrameRateStrategy: Int

Whether display refresh rate transitions should be seamless. A seamless transition does not have any visual interruptions, such as a black screen for a second or two. Must be either CHANGE_FRAME_RATE_ALWAYS or CHANGE_FRAME_RATE_ONLY_IF_SEAMLESS. This parameter is only supported on Android S and when frameRate is not 0. This is ignored on older Android versions and when frameRate is 0.

setLayer

Added in 1.0.2
fun setLayer(surfaceControl: SurfaceControlCompat, z: Int): SurfaceControlCompat.Transaction

Set the Z-order for a given SurfaceControlCompat, relative to it's siblings. If two siblings share the same Z order the ordering is undefined. Surfaces with a negative Z will be placed below the parent Surface.

setOpaque

Added in 1.0.2
fun setOpaque(surfaceControl: SurfaceControlCompat, isOpaque: Boolean): SurfaceControlCompat.Transaction

Indicates whether the surface must be considered opaque, even if its pixel format is set to translucent. This can be useful if an application needs full RGBA 8888 support for instance but will still draw every pixel opaque. This flag only determines whether opacity will be sampled from the alpha channel. Plane-alpha from calls to setAlpha() can still result in blended composition regardless of the opaque setting. Combined effects are (assuming a buffer format with an alpha channel):

OPAQUE + alpha(1.0) == opaque composition OPAQUE + alpha(0.x) == blended composition OPAQUE + alpha(0.0) == no composition !OPAQUE + alpha(1.0) == blended composition !OPAQUE + alpha(0.x) == blended composition !OPAQUE + alpha(0.0) == no composition If the underlying buffer lacks an alpha channel, it is as if setOpaque(true) were set automatically.

Parameters
surfaceControl: SurfaceControlCompat

Target SurfaceControlCompat to change the opaque flag for

isOpaque: Boolean

Flag indicating if the SurfaceControlCompat should be fully opaque or transparent

setPosition

Added in 1.0.2
fun setPosition(surfaceControl: SurfaceControlCompat, x: Float, y: Float): SurfaceControlCompat.Transaction

Sets the SurfaceControl to the specified position relative to the parent SurfaceControl

Parameters
surfaceControl: SurfaceControlCompat

The SurfaceControlCompat to change position. This value cannot be null

x: Float

the X position

y: Float

the Y position

setScale

Added in 1.0.2
fun setScale(
    surfaceControl: SurfaceControlCompat,
    scaleX: Float,
    scaleY: Float
): SurfaceControlCompat.Transaction

Sets the SurfaceControl to the specified scale with (0, 0) as the center point of the scale.

Parameters
surfaceControl: SurfaceControlCompat

The SurfaceControlCompat to change scale. This value cannot be null.

scaleX: Float

the X scale

scaleY: Float

the Y scale

setVisibility

Added in 1.0.2
fun setVisibility(surfaceControl: SurfaceControlCompat, visible: Boolean): SurfaceControlCompat.Transaction

Sets the visibility of a given Layer and it's sub-tree.

Parameters
surfaceControl: SurfaceControlCompat

Target SurfaceControlCompat to change the visibility

visible: Boolean

true to indicate the SurfaceControlCompat should be visible, false otherwise