RenderingManager

Hierarchy

  • RenderingManager

Index

Constructors

constructor

Properties

Static AUTOCLEAR

AUTOCLEAR: boolean

Used to globally prevent autoclearing scenes.

Static MAX_RENDERINGGROUPS

MAX_RENDERINGGROUPS: number

The max id used for rendering groups (not included)

Static MIN_RENDERINGGROUPS

MIN_RENDERINGGROUPS: number

The min id used for rendering groups (included)

Methods

dispatch

dispatchParticles

dispatchSprites

dispose

  • dispose(): void
  • Returns void

freeRenderingGroups

  • freeRenderingGroups(): void
  • Clear the info related to rendering groups preventing retention points during dispose.

    Returns void

getAutoClearDepthStencilSetup

  • Gets the current auto clear configuration for one rendering group of the rendering manager.

    Parameters

    • index: number

      the rendering group index to get the information for

    Returns IRenderingManagerAutoClearSetup

    The auto clear setup for the requested rendering group

render

  • render(customRenderFunction: Nullable<function>, activeMeshes: Nullable<AbstractMesh[]>, renderParticles: boolean, renderSprites: boolean): void
  • Parameters

    Returns void

reset

  • reset(): void
  • Returns void

setRenderingAutoClearDepthStencil

  • setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void
  • Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.

    Parameters

    • renderingGroupId: number

      The rendering group id corresponding to its index

    • autoClearDepthStencil: boolean

      Automatically clears depth and stencil between groups if true.

    • Optional depth: boolean

      Automatically clears depth between groups if true and autoClear is true.

    • Optional stencil: boolean

      Automatically clears stencil between groups if true and autoClear is true.

    Returns void

setRenderingOrder

  • setRenderingOrder(renderingGroupId: number, opaqueSortCompareFn?: Nullable<function>, alphaTestSortCompareFn?: Nullable<function>, transparentSortCompareFn?: Nullable<function>): void
  • Overrides the default sort function applied in the renderging group to prepare the meshes. This allowed control for front to back rendering or reversly depending of the special needs.

    Parameters

    • renderingGroupId: number

      The rendering group id corresponding to its index

    • Optional opaqueSortCompareFn: Nullable<function>

      The opaque queue comparison function use to sort.

    • Optional alphaTestSortCompareFn: Nullable<function>

      The alpha test queue comparison function use to sort.

    • Optional transparentSortCompareFn: Nullable<function>

      The transparent queue comparison function use to sort.

    Returns void

Generated using TypeDoc