Added in API level 34

RenderRequest


class RenderRequest
kotlin.Any
   ↳ android.graphics.HardwareBufferRenderer.RenderRequest

Sets the parameters that can be used to control a render request for a HardwareBufferRenderer. This is not thread-safe and must not be held on to for longer than a single request.

Summary

Public methods
Unit

Syncs the RenderNode tree to the render thread and requests content to be drawn.

HardwareBufferRenderer.RenderRequest
setBufferTransform(bufferTransform: Int)

Specifies a transform to be applied before content is rendered.

HardwareBufferRenderer.RenderRequest
setColorSpace(colorSpace: ColorSpace?)

Configures the color space which the content should be rendered in.

Public methods

draw

Added in API level 34
fun draw(
    executor: Executor,
    renderCallback: Consumer<HardwareBufferRenderer.RenderResult!>
): Unit

Syncs the RenderNode tree to the render thread and requests content to be drawn. This RenderRequest instance should no longer be used after calling this method. The system internally may reuse instances of RenderRequest to reduce allocation churn.

Parameters
executor Executor: Executor used to deliver callbacks This value cannot be null.
renderCallback Consumer<HardwareBufferRenderer.RenderResult!>: Callback invoked when rendering is complete. This includes a RenderResult that provides a SyncFence that should be waited upon for completion before consuming the rendered output in the provided HardwareBuffer instance. This value cannot be null.
Exceptions
java.lang.IllegalStateException if attempt to draw is made when HardwareBufferRenderer#isClosed() returns true

setBufferTransform

Added in API level 34
fun setBufferTransform(bufferTransform: Int): HardwareBufferRenderer.RenderRequest

Specifies a transform to be applied before content is rendered. This is useful for pre-rotating content for the current display orientation to increase performance of displaying the associated buffer. This transformation will also adjust the light source position for the specified rotation.

Parameters
bufferTransform Int: Value is android.view.SurfaceControl#BUFFER_TRANSFORM_IDENTITY, android.view.SurfaceControl#BUFFER_TRANSFORM_MIRROR_HORIZONTAL, android.view.SurfaceControl#BUFFER_TRANSFORM_MIRROR_VERTICAL, android.view.SurfaceControl#BUFFER_TRANSFORM_ROTATE_90, android.view.SurfaceControl#BUFFER_TRANSFORM_ROTATE_180, android.view.SurfaceControl#BUFFER_TRANSFORM_ROTATE_270, BUFFER_TRANSFORM_MIRROR_HORIZONTAL | BUFFER_TRANSFORM_ROTATE_90, or BUFFER_TRANSFORM_MIRROR_VERTICAL | BUFFER_TRANSFORM_ROTATE_90
Return
HardwareBufferRenderer.RenderRequest This value cannot be null.

setColorSpace

Added in API level 34
fun setColorSpace(colorSpace: ColorSpace?): HardwareBufferRenderer.RenderRequest

Configures the color space which the content should be rendered in. This affects how the framework will interpret the color at each pixel. The color space provided here must be non-null, RGB based and leverage an ICC parametric curve. The min/max values of the components should not reduce the numerical range compared to the previously assigned color space. If left unspecified, the default color space of SRGB will be used.

Parameters
colorSpace ColorSpace?: The color space the content should be rendered in. If null is provided the default of SRGB will be used.