RenderTargetWrapper | Babylon.js API documentation

Class RenderTargetWrapper

Wrapper around a render target (either single or multi textures)

Hierarchy (View Summary)

RenderTargetWrapper
- WebGPURenderTargetWrapper
- NativeRenderTargetWrapper

Constructors

constructor

new RenderTargetWrapper(
    isMulti: boolean,
    isCube: boolean,
    size: TextureSize,
    engine: AbstractEngine,
    label?: string,
): RenderTargetWrapper
Initializes the render target wrapper
Parameters
- isMulti: boolean
  true if the wrapper is a multi render target
- isCube: boolean
  true if the wrapper should render to a cube texture
- size: TextureSize
  size of the render target (width/height/layers)
- engine: AbstractEngine
  engine used to create the render target
- Optionallabel: string
  defines the label to use for the wrapper (for debugging purpose only)
Returns RenderTargetWrapper
- Defined in .temp/typedoc/docdirectory/doc.d.ts:113059

Properties

disableAutomaticMSAAResolve

disableAutomaticMSAAResolve: boolean

Sets this property to true to disable the automatic MSAA resolve that happens when the render target wrapper is unbound (default is false)

`Optional`label

label?: string

Gets or sets the label of the render target wrapper (optional, for debugging purpose)

resolveMSAAColors

resolveMSAAColors: boolean

Indicates if MSAA color texture(s) should be resolved when a resolve occur (either automatically by the engine or manually by the user) (default is true) Note that you can trigger a MSAA resolve at any time by calling resolveMSAATextures()

resolveMSAADepth

resolveMSAADepth: boolean

Indicates if MSAA depth texture should be resolved when a resolve occur (either automatically by the engine or manually by the user) (default is false)

resolveMSAAStencil

resolveMSAAStencil: boolean

Indicates if MSAA stencil texture should be resolved when a resolve occur (either automatically by the engine or manually by the user) (default is false)

Accessors

depth

get depth(): number
Gets the depth of the render target wrapper (only used if is3D is true and wrapper is not a multi render target)

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112989

depthStencilTexture

get depthStencilTexture(): Nullable<InternalTexture>
Gets the depth/stencil texture

Returns Nullable<InternalTexture>
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112943

depthStencilTextureWithStencil

get depthStencilTextureWithStencil(): boolean
Indicates if the depth/stencil texture has a stencil aspect

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112953

faceIndices

get faceIndices(): Nullable<number[]>
Gets the face indices that correspond to the list of render textures. If we are not in a multi render target, the list will be null

Returns Nullable<number[]>
- Defined in .temp/typedoc/docdirectory/doc.d.ts:113001

height

get height(): number
Gets the height of the render target wrapper

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112981

is2DArray

get is2DArray(): boolean
Defines if the render target wrapper is for a single or an array of textures

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112965

is3D

get is3D(): boolean
Defines if the render target wrapper is for a 3D texture

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112969

isCube

get isCube(): boolean
Defines if the render target wrapper is for a cube texture or if false a 2d texture

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112957

isMulti

get isMulti(): boolean
Defines if the render target wrapper is for a single or multi target render wrapper

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112961

layerIndices

get layerIndices(): Nullable<number[]>
Gets the layer indices that correspond to the list of render textures. If we are not in a multi render target, the list will be null

Returns Nullable<number[]>
- Defined in .temp/typedoc/docdirectory/doc.d.ts:113005

layers

get layers(): number
Gets the number of layers of the render target wrapper (only used if is2DArray is true and wrapper is not a multi render target)

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112985

samples

get samples(): number
Gets the sample count of the render target

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:113033

size

get size(): number
Gets the size of the render target wrapper (used for cubes, as width=height in this case)

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112973

texture

get texture(): Nullable<InternalTexture>
Gets the render texture. If this is a multi render target, gets the first texture

Returns Nullable<InternalTexture>
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112993

textures

get textures(): Nullable<InternalTexture[]>
Gets the list of render textures. If we are not in a multi render target, the list will be null (use the texture getter instead)

Returns Nullable<InternalTexture[]>
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112997

width

get width(): number
Gets the width of the render target wrapper

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112977

Methods

_shareDepth

_shareDepth(renderTarget: RenderTargetWrapper): void
Parameters
- renderTarget: RenderTargetWrapper
  Destination renderTarget
Returns void
Deprecated
Use shareDepth instead
- Defined in .temp/typedoc/docdirectory/doc.d.ts:113100

createDepthStencilTexture

createDepthStencilTexture(
    comparisonFunction?: number,
    bilinearFiltering?: boolean,
    generateStencil?: boolean,
    samples?: number,
    format?: number,
    label?: string,
): InternalTexture
Creates the depth/stencil texture
Parameters
- OptionalcomparisonFunction: number
  Comparison function to use for the texture
- OptionalbilinearFiltering: boolean
  true if bilinear filtering should be used when sampling the texture
- OptionalgenerateStencil: boolean
  Not used anymore. "format" will be used to determine if stencil should be created
- Optionalsamples: number
  sample count to use when creating the texture (default: 1)
- Optionalformat: number
  format of the depth texture (default: Constants.TEXTUREFORMAT_DEPTH32_FLOAT)
- Optionallabel: string
  defines the label to use for the texture (for debugging purpose only)
Returns InternalTexture
the depth/stencil created texture
- Defined in .temp/typedoc/docdirectory/doc.d.ts:113095

dispose

dispose(disposeOnlyFramebuffers?: boolean): void
Disposes the whole render target wrapper
Parameters
- OptionaldisposeOnlyFramebuffers: boolean
  true if only the frame buffers should be released (used for the WebGL engine). If false, all the textures will also be released
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:113122

generateMipMaps

generateMipMaps(): void
Generates mipmaps for each texture of the render target

Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:113050

getBaseArrayLayer

getBaseArrayLayer(index: number): number
Gets the base array layer of a texture in the textures array This is an number that is calculated based on the layer and face indices set for this texture at that index
Parameters
- index: number
  The index of the texture in the textures array to get the base array layer for
Returns number
the base array layer of the texture at the given index
- Defined in .temp/typedoc/docdirectory/doc.d.ts:113029

releaseTextures

releaseTextures(): void
Releases the internal render textures

Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:113117

resolveMSAATextures

resolveMSAATextures(): void
Resolves the MSAA textures into their non-MSAA version. Note that if samples equals 1 (no MSAA), no resolve is performed.

Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:113046

setDepthStencilTexture

setDepthStencilTexture(
texture: Nullable<InternalTexture>,
disposeExisting?: boolean,
): void
Sets the depth/stencil texture
Parameters
- texture: Nullable<InternalTexture>
  The depth/stencil texture to set
- OptionaldisposeExisting: boolean
  True to dispose the existing depth/stencil texture (if any) before replacing it (default: true)
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:112949

setLayerAndFaceIndex

setLayerAndFaceIndex(index?: number, layer?: number, face?: number): void
Sets the layer and face indices of a texture in the textures array that should be bound to each color attachment
Parameters
- Optionalindex: number
  The index of the texture in the textures array to modify
- Optionallayer: number
  The layer of the texture to be set
- Optionalface: number
  The face of the texture to be set
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:113084

setLayerAndFaceIndices

setLayerAndFaceIndices(layers: number[], faces: number[]): void
Sets the layer and face indices of every render target texture bound to each color attachment
Parameters
- layers: number[]
  The layers of each texture to be set
- faces: number[]
  The faces of each texture to be set
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:113077

setSamples

setSamples(value: number, initializeBuffers?: boolean, force?: boolean): number
Sets the sample count of the render target
Parameters
- value: number
  sample count
- OptionalinitializeBuffers: boolean
  If set to true, the engine will make an initializing call to drawBuffers (only used when isMulti=true).
- Optionalforce: boolean
  true to force calling the update sample count engine function even if the current sample count is equal to value
Returns number
the sample count that has been set
- Defined in .temp/typedoc/docdirectory/doc.d.ts:113041

setTexture

setTexture(
    texture: InternalTexture,
    index?: number,
    disposePrevious?: boolean,
): void
Set a texture in the textures array
Parameters
- texture: InternalTexture
  The texture to set
- Optionalindex: number
  The index in the textures array to set
- OptionaldisposePrevious: boolean
  If this function should dispose the previous texture
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:113071

setTextures

setTextures(textures: null | InternalTexture | InternalTexture[]): void
Sets the render target texture(s)
Parameters
- textures: null | InternalTexture | InternalTexture[]
  texture(s) to set
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:113064

shareDepth

shareDepth(renderTarget: RenderTargetWrapper): void
Shares the depth buffer of this render target with another render target.
Parameters
- renderTarget: RenderTargetWrapper
  Destination renderTarget
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:113105

Class RenderTargetWrapper

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns RenderTargetWrapper

Properties

disableAutomaticMSAAResolve

Optionallabel

resolveMSAAColors

resolveMSAADepth

resolveMSAAStencil

Accessors

depth

Returns number

depthStencilTexture

Returns Nullable<InternalTexture>

depthStencilTextureWithStencil

Returns boolean

faceIndices

Returns Nullable<number[]>

height

Returns number

is2DArray

Returns boolean

is3D

Returns boolean

isCube

Returns boolean

isMulti

Returns boolean

layerIndices

Returns Nullable<number[]>

layers

Returns number

samples

Returns number

size

Returns number

texture

Returns Nullable<InternalTexture>

textures

Returns Nullable<InternalTexture[]>

width

Returns number

Methods

_shareDepth

Parameters

Returns void

Deprecated

createDepthStencilTexture

Parameters

Returns InternalTexture

dispose

Parameters

Returns void

generateMipMaps

Returns void

getBaseArrayLayer

Parameters

Returns number

releaseTextures

Returns void

resolveMSAATextures

Returns void

setDepthStencilTexture

Parameters

Returns void

setLayerAndFaceIndex

Parameters

Returns void

setLayerAndFaceIndices

Parameters

Returns void

setSamples

`Optional`label