Class FrameGraphContext

enableDebugMarkers

getTextureFromHandle

• getTextureFromHandle(handle: FrameGraphTextureHandle): 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.

  Parameters

  • handle: FrameGraphTextureHandle

    The handle of the texture

  Returns Nullable<InternalTexture>

  The texture or null if not found

insertDebugMarker

• insertDebugMarker(text: string): void

  Inserts a debug marker in the engine's debug stack.

  Parameters

  • text: string

    The text of the debug marker

  Returns void

popDebugGroup

• popDebugGroup(): void

  Pops a debug group from the engine's debug stack.

  Returns void

pushDebugGroup

• pushDebugGroup(name: string): void

  Pushes a debug group to the engine's debug stack.

  Parameters

  • name: string

    The name of the debug group

  Returns void

renderUnmanaged

• renderUnmanaged(
      component: { render: () => void },
      intermediateRendering?: boolean,
  ): void

  Renders a component without managing the render target. Use this method when you have a component that handles its own rendering logic which is not fully integrated into the frame graph system.

  Parameters

  • component: { render: () => void }

    The component to render.

  • intermediateRendering: boolean = true

    If true, the scene's intermediate rendering flag will be set to true during the render call (default: true)

  Returns void

restoreDepthStates

• restoreDepthStates(): void

  Restores the depth states saved by saveDepthStates

  Returns void

saveDepthStates

• saveDepthStates(): void

  Saves the current depth states (depth testing and depth writing)

  Returns void

setDepthStates

• setDepthStates(depthTest: boolean, depthWrite: boolean): void

  Sets the depth states for the current render target

  Parameters

  • depthTest: boolean

    If true, depth testing is enabled

  • depthWrite: boolean

    If true, depth writing is enabled

  Returns void

setViewport

• setViewport(
      viewport: IViewportLike,
      requiredWidth?: number,
      requiredHeight?: number,
  ): void

  Sets the current viewport

  Parameters

  • viewport: IViewportLike

    defines the viewport element to be used

  • OptionalrequiredWidth: number

    defines the width required for rendering. If not provided, the width of the render texture is used.

  • OptionalrequiredHeight: number

    defines the height required for rendering. If not provided the height of the render texture is used.

  Returns void