Enumeration BuiltinShader

Types of builtin shaders that are always available.

Constructors

`Protected`constructor

new BuiltinShader(do_not_, construct_, this_, type_): BuiltinShader
Parameters
- do_not_: undefined
- construct_: undefined
- this_: undefined
- type_: undefined
Returns BuiltinShader

Values

`Static` `Readonly`Count

Count: EnumValue<BuiltinShader, number>

The number of enum values.

`Static` `Readonly`Custom

Custom: EnumValue<BuiltinShader, number>

`Static` `Readonly`Decal

Decal: EnumValue<BuiltinShader, number>

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

`Static` `Readonly`ParallaxOcclussionMapStandard

ParallaxOcclussionMapStandard: EnumValue<BuiltinShader, number>

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

`Static` `Readonly`ParallaxOcclussionMapTransparent

ParallaxOcclussionMapTransparent: EnumValue<BuiltinShader, number>

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

`Static` `Readonly`ParticlesLit

ParticlesLit: EnumValue<BuiltinShader, number>

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

`Static` `Readonly`ParticlesLitOpaque

ParticlesLitOpaque: EnumValue<BuiltinShader, number>

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

`Static` `Readonly`ParticlesUnlit

ParticlesUnlit: EnumValue<BuiltinShader, number>

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

`Static` `Readonly`ParticlesVolumetric

ParticlesVolumetric: EnumValue<BuiltinShader, number>

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

`Static` `Readonly`RelaxedConeStepStandard

RelaxedConeStepStandard: EnumValue<BuiltinShader, number>

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

`Static` `Readonly`RelaxedConeStepTransparent

RelaxedConeStepTransparent: EnumValue<BuiltinShader, number>

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

`Static` `Readonly`SpriteImage

SpriteImage: EnumValue<BuiltinShader, number>

Sprite image shader.

Note

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

`Static` `Readonly`SpriteLine

SpriteLine: EnumValue<BuiltinShader, number>

Sprite line shader.

Note

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

`Static` `Readonly`SpriteText

SpriteText: EnumValue<BuiltinShader, number>

Sprite text shader.

Note

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

`Static` `Readonly`Standard

Standard: EnumValue<BuiltinShader, number>

Physically based shader used for opaque 3D geometry.

`Static` `Readonly`Transparent

Transparent: EnumValue<BuiltinShader, number>

Physically based shader used for transparent 3D geometry.

Methods

`Static`addFlag

addFlag<T, K>(value, bits): K
Adds the flag bits to the enum value.
Type Parameters
- T
- K = number | BrandedType<number, "enum"> | BrandedType<T, "enum">
Parameters
- value: K
- bits: EnumValueTyped<T, number>
Returns K

`Static`combineFlags

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
- T extends Enum
Parameters
- values: EnumValue<T, number>[] | EnumValueTyped<T, number>[]
  The array of values to be combined using bitwise-or operator.
Returns EnumValueTyped<T, number>
The combined enum value.

`Static`getEnumName

getEnumName<T>(index): string
Type Parameters
- T
Parameters
- index: EnumValue<T, number>
Returns string
Obsolete
Compatibility

`Static`getEnumNames

getEnumNames(): string[]
Returns string[]
Obsolete
Compatibility

`Static`getEnumValue

getEnumValue(index): number
Parameters
- index: number
Returns number
Obsolete
Compatibility

`Static`getEnumValues

getEnumValues(): number[]
Returns number[]
Obsolete
Compatibility

`Static`getNameForValue

getNameForValue<T>(enumValue): string
Gets the name for the enumeration value that matches the specified enumValue.
Type Parameters
- T
Parameters
- enumValue: number | BrandedType<number, "enum"> | BrandedType<T, "enum">
  The enumeration value.
Returns string
The enumeration value or undefined if not found.

`Static`getNames

getNames(): string[]
Gets the enumeration names

Returns string[]
The enumeration names.

`Static`getValueAtIndex

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.

`Static`getValues

getValues<T>(): EnumValueTyped<T, number>[]
Gets the enumeration values
Type Parameters
- T = any
Returns EnumValueTyped<T, number>[]
The enumeration values.

`Static`hasFlag

hasFlag<T, K>(value, bits): boolean
Determines if the enum value has the flags set.
Type Parameters
- T
- K = number | BrandedType<number, "enum"> | BrandedType<T, "enum">
Parameters
- value: K
- bits: EnumValueTyped<T, number>
Returns boolean

`Static`hasFlagChanged

hasFlagChanged<T, K>(previousValue, newValue, bits): boolean
Determines if the enum bits were changed from previousValue to currentValue.
Type Parameters
- T
- K = number | BrandedType<number, "enum"> | BrandedType<T, "enum">
Parameters
- previousValue: K
- newValue: K
- bits: EnumValueTyped<T, number>
Returns boolean

`Static`iterateNames

iterateNames(): Generator<string, any, any>
Iterates the enumeration names

Returns Generator<string, any, any>
The enumeration names.

`Static`iterateValues

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.

`Static`removeFlag

removeFlag<T, K>(value, bits): K
Removes the flag bits from the enum value.
Type Parameters
- T
- K = number | BrandedType<number, "enum"> | BrandedType<T, "enum">
Parameters
- value: K
- bits: EnumValueTyped<T, number>
Returns K

`Static`splitFlags

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
- T extends Enum
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.

Enumeration BuiltinShader

Index

Constructors

Values

Methods

Constructors

Protectedconstructor

Parameters

Returns BuiltinShader

Values

Static ReadonlyCount

Static ReadonlyCustom

Static ReadonlyDecal

Static ReadonlyParallaxOcclussionMapStandard

Static ReadonlyParallaxOcclussionMapTransparent

Static ReadonlyParticlesLit

Static ReadonlyParticlesLitOpaque

Static ReadonlyParticlesUnlit

Static ReadonlyParticlesVolumetric

Static ReadonlyRelaxedConeStepStandard

Static ReadonlyRelaxedConeStepTransparent

Static ReadonlySpriteImage

Note

Static ReadonlySpriteLine

Note

Static ReadonlySpriteText

Note

Static ReadonlyStandard

Static ReadonlyTransparent

Methods

StaticaddFlag

Type Parameters

Parameters

Returns K

StaticcombineFlags

Type Parameters

Parameters

Returns EnumValueTyped<T, number>

StaticgetEnumName

Type Parameters

Parameters

Returns string

Obsolete

StaticgetEnumNames

Returns string[]

Obsolete

StaticgetEnumValue

Parameters

Returns number

Obsolete

StaticgetEnumValues

Returns number[]

Obsolete

StaticgetNameForValue

Type Parameters

Parameters

Returns string

StaticgetNames

Returns string[]

StaticgetValueAtIndex

Type Parameters

Parameters

Returns EnumValueTyped<T, number>

StaticgetValues

Type Parameters

Returns EnumValueTyped<T, number>[]

StatichasFlag

Type Parameters

Parameters

Returns boolean

StatichasFlagChanged

Type Parameters

Parameters

Returns boolean

StaticiterateNames

Returns Generator<string, any, any>

StaticiterateValues

Type Parameters

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

StaticremoveFlag

`Protected`constructor

`Static` `Readonly`Count

`Static` `Readonly`Custom

`Static` `Readonly`Decal

`Static` `Readonly`ParallaxOcclussionMapStandard

`Static` `Readonly`ParallaxOcclussionMapTransparent

`Static` `Readonly`ParticlesLit

`Static` `Readonly`ParticlesLitOpaque

`Static` `Readonly`ParticlesUnlit

`Static` `Readonly`ParticlesVolumetric

`Static` `Readonly`RelaxedConeStepStandard

`Static` `Readonly`RelaxedConeStepTransparent

`Static` `Readonly`SpriteImage

`Static` `Readonly`SpriteLine

`Static` `Readonly`SpriteText

`Static` `Readonly`Standard

`Static` `Readonly`Transparent

`Static`addFlag

`Static`combineFlags

`Static`getEnumName

`Static`getEnumNames

`Static`getEnumValue

`Static`getEnumValues

`Static`getNameForValue

`Static`getNames

`Static`getValueAtIndex

`Static`getValues

`Static`hasFlag

`Static`hasFlagChanged

`Static`iterateNames

`Static`iterateValues

`Static`removeFlag

`Static`splitFlags