Hierarchy

  • RenderPass
    • RenderPassCameraFrame

Properties

_name: string
_options: any

The options specified when the render target was initialized.

afterPasses: RenderPass[] = []

Render passes which need to be executed after this pass.

beforePasses: RenderPass[] = []

Render passes which need to be executed before this pass.

colorArrayOps: ColorAttachmentOps[] = []

Array of color attachment operations. The first element corresponds to the color attachment 0, and so on.

depthStencilOps: DepthStencilAttachmentOps

The graphics device.

executeEnabled: boolean = true

True if the render pass is enabled and execute function will be called. Note that before and after functions are called regardless of this flag.

fullSizeClearRect: boolean = true

True if the render pass uses the full viewport / scissor for rendering into the render target.

renderTarget: RenderTarget

The render target for this render pass:

  • undefined: render pass does not render to any render target
  • null: render pass renders to the backbuffer
  • Otherwise, renders to the provided RT.
requiresCubemaps: boolean = true

If true, this pass might use dynamically rendered cubemaps. Use for a case where rendering to cubemap faces is interleaved with rendering to shadows, to avoid generating cubemap mipmaps. This will likely be retired when render target dependency tracking gets implemented.

samples: number = 0

Number of samples. 0 if no render target, otherwise number of samples from the render target, or the main framebuffer if render target is null.

Accessors

Methods

  • Parameters

    • OptionalrenderTarget: RenderTarget = null

      The render target to render into (output). This function should be called only for render passes which use render target, or passes which render directly into the default framebuffer, in which case a null or undefined render target is expected.

    • options: any = null

    Returns void

  • Mark render pass as clearing the full color buffer.

    Parameters

    • color: Color

      The color to clear to, or undefined to preserve the existing content.

    Returns void

  • Mark render pass as clearing the full depth buffer.

    Parameters

    • depthValue: number

      The depth value to clear to, or undefined to preserve the existing content.

    Returns void

  • Mark render pass as clearing the full stencil buffer.

    Parameters

    • stencilValue: number

      The stencil value to clear to, or undefined to preserve the existing content.

    Returns void