Class FrameGraphTextureManager

constructor

• new FrameGraphTextureManager(
      engine: AbstractEngine,
      _debugTextures?: boolean,
      _scene: Scene,
  ): FrameGraphTextureManager

  Constructs a new instance of the texture manager

  Parameters

  • engine: AbstractEngine

    The engine to use

  • _debugTextures: boolean = false

    If true, debug textures will be created so that they are visible in the inspector

  • _scene: Scene

    The scene the manager belongs to

  Returns FrameGraphTextureManager

Readonlyengine

showDebugLogsForTextureAllcationOptimization

backBufferTextureOverriden

• get backBufferTextureOverriden(): boolean

  True if the back buffer texture has been overriden by a call to setBackBufferTexture

  Returns boolean

hasHistoryTextures

• get hasHistoryTextures(): boolean

  Returns true if the texture manager has at least one history texture

  Returns boolean

computeTotalTextureSize

• computeTotalTextureSize(
      optimizedSize: boolean,
      outputWidth: number,
      outputHeight: number,
  ): number

  Calculates the total byte size of all textures used by the frame graph texture manager (including external textures)

  Parameters

  • optimizedSize: boolean

    True if the calculation should not factor in aliased textures

  • outputWidth: number

    The output width of the frame graph. Will be used to calculate the size of percentage-based textures

  • outputHeight: number

    The output height of the frame graph. Will be used to calculate the size of percentage-based textures

  Returns number

  The total size of all textures

createDanglingHandle

• createDanglingHandle(): number

  Creates a handle which is not associated with any texture. Call resolveDanglingHandle to associate the handle with a valid texture handle.

  Returns number

  The dangling handle

createRenderTarget

• createRenderTarget(
      name: string,
      renderTargets?: any,
      renderTargetDepth?: any,
      depthReadOnly?: boolean,
      stencilReadOnly?: boolean,
  ): FrameGraphRenderTarget

  Creates a (frame graph) render target wrapper Note that renderTargets or renderTargetDepth can be undefined, but not both at the same time!

  Parameters

  • name: string

    Name of the render target wrapper

  • OptionalrenderTargets: any

    Render target handles (textures) to use

  • OptionalrenderTargetDepth: any

    Render target depth handle (texture) to use

  • OptionaldepthReadOnly: boolean

    If true, the depth buffer will be read-only

  • OptionalstencilReadOnly: boolean

    If true, the stencil buffer will be read-only

  Returns FrameGraphRenderTarget

  The created render target wrapper

createRenderTargetTexture

• createRenderTargetTexture(
      name: string,
      creationOptions: FrameGraphTextureCreationOptions,
      handle?: any,
  ): FrameGraphTextureHandle

  Creates a new render target texture If multiple textures are described in FrameGraphTextureCreationOptions, the handle of the first texture is returned, handle+1 is the handle of the second texture, etc.

  Parameters

  • name: string

    Name of the texture

  • creationOptions: FrameGraphTextureCreationOptions

    Options to use when creating the texture

  • Optionalhandle: any

    Existing handle to use for the texture. If not provided (default), a new handle will be created.

  Returns FrameGraphTextureHandle

  The handle to the texture

getAbsoluteDimensions

• getAbsoluteDimensions(
      size: TextureSize,
      screenWidth?: number,
      screenHeight?: number,
  ): { height: number; width: number }

  Gets the absolute dimensions of a texture.

  Parameters

  • size: TextureSize

    The size of the texture. Width and height must be expressed as a percentage of the screen size (100=100%)!

  • OptionalscreenWidth: number

    The width of the screen (default: the width of the rendering canvas)

  • OptionalscreenHeight: number

    The height of the screen (default: the height of the rendering canvas)

  Returns { height: number; width: number }

  The absolute dimensions of the texture

getTextureAbsoluteDimensions

• getTextureAbsoluteDimensions(
      handleOrCreationOptions: any,
  ): { height: number; width: number }

  Gets the absolute dimensions of a texture from its handle or creation options.

  Parameters

  • handleOrCreationOptions: any

    The handle or creation options of the texture

  Returns { height: number; width: number }

  The absolute dimensions of the texture

getTextureCreationOptions

• getTextureCreationOptions(
      handle: FrameGraphTextureHandle,
      preserveHistoryTextureFlag?: boolean,
  ): FrameGraphTextureCreationOptions

  Gets the creation options of a texture

  Parameters

  • handle: FrameGraphTextureHandle

    Handle of the texture

  • preserveHistoryTextureFlag: boolean = false

    If true, the isHistoryTexture flag in the returned creation options will be the same as when the texture was created (default: false)

  Returns FrameGraphTextureCreationOptions

  The creation options of the texture

getTextureDescription

• getTextureDescription(
      handle: FrameGraphTextureHandle,
  ): FrameGraphTextureDescription

  Gets the description of a texture

  Parameters

  • handle: FrameGraphTextureHandle

    Handle of the texture

  Returns FrameGraphTextureDescription

  The description of the texture

getTextureFromHandle

• getTextureFromHandle(
      handle: FrameGraphTextureHandle,
      historyGetWriteTexture?: boolean,
  ): Nullable<InternalTexture>

  Gets a texture from a handle. Note that if the texture is a history texture, the read texture for the current frame will be returned, except if historyGetWriteTexture is true.

  Parameters

  • handle: FrameGraphTextureHandle

    The handle of the texture

  • OptionalhistoryGetWriteTexture: boolean

    If true and the texture is a history texture, the write texture for the current frame will be returned (default: false)

  Returns Nullable<InternalTexture>

  The texture or null if not found

getTextureHandleOrCreateTexture

• getTextureHandleOrCreateTexture(
      handle?: any,
      newTextureName?: string,
      creationOptions?: any,
  ): FrameGraphTextureHandle

  Gets a texture handle or creates a new texture if the handle is not provided. If handle is not provided, newTextureName and creationOptions must be provided.

  Parameters

  • Optionalhandle: any

    If provided, will simply return the handle

  • OptionalnewTextureName: string

    Name of the new texture to create

  • OptionalcreationOptions: any

    Options to use when creating the new texture

  Returns FrameGraphTextureHandle

  The handle to the texture.

importTexture

• importTexture(
      name: string,
      texture: InternalTexture,
      handle?: any,
  ): FrameGraphTextureHandle

  Imports a texture into the texture manager

  Parameters

  • name: string

    Name of the texture

  • texture: InternalTexture

    Texture to import

  • Optionalhandle: any

    Existing handle to use for the texture. If not provided (default), a new handle will be created.

  Returns FrameGraphTextureHandle

  The handle to the texture

isBackbuffer

• isBackbuffer(handle: FrameGraphTextureHandle): boolean

  Checks if a handle is a backbuffer handle (color or depth/stencil)

  Parameters

  • handle: FrameGraphTextureHandle

    The handle to check

  Returns boolean

  True if the handle is a backbuffer handle

isBackbufferColor

• isBackbufferColor(handle: FrameGraphTextureHandle): boolean

  Checks if a handle is a backbuffer color handle

  Parameters

  • handle: FrameGraphTextureHandle

    The handle to check

  Returns boolean

  True if the handle is a backbuffer color handle

isBackbufferDepthStencil

• isBackbufferDepthStencil(handle: FrameGraphTextureHandle): boolean

  Checks if a handle is a backbuffer depth/stencil handle

  Parameters

  • handle: FrameGraphTextureHandle

    The handle to check

  Returns boolean

  True if the handle is a backbuffer depth/stencil handle

isHistoryTexture

• isHistoryTexture(
      handle: FrameGraphTextureHandle,
      checkAllTextures?: boolean,
  ): boolean

  Checks if a handle is a history texture (or points to a history texture, for a dangling handle)

  Parameters

  • handle: FrameGraphTextureHandle

    The handle to check

  • checkAllTextures: boolean = false

    If false (default), the function will check if the handle is the main handle of a history texture (the first handle of the history texture). If true, the function will also check if the handle is one of the other handles of a history texture.

  Returns boolean

  True if the handle is a history texture, otherwise false

resetBackBufferTextures

• resetBackBufferTextures(): void

  Resets the back buffer color/depth-stencil textures to the default (the engine's current back buffer textures) It has no effect if setBackBufferTextures has not been called before.

  Returns void

resolveDanglingHandle

• resolveDanglingHandle(
      danglingHandle: FrameGraphTextureHandle,
      handle?: any,
      newTextureName?: string,
      creationOptions?: any,
  ): void

  Associates a texture with a dangling handle

  Parameters

  • danglingHandle: FrameGraphTextureHandle

    The dangling handle

  • Optionalhandle: any

    The handle to associate with the dangling handle (if not provided, a new texture handle will be created, using the newTextureName and creationOptions parameters)

  • OptionalnewTextureName: string

    The name of the new texture to create (if handle is not provided)

  • OptionalcreationOptions: any

    The options to use when creating the new texture (if handle is not provided)

  Returns void

setBackBufferTextures

• setBackBufferTextures(
      width: number,
      height: number,
      textureCreationOptions?: any,
      depthStencilTextureCreationOptions?: any,
  ): void

  Overrides the default back buffer color/depth-stencil textures used by the frame graph. Note that if both textureCreationOptions and depthStencilTextureCreationOptions are provided, the engine will use them to create the back buffer color and depth/stencil textures respectively. In that case, width and height are ignored.

  Parameters

  • width: number

    The width of the back buffer color/depth-stencil texture (if 0, the engine's current back buffer color/depth-stencil texture width will be used)

  • height: number

    The height of the back buffer color/depth-stencil texture (if 0, the engine's current back buffer color/depth-stencil texture height will be used)

  • OptionaltextureCreationOptions: any

    The color texture creation options (optional)

  • OptionaldepthStencilTextureCreationOptions: any

    The depth/stencil texture creation options (optional)

  Returns void

StaticCloneTextureOptions

• CloneTextureOptions(
      options: FrameGraphTextureOptions,
      textureIndex?: number,
      preserveLabels?: boolean,
  ): FrameGraphTextureOptions

  Clones a texture options

  Parameters

  • options: FrameGraphTextureOptions

    The options to clone

  • OptionaltextureIndex: number

    The index of the texture in the types, formats, etc array of FrameGraphTextureOptions. If not provided, all options are cloned.

  • OptionalpreserveLabels: boolean

    True if the labels should be preserved (default: false)

  Returns FrameGraphTextureOptions

  The cloned options