HardwareBufferRenderer.RenderRequest

Kotlin |Java

public final class HardwareBufferRenderer.RenderRequest
extends Object

java.lang.Object
↳	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
`void`	`draw(Executor executor, Consumer<HardwareBufferRenderer.RenderResult> renderCallback)` Syncs the RenderNode tree to the render thread and requests content to be drawn.
`HardwareBufferRenderer.RenderRequest`	`setBufferTransform(int bufferTransform)` 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.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public methods

draw

Added in API level 34

public void draw (Executor executor, 
                Consumer<HardwareBufferRenderer.RenderResult> renderCallback)

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`: 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`.

Throws
`IllegalStateException`	if attempt to draw is made when `HardwareBufferRenderer.isClosed()` returns true

setBufferTransform

Added in API level 34

public HardwareBufferRenderer.RenderRequest setBufferTransform (int bufferTransform)

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

Parameters
`bufferTransform`	`int`: Value is one of the following: `SurfaceControl.BUFFER_TRANSFORM_IDENTITY` `SurfaceControl.BUFFER_TRANSFORM_MIRROR_HORIZONTAL` `SurfaceControl.BUFFER_TRANSFORM_MIRROR_VERTICAL` `SurfaceControl.BUFFER_TRANSFORM_ROTATE_90` `SurfaceControl.BUFFER_TRANSFORM_ROTATE_180` `SurfaceControl.BUFFER_TRANSFORM_ROTATE_270` `SurfaceControl.BUFFER_TRANSFORM_MIRROR_HORIZONTAL_ROTATE_90` `SurfaceControl.BUFFER_TRANSFORM_MIRROR_VERTICAL_ROTATE_90`

bufferTransform

int: Value is one of the following:

Returns
`HardwareBufferRenderer.RenderRequest`	This value cannot be `null`.

See also:

SurfaceControl.Transaction.setBufferTransform(SurfaceControl, int)

setColorSpace

Added in API level 34

public HardwareBufferRenderer.RenderRequest setColorSpace (ColorSpace colorSpace)

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.

Returns
`HardwareBufferRenderer.RenderRequest`