SurfaceControlCompat.Transaction

Transaction()

@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.

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.

open fun close(): Unit

Release the native transaction object, without committing it.

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.

@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()

@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.

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.

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.

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.

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

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

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.

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.

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.

@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.

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.

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.

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.

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

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

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.

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

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