Class RenderTargetWrapper

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

depthReadOnly

disableAutomaticMSAAResolve

Optionallabel

resolveMSAAColors

resolveMSAADepth

resolveMSAAStencil

stencilReadOnly

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

depthStencilTexture

• get depthStencilTexture(): Nullable<InternalTexture>

  Gets the depth/stencil texture

  Returns Nullable<InternalTexture>

depthStencilTextureWithStencil

• get depthStencilTextureWithStencil(): boolean

  Indicates if the depth/stencil texture has a stencil aspect

  Returns boolean

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[]>

height

• get height(): number

  Gets the height of the render target wrapper

  Returns number

is2DArray

• get is2DArray(): boolean

  Defines if the render target wrapper is for a single or an array of textures

  Returns boolean

is3D

• get is3D(): boolean

  Defines if the render target wrapper is for a 3D texture

  Returns boolean

isCube

• get isCube(): boolean

  Defines if the render target wrapper is for a cube texture or if false a 2d texture

  Returns boolean

isMulti

• get isMulti(): boolean

  Defines if the render target wrapper is for a single or multi target render wrapper

  Returns boolean

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[]>

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

samples

• get samples(): number

  Gets the sample count of the render target

  Returns number

size

• get size(): number

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

  Returns number

texture

• get texture(): Nullable<InternalTexture>

  Gets the render texture. If this is a multi render target, gets the first texture

  Returns Nullable<InternalTexture>

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[]>

width

• get width(): number

  Gets the width of the render target wrapper

  Returns number

_shareDepth

• _shareDepth(renderTarget: RenderTargetWrapper): void

  Parameters

  • renderTarget: RenderTargetWrapper

    Destination renderTarget

  Returns void

  Deprecated

  Use shareDepth instead

createDepthStencilTexture

• createDepthStencilTexture(
      comparisonFunction?: number,
      bilinearFiltering?: boolean,
      generateStencil?: boolean,
      samples?: number,
      format?: number,
      label?: string,
  ): InternalTexture

  Creates the depth/stencil texture

  Parameters

  • comparisonFunction: number = 0

    Comparison function to use for the texture

  • bilinearFiltering: boolean = true

    true if bilinear filtering should be used when sampling the texture

  • generateStencil: boolean = false

    Not used anymore. "format" will be used to determine if stencil should be created

  • samples: number = 1

    sample count to use when creating the texture (default: 1)

  • format: number = Constants.TEXTUREFORMAT_DEPTH32_FLOAT

    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

dispose

• dispose(disposeOnlyFramebuffers?: boolean): void

  Disposes the whole render target wrapper

  Parameters

  • disposeOnlyFramebuffers: boolean = false

    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

generateMipMaps

• generateMipMaps(): void

  Generates mipmaps for each texture of the render target

  Returns void

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

releaseTextures

• releaseTextures(): void

  Releases the internal render textures

  Returns void

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

setDepthStencilTexture

• setDepthStencilTexture(
      texture: Nullable<InternalTexture>,
      disposeExisting?: boolean,
  ): void

  Sets the depth/stencil texture

  Parameters

  • texture: Nullable<InternalTexture>

    The depth/stencil texture to set

  • disposeExisting: boolean = true

    True to dispose the existing depth/stencil texture (if any) before replacing it (default: true)

  Returns void

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

  • index: number = 0

    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

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

setSamples

• setSamples(value: number, initializeBuffers?: boolean, force?: boolean): number

  Sets the sample count of the render target

  Parameters

  • value: number

    sample count

  • initializeBuffers: boolean = true

    If set to true, the engine will make an initializing call to drawBuffers (only used when isMulti=true).

  • force: boolean = false

    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

setTexture

• setTexture(
      texture: InternalTexture,
      index?: number,
      disposePrevious?: boolean,
  ): void

  Set a texture in the textures array

  Parameters

  • texture: InternalTexture

    The texture to set

  • index: number = 0

    The index in the textures array to set

  • disposePrevious: boolean = true

    If this function should dispose the previous texture

  Returns void

setTextures

• setTextures(textures: InternalTexture | InternalTexture[] | null): void

  Sets the render target texture(s)

  Parameters

  • textures: InternalTexture | InternalTexture[] | null

    texture(s) to set

  Returns void

shareDepth

• shareDepth(renderTarget: RenderTargetWrapper): void

  Shares the depth buffer of this render target with another render target.

  Parameters

  • renderTarget: RenderTargetWrapper

    Destination renderTarget

  Returns void