Class: RenderTarget

RenderTarget

A class that describes what the renderers are rendering to. This can be as simple as a Texture, or as complex as a multi-texture, multi-sampled render target. Support for stencil and depth buffers is also included.

If you need something more complex than a Texture to render to, you should use this class. Under the hood, all textures you render to have a RenderTarget created on their behalf.

Members

colorTextures TextureSource[]

An array of textures that can be written to by the GPU - mostly this has one texture in Pixi, but you could write to multiple if required! (eg deferred lighting)

depth boolean

if true, will ensure a depth buffer is added. For WebGPU, this will automatically create a depthStencilTexture

depthStencilTexture TextureSource

the stencil and depth buffer will right to this texture in WebGPU

stencil boolean

if true, will ensure a stencil buffer is added. For WebGPU, this will automatically create a depthStencilTexture

Methods

ensureDepthStencilTexture ()

This will ensure a depthStencil texture is created for this render target. Most likely called by the mask system to make sure we have stencil buffer added.