Options
All
  • Public
  • Public/Protected
  • All
Menu

The depth peeling renderer that performs Order independant transparency (OIT). This should not be instanciated directly, as it is part of a scene component

Hierarchy

  • DepthPeelingRenderer

Index

Constructors

  • Instanciates the depth peeling renderer

    Parameters

    • scene: Scene

      Scene to attach to

    • Optional passCount: number

      Number of depth layers to peel

    Returns DepthPeelingRenderer

    The depth peeling renderer

Accessors

  • get passCount(): number
  • set passCount(count: number): void
  • Number of depth peeling passes. As we are using dual depth peeling, each pass two levels of transparency are processed.

    Returns number

  • Number of depth peeling passes. As we are using dual depth peeling, each pass two levels of transparency are processed.

    Parameters

    • count: number

    Returns void

  • get useRenderPasses(): boolean
  • set useRenderPasses(usePasses: boolean): void
  • Instructs the renderer to use render passes. It is an optimization that makes the rendering faster for some engines (like WebGPU) but that consumes more memory, so it is disabled by default.

    Returns boolean

  • Instructs the renderer to use render passes. It is an optimization that makes the rendering faster for some engines (like WebGPU) but that consumes more memory, so it is disabled by default.

    Parameters

    • usePasses: boolean

    Returns void

Methods

  • Binds depth peeling textures on an effect

    Parameters

    • effect: Effect

      The effect to bind textures on

    Returns void

  • dispose(): void
  • Disposes the depth peeling renderer and associated ressources

    Returns void

  • Renders transparent submeshes with depth peeling

    Parameters

    Returns SmartArray<SubMesh>

    The array of submeshes that could not be handled by this renderer

  • Links to the prepass renderer

    Parameters

    Returns void

Legend

  • Constructor
  • Property
  • Method
  • Accessor
  • Property
  • Method
  • Inherited constructor
  • Static method

Settings

Theme