Pixi’VNClass: RenderTarget
Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/renderTarget/RenderTarget.d.ts:38
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.
Advanced
Constructors
Constructor
> new RenderTarget(descriptor?): RenderTarget
Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/renderTarget/RenderTarget.d.ts:62
Parameters
descriptor?
Options for creating a render target.
Returns
RenderTarget
Properties
colorTextures
> colorTextures: TextureSource<any>[]
Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/renderTarget/RenderTarget.d.ts:47
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
> depth: boolean
Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/renderTarget/RenderTarget.d.ts:53
if true, will ensure a depth buffer is added. For WebGPU, this will automatically create a depthStencilTexture
depthStencilTexture
> depthStencilTexture: TextureSource
Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/renderTarget/RenderTarget.d.ts:49
the stencil and depth buffer will right to this texture in WebGPU
dirtyId
> dirtyId: number
Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/renderTarget/RenderTarget.d.ts:54
isRoot
> isRoot: boolean
Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/renderTarget/RenderTarget.d.ts:55
stencil
> stencil: boolean
Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/renderTarget/RenderTarget.d.ts:51
if true, will ensure a stencil buffer is added. For WebGPU, this will automatically create a depthStencilTexture
uid
> readonly uid: number
Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/renderTarget/RenderTarget.d.ts:42
unique id for this render target
defaultOptions
> static defaultOptions: RenderTargetOptions
Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/renderTarget/RenderTarget.d.ts:40
The default options for a render target
Accessors
colorTexture
Get Signature
> get colorTexture(): TextureSource
Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/renderTarget/RenderTarget.d.ts:69
Returns
height
Get Signature
> get height(): number
Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/renderTarget/RenderTarget.d.ts:65
Returns
number
pixelHeight
Get Signature
> get pixelHeight(): number
Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/renderTarget/RenderTarget.d.ts:67
Returns
number
pixelWidth
Get Signature
> get pixelWidth(): number
Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/renderTarget/RenderTarget.d.ts:66
Returns
number
resolution
Get Signature
> get resolution(): number
Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/renderTarget/RenderTarget.d.ts:68
Returns
number
size
Get Signature
> get size(): [number, number]
Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/renderTarget/RenderTarget.d.ts:63
Returns
[number, number]
width
Get Signature
> get width(): number
Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/renderTarget/RenderTarget.d.ts:64
Returns
number
Methods
destroy()
> destroy(): void
Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/renderTarget/RenderTarget.d.ts:78
Returns
void
ensureDepthStencilTexture()
> ensureDepthStencilTexture(): void
Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/renderTarget/RenderTarget.d.ts:76
Internal
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.
Returns
void
onSourceResize()
> protected onSourceResize(source): void
Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/renderTarget/RenderTarget.d.ts:70
Parameters
source
Returns
void
resize()
> resize(width, height, resolution?, skipColorTexture?): void
Defined in: node_modules/pixi.js/lib/rendering/renderers/shared/renderTarget/RenderTarget.d.ts:77
Parameters
width
number
height
number
resolution?
number
skipColorTexture?
boolean
Returns
void