filament/io.github.erkko68.filament/RenderTarget

RenderTarget

class RenderTarget(nativeHandle: NativePointer, textures: Array<Texture?>)

An offscreen render target that can be associated with a View and contains weak references to a set of attached Texture objects.

RenderTarget is intended to be used with the View's post-processing disabled for the most part, especially when a DEPTH attachment is also used. Custom RenderTargets are ultimately intended to render into textures that might be used during the main render pass.

Clients are responsible for the lifetime of all associated Texture attachments.

See also

Constructors

constructor(nativeHandle: NativePointer, textures: Array<Texture?>)

Types

AttachmentPoint

enum AttachmentPoint : Enum<RenderTarget.AttachmentPoint>

Attachment point identifiers for texture attachments in a render target.

Builder for creating RenderTarget instances.

Properties

val nativeObject: NativePointer

The native object, for interop with code calling the Fila* C API directly. Read-only: this wrapper owns it.

supportedColorAttachmentsCount

val supportedColorAttachmentsCount: Int

The number of color attachments usable by this instance of RenderTarget (at least 4).

Functions

fun getFace(attachment: RenderTarget.AttachmentPoint): Texture.CubemapFace

Gets the cubemap face for a given attachment point.

fun getLayer(attachment: RenderTarget.AttachmentPoint): Int

Gets the layer index for a given attachment point.

fun getMipLevel(attachment: RenderTarget.AttachmentPoint): Int

Gets the mipmap level for a given attachment point.

fun getTexture(attachment: RenderTarget.AttachmentPoint): Texture?

Gets the texture attached to a given attachment point.