PixiJS

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.

new RenderTarget (descriptor)

ts:87
Name Type Attributes Description
descriptor RenderTargetOptions <optional>

Options for creating a render target.

Members

defaultOptions RenderTargetOptions static

The default options for a render target

Properties:
Name Type Default Description
antialias boolean false

should this render target be antialiased?
colorTextures number 1

an array of textures, or a number indicating how many color textures there should be
depth boolean false

should this render target have a depth buffer?
height number 0

the height of the RenderTarget
isRoot boolean false

is this a root element, true if this is gl context owners render target
resolution number 1

the resolution of the RenderTarget
stencil boolean false

should this render target have a stencil buffer?
width number 0

the width of the RenderTarget

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