Enumeration VertexElementType

Types used to identify base types of vertex element contents.

Constructors

`Protected`constructor

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

Values

`Static` `Readonly`Color

Color: EnumValue<VertexElementType, number>

Color encoded in 32-bits (8-bits per channel).

`Static` `Readonly`ColorABGR

ColorABGR: EnumValue<VertexElementType, number>

Color encoded in 32-bits (8-bits per channel) in ABGR order)

`Static` `Readonly`ColorARGB

ColorARGB: EnumValue<VertexElementType, number>

Color encoded in 32-bits (8-bits per channel) in ARGB order)

`Static` `Readonly`Count

Count: EnumValue<VertexElementType, number>

`Static` `Readonly`Float1

Float1: EnumValue<VertexElementType, number>

1D floating point value

`Static` `Readonly`Float2

Float2: EnumValue<VertexElementType, number>

2D floating point value

`Static` `Readonly`Float3

Float3: EnumValue<VertexElementType, number>

3D floating point value

`Static` `Readonly`Float4

Float4: EnumValue<VertexElementType, number>

4D floating point value

`Static` `Readonly`HalfFloat2

HalfFloat2: EnumValue<VertexElementType, number>

2D 16-bit (half) floating point value

`Static` `Readonly`HalfFloat4

HalfFloat4: EnumValue<VertexElementType, number>

4D 16-bit (half) floating point value

`Static` `Readonly`Int1

Int1: EnumValue<VertexElementType, number>

1D 32-bit signed integer value

`Static` `Readonly`Int2

Int2: EnumValue<VertexElementType, number>

2D 32-bit signed integer value

`Static` `Readonly`Int3

Int3: EnumValue<VertexElementType, number>

3D 32-bit signed integer value

`Static` `Readonly`Int4

Int4: EnumValue<VertexElementType, number>

4D 32-bit signed integer value

`Static` `Readonly`Short2

Short2: EnumValue<VertexElementType, number>

2D 16-bit signed integer value

`Static` `Readonly`Short4

Short4: EnumValue<VertexElementType, number>

4D 16-bit signed integer value

`Static` `Readonly`UByte4

UByte4: EnumValue<VertexElementType, number>

4D 8-bit unsigned integer value

`Static` `Readonly`UByte4Norm

UByte4Norm: EnumValue<VertexElementType, number>

4D 8-bit unsigned integer interpreted as a normalized value in [0, 1] range.

`Static` `Readonly`Uint1

Uint1: EnumValue<VertexElementType, number>

1D 32-bit signed integer value

`Static` `Readonly`Uint2

Uint2: EnumValue<VertexElementType, number>

2D 32-bit signed integer value

`Static` `Readonly`Uint3

Uint3: EnumValue<VertexElementType, number>

3D 32-bit signed integer value

`Static` `Readonly`Uint4

Uint4: EnumValue<VertexElementType, number>

4D 32-bit unsigned integer value

`Static` `Readonly`Unknown

Unknown: EnumValue<VertexElementType, number>

`Static` `Readonly`UShort2

UShort2: EnumValue<VertexElementType, number>

2D 16-bit unsigned integer value

`Static` `Readonly`UShort4

UShort4: EnumValue<VertexElementType, number>

4D 16-bit unsigned integer value

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 VertexElementType

Index

Constructors

Values

Methods

Constructors

Protectedconstructor

Parameters

Returns VertexElementType

Values

Static ReadonlyColor

Static ReadonlyColorABGR

Static ReadonlyColorARGB

Static ReadonlyCount

Static ReadonlyFloat1

Static ReadonlyFloat2

Static ReadonlyFloat3

Static ReadonlyFloat4

Static ReadonlyHalfFloat2

Static ReadonlyHalfFloat4

Static ReadonlyInt1

Static ReadonlyInt2

Static ReadonlyInt3

Static ReadonlyInt4

Static ReadonlyShort2

Static ReadonlyShort4

Static ReadonlyUByte4

Static ReadonlyUByte4Norm

Static ReadonlyUint1

Static ReadonlyUint2

Static ReadonlyUint3

Static ReadonlyUint4

Static ReadonlyUnknown

Static ReadonlyUShort2

Static ReadonlyUShort4

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

`Protected`constructor

`Static` `Readonly`Color

`Static` `Readonly`ColorABGR

`Static` `Readonly`ColorARGB

`Static` `Readonly`Count

`Static` `Readonly`Float1

`Static` `Readonly`Float2

`Static` `Readonly`Float3

`Static` `Readonly`Float4

`Static` `Readonly`HalfFloat2

`Static` `Readonly`HalfFloat4

`Static` `Readonly`Int1

`Static` `Readonly`Int2

`Static` `Readonly`Int3

`Static` `Readonly`Int4

`Static` `Readonly`Short2

`Static` `Readonly`Short4

`Static` `Readonly`UByte4

`Static` `Readonly`UByte4Norm

`Static` `Readonly`Uint1

`Static` `Readonly`Uint2

`Static` `Readonly`Uint3

`Static` `Readonly`Uint4

`Static` `Readonly`Unknown

`Static` `Readonly`UShort2

`Static` `Readonly`UShort4

`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