Class RenderPassCookieRenderer

A render pass used to render cookie textures (both 2D and Cubemap) into the texture atlas.

Hierarchy

  • RenderPass
    • RenderPassCookieRenderer

Properties

_name _options _quadRenderer2D _quadRendererCube afterPasses beforePasses colorArrayOps depthStencilOps device executeEnabled fullSizeClearRect renderTarget samples

Accessors

colorOps

Methods

init render setClearColor setClearDepth setClearStencil

Properties

_name

_name: string

_options

_options: any

The options specified when the render target was initialized.

_quadRenderer2D

_quadRenderer2D: QuadRender = null

_quadRendererCube

_quadRendererCube: QuadRender = null

afterPasses

afterPasses: RenderPass[] = []

Render passes which need to be executed after this pass.

beforePasses

beforePasses: RenderPass[] = []

Render passes which need to be executed before this pass.

colorArrayOps

colorArrayOps: ColorAttachmentOps[] = []

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

depthStencilOps

depthStencilOps: DepthStencilAttachmentOps

device

device: GraphicsDevice

The graphics device.

executeEnabled

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

fullSizeClearRect: boolean = true

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

renderTarget

renderTarget: any

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.

samples

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

colorOps

Methods

init

  • init(
        renderTarget?: any,
        options?: { resizeSource?: Texture; scaleX?: number; scaleY?: number },
    ): void

    Parameters

    • OptionalrenderTarget: any = 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.

    • Optionaloptions: { resizeSource?: Texture; scaleX?: number; scaleY?: number }

      Object for passing optional arguments.

      • OptionalresizeSource?: Texture

        A texture to use as a source for the automatic render target resize operation. If not provided, no automatic resizing takes place.

      • OptionalscaleX?: number

        The scale factor for the render target width. Defaults to 1.

      • OptionalscaleY?: number

        The scale factor for the render target height. Defaults to 1.

    Returns void

render

setClearColor

setClearDepth

  • setClearDepth(depthValue: number): 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

setClearStencil

  • setClearStencil(stencilValue: number): 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

Settings

Member Visibility

On This Page

Properties
Accessors
Methods