Enumeration BuiltinShader

Types of builtin shaders that are always available.

Constructors

constructor

Values

Count Custom Decal ParallaxOcclussionMapStandard ParallaxOcclussionMapTransparent ParticlesLit ParticlesLitOpaque ParticlesUnlit ParticlesVolumetric RelaxedConeStepStandard RelaxedConeStepTransparent SpriteImage SpriteLine SpriteText Standard Transparent

Methods

addFlag combineFlags getEnumName getEnumNames getEnumValue getEnumValues getNameForValue getNames getValueAtIndex getValues hasFlag hasFlagChanged iterateNames iterateValues removeFlag splitFlags

Constructors

Protectedconstructor

  • new BuiltinShader(do_not_, construct_, this_, type_): BuiltinShader

  • Parameters

    • do_not_: undefined
    • construct_: undefined
    • this_: undefined
    • type_: undefined

    Returns BuiltinShader

Values

Static ReadonlyCount

Count = 15

The number of enum values.

Static ReadonlyCustom

Custom = 0

Static ReadonlyDecal

Decal = 9

Special shader used for rendering decals that project onto other geometry.

Static ReadonlyParallaxOcclussionMapStandard

ParallaxOcclussionMapStandard = 11

Special shader used for rendering Parallax Occlusion Mapping relief technique. Uses same surface shading as Standard.

Static ReadonlyParallaxOcclussionMapTransparent

ParallaxOcclussionMapTransparent = 13

Special shader used for rendering Parallax Occlusion Mapping relief technique but works with transparency. Uses same surface shading as Transparent.

Static ReadonlyParticlesLit

ParticlesLit = 7

Special shader used for rendering particles with lighting using the forward rendering pipeline (supports transparency).

Static ReadonlyParticlesLitOpaque

ParticlesLitOpaque = 8

Special shader used for rendering particles with lighting using the deferred rendering pipeline (no support for transparency).

Static ReadonlyParticlesUnlit

ParticlesUnlit = 6

Special shader used for rendering particles without any lighting, with support for transparency.

Static ReadonlyParticlesVolumetric

ParticlesVolumetric = 14

Special shader used for creating localized volumetric lighting by using the particle system to simulate the participating media.

Static ReadonlyRelaxedConeStepStandard

RelaxedConeStepStandard = 10

Special shader used for rendering Relaxed Cone Stepping relief technique. Uses same surface shading as Standard.

Static ReadonlyRelaxedConeStepTransparent

RelaxedConeStepTransparent = 12

Special shader used for rendering Relaxed Cone Stepping relief technique but works with transparency. Uses same surface shading as Transparent.

Static ReadonlySpriteImage

SpriteImage = 2

Sprite image shader.

Note

Registered early so the async load is processed first as required for UI.

Static ReadonlySpriteLine

SpriteLine = 3

Sprite line shader.

Note

Registered early so the async load is processed first as required for UI.

Static ReadonlySpriteText

SpriteText = 1

Sprite text shader.

Note

Registered early so the async load is processed first as required for UI.

Static ReadonlyStandard

Standard = 4

Physically based shader used for opaque 3D geometry.

Static ReadonlyTransparent

Transparent = 5

Physically based shader used for transparent 3D geometry.

Methods

StaticaddFlag

StaticcombineFlags

  • combineFlags<T>(values): EnumValueTyped<T, number>

  • Takes an array of enum values and combines them as a single enum flag value. This assumes that the target enum is a flag enum that can have their values combined using bitwise operators.

    Type Parameters

    Parameters

    Returns EnumValueTyped<T, number>

    The combined enum value.

StaticgetEnumName

  • getEnumName<T>(index): string

  • Type Parameters

    • T

    Parameters

    Returns string

    Obsolete

    Compatibility

StaticgetEnumNames

  • getEnumNames(): string[]

  • Returns string[]

    Obsolete

    Compatibility

StaticgetEnumValue

  • getEnumValue(index): number

  • Parameters

    • index: number

    Returns number

    Obsolete

    Compatibility

StaticgetEnumValues

  • getEnumValues(): number[]

  • Returns number[]

    Obsolete

    Compatibility

StaticgetNameForValue

  • getNameForValue<T>(enumValue): string

  • Gets the name for the enumeration value that matches the specified enumValue.

    Type Parameters

    • T

    Parameters

    Returns string

    The enumeration value or undefined if not found.

StaticgetNames

  • getNames(): string[]

  • Gets the enumeration names

    Returns string[]

    The enumeration names.

StaticgetValueAtIndex

  • getValueAtIndex<T>(index): EnumValueTyped<T, number>

  • Gets the enumeration value at the specified index.

    Type Parameters

    • T = number

    Parameters

    • index: number

      The index.

    Returns EnumValueTyped<T, number>

    The enumeration value or undefined if not found.

StaticgetValues

StatichasFlag

  • hasFlag<T, K>(value, bits): boolean

  • Determines if the enum value has the flags set.

    Type Parameters

    Parameters

    Returns boolean

StatichasFlagChanged

  • hasFlagChanged<T, K>(previousValue, newValue, bits): boolean

  • Determines if the enum bits were changed from previousValue to currentValue.

    Type Parameters

    Parameters

    Returns boolean

StaticiterateNames

  • iterateNames(): Generator<string, any, any>

  • Iterates the enumeration names

    Returns Generator<string, any, any>

    The enumeration names.

StaticiterateValues

  • iterateValues<T>(): Generator<EnumValueTyped<T, number>, any, any>

  • Iterates the enumeration values

    Type Parameters

    • T = any

    Returns Generator<EnumValueTyped<T, number>, any, any>

    The enumeration values.

StaticremoveFlag

StaticsplitFlags

  • splitFlags<T>(value): EnumValueTyped<T, number>[]

  • Takes a single enum value and splits it into separated flag values set on the value. This assumes that the target enum is a flag enum that can have their values combined using bitwise operators.

    Type Parameters

    Parameters

    • value: number | BrandedType<number, "enum"> | BrandedType<T, "enum">

      The enum value to have it's value split using bitwise-and operator.

    Returns EnumValueTyped<T, number>[]

    An array of each "bit flag" set in the enum.

Settings

Member Visibility

On This Page

Constructors
Values
Methods