EffectFallbacks

EffectFallbacks can be used to add fallbacks (properties to disable) to certain properties when desired to improve performance. (Eg. Start at high quality with reflection and fog, if fps is low, remove reflection, if still low remove fog)

Hierarchy

  • EffectFallbacks

Index

Properties

isMoreFallbacks

Find examples in Playground
isMoreFallbacks: boolean

Checks to see if more fallbacks are still availible.

Methods

addCPUSkinningFallback

Find examples in Playground
  • addCPUSkinningFallback(rank: number, mesh: AbstractMesh): void
  • Sets the mesh to use CPU skinning when needing to fallback.

    Parameters

    • rank: number

      The rank of the fallback (Lower ranks will be fallbacked to first)

    • mesh: AbstractMesh

      The mesh to use the fallbacks.

    Returns void

addFallback

Find examples in Playground
  • addFallback(rank: number, define: string): void
  • Adds a fallback on the specified property.

    Parameters

    • rank: number

      The rank of the fallback (Lower ranks will be fallbacked to first)

    • define: string

      The name of the define in the shader

    Returns void

reduce

Find examples in Playground
  • reduce(currentDefines: string, effect: Effect): string
  • Removes the defines that shoould be removed when falling back.

    Parameters

    • currentDefines: string

      defines the current define statements for the shader.

    • effect: Effect

      defines the current effect we try to compile

    Returns string

    The resulting defines with defines of the current rank removed.

unBindMesh

Find examples in Playground
  • unBindMesh(): void
  • Removes the fallback from the bound mesh.

    Returns void

Generated using TypeDoc