Enumeration ShaderParameterType

Type of parameters that can be defined by a shader.

Constructors

`Protected`constructor

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

Values

`Static` `Readonly`Bool

Bool = 0

`Static` `Readonly`Float

Float = 1

`Static` `Readonly`Int

Int = 9

`Static` `Readonly`IVector2

IVector2 = 10

`Static` `Readonly`IVector3

IVector3 = 11

`Static` `Readonly`IVector4

IVector4 = 12

`Static` `Readonly`LinearColor

LinearColor = 13

`Static` `Readonly`Matrix2

Matrix2 = 14

`Static` `Readonly`Matrix3

Matrix3 = 15

`Static` `Readonly`Matrix4

Matrix4 = 16

`Static` `Readonly`Sampler

Sampler = 21

`Static` `Readonly`Texture1D

Texture1D = 17

`Static` `Readonly`Texture2D

Texture2D = 18

`Static` `Readonly`Texture3D

Texture3D = 19

`Static` `Readonly`TextureCube

TextureCube = 20

`Static` `Readonly`UInt

UInt = 5

`Static` `Readonly`UIVector2

UIVector2 = 6

`Static` `Readonly`UIVector3

UIVector3 = 7

`Static` `Readonly`UIVector4

UIVector4 = 8

`Static` `Readonly`Vector2

Vector2 = 2

`Static` `Readonly`Vector3

Vector3 = 3

`Static` `Readonly`Vector4

Vector4 = 4

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.