Enumeration GPUBufferFormat

Types of valid formats used for standard GPU buffers.

Constructors

`Protected`constructor

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

Values

`Static` `Readonly`Count

Count: EnumValue<GPUBufferFormat, number>

Not a valid format. Keep just before Unknown.

`Static` `Readonly`Float1Bit16

Float1Bit16: EnumValue<GPUBufferFormat, number>

1D 16-bit floating-point format.

`Static` `Readonly`Float1Bit32

Float1Bit32: EnumValue<GPUBufferFormat, number>

1D 32-bit floating-point format.

`Static` `Readonly`Float2Bit16

Float2Bit16: EnumValue<GPUBufferFormat, number>

2D 16-bit floating-point format.

`Static` `Readonly`Float2Bit32

Float2Bit32: EnumValue<GPUBufferFormat, number>

2D 32-bit floating-point format.

`Static` `Readonly`Float3Bit32

Float3Bit32: EnumValue<GPUBufferFormat, number>

3D 32-bit floating-point format.

`Static` `Readonly`Float4Bit16

Float4Bit16: EnumValue<GPUBufferFormat, number>

4D 16-bit floating-point format.

`Static` `Readonly`Float4Bit32

Float4Bit32: EnumValue<GPUBufferFormat, number>

4D 32-bit floating-point format.

`Static` `Readonly`Normalized1Bit16

Normalized1Bit16: EnumValue<GPUBufferFormat, number>

1D 16-bit normalized format.

`Static` `Readonly`Normalized1Bit8

Normalized1Bit8: EnumValue<GPUBufferFormat, number>

1D 8-bit normalized format.

`Static` `Readonly`Normalized2Bit16

Normalized2Bit16: EnumValue<GPUBufferFormat, number>

2D 16-bit normalized format.

`Static` `Readonly`Normalized2Bit8

Normalized2Bit8: EnumValue<GPUBufferFormat, number>

2D 8-bit normalized format.

`Static` `Readonly`Normalized4Bit16

Normalized4Bit16: EnumValue<GPUBufferFormat, number>

4D 16-bit normalized format.

`Static` `Readonly`Normalized4Bit8

Normalized4Bit8: EnumValue<GPUBufferFormat, number>

4D 8-bit normalized format.

`Static` `Readonly`SignedInt1Bit16

SignedInt1Bit16: EnumValue<GPUBufferFormat, number>

1D 16-bit signed integer format.

`Static` `Readonly`SignedInt1Bit32

SignedInt1Bit32: EnumValue<GPUBufferFormat, number>

1D 32-bit signed integer format.

`Static` `Readonly`SignedInt1Bit8

SignedInt1Bit8: EnumValue<GPUBufferFormat, number>

1D 8-bit signed integer format.

`Static` `Readonly`SignedInt2Bit16

SignedInt2Bit16: EnumValue<GPUBufferFormat, number>

2D 16-bit signed integer format.

`Static` `Readonly`SignedInt2Bit32

SignedInt2Bit32: EnumValue<GPUBufferFormat, number>

2D 32-bit signed integer format.

`Static` `Readonly`SignedInt2Bit8

SignedInt2Bit8: EnumValue<GPUBufferFormat, number>

2D 8-bit signed integer format.

`Static` `Readonly`SignedInt3Bit32

SignedInt3Bit32: EnumValue<GPUBufferFormat, number>

3D 32-bit signed integer format.

`Static` `Readonly`SignedInt4Bit16

SignedInt4Bit16: EnumValue<GPUBufferFormat, number>

4D 16-bit signed integer format.

`Static` `Readonly`SignedInt4Bit32

SignedInt4Bit32: EnumValue<GPUBufferFormat, number>

4D 32-bit signed integer format.

`Static` `Readonly`SignedInt4Bit8

SignedInt4Bit8: EnumValue<GPUBufferFormat, number>

4D 8-bit signed integer format.

`Static` `Readonly`Unknown

Unknown: EnumValue<GPUBufferFormat, number>

Unknown format (used for non-standard buffers, like structured or raw.

`Static` `Readonly`UnsignedInt1Bit16

UnsignedInt1Bit16: EnumValue<GPUBufferFormat, number>

1D 16-bit unsigned integer format.

`Static` `Readonly`UnsignedInt1Bit32

UnsignedInt1Bit32: EnumValue<GPUBufferFormat, number>

1D 32-bit unsigned integer format.

`Static` `Readonly`UnsignedInt1Bit8

UnsignedInt1Bit8: EnumValue<GPUBufferFormat, number>

1D 8-bit unsigned integer format.

`Static` `Readonly`UnsignedInt2Bit16

UnsignedInt2Bit16: EnumValue<GPUBufferFormat, number>

2D 16-bit unsigned integer format.

`Static` `Readonly`UnsignedInt2Bit32

UnsignedInt2Bit32: EnumValue<GPUBufferFormat, number>

2D 32-bit unsigned integer format.

`Static` `Readonly`UnsignedInt2Bit8

UnsignedInt2Bit8: EnumValue<GPUBufferFormat, number>

2D 8-bit unsigned integer format.

`Static` `Readonly`UnsignedInt3Bit32

UnsignedInt3Bit32: EnumValue<GPUBufferFormat, number>

3D 32-bit unsigned integer format.

`Static` `Readonly`UnsignedInt4Bit16

UnsignedInt4Bit16: EnumValue<GPUBufferFormat, number>

4D 16-bit unsigned integer format.

`Static` `Readonly`UnsignedInt4Bit32

UnsignedInt4Bit32: EnumValue<GPUBufferFormat, number>

4D 32-bit unsigned integer format.

`Static` `Readonly`UnsignedInt4Bit8

UnsignedInt4Bit8: EnumValue<GPUBufferFormat, number>

4D 8-bit unsigned integer format.

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 GPUBufferFormat

Index

Constructors

Values

Methods

Constructors

Protectedconstructor

Parameters

Returns GPUBufferFormat

Values

Static ReadonlyCount

Static ReadonlyFloat1Bit16

Static ReadonlyFloat1Bit32

Static ReadonlyFloat2Bit16

Static ReadonlyFloat2Bit32

Static ReadonlyFloat3Bit32

Static ReadonlyFloat4Bit16

Static ReadonlyFloat4Bit32

Static ReadonlyNormalized1Bit16

Static ReadonlyNormalized1Bit8

Static ReadonlyNormalized2Bit16

Static ReadonlyNormalized2Bit8

Static ReadonlyNormalized4Bit16

Static ReadonlyNormalized4Bit8

Static ReadonlySignedInt1Bit16

Static ReadonlySignedInt1Bit32

Static ReadonlySignedInt1Bit8

Static ReadonlySignedInt2Bit16

Static ReadonlySignedInt2Bit32

Static ReadonlySignedInt2Bit8

Static ReadonlySignedInt3Bit32

Static ReadonlySignedInt4Bit16

Static ReadonlySignedInt4Bit32

Static ReadonlySignedInt4Bit8

Static ReadonlyUnknown

Static ReadonlyUnsignedInt1Bit16

Static ReadonlyUnsignedInt1Bit32

Static ReadonlyUnsignedInt1Bit8

Static ReadonlyUnsignedInt2Bit16

Static ReadonlyUnsignedInt2Bit32

Static ReadonlyUnsignedInt2Bit8

Static ReadonlyUnsignedInt3Bit32

Static ReadonlyUnsignedInt4Bit16

Static ReadonlyUnsignedInt4Bit32

Static ReadonlyUnsignedInt4Bit8

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

`Protected`constructor

`Static` `Readonly`Count

`Static` `Readonly`Float1Bit16

`Static` `Readonly`Float1Bit32

`Static` `Readonly`Float2Bit16

`Static` `Readonly`Float2Bit32

`Static` `Readonly`Float3Bit32

`Static` `Readonly`Float4Bit16

`Static` `Readonly`Float4Bit32

`Static` `Readonly`Normalized1Bit16

`Static` `Readonly`Normalized1Bit8

`Static` `Readonly`Normalized2Bit16

`Static` `Readonly`Normalized2Bit8

`Static` `Readonly`Normalized4Bit16

`Static` `Readonly`Normalized4Bit8

`Static` `Readonly`SignedInt1Bit16

`Static` `Readonly`SignedInt1Bit32

`Static` `Readonly`SignedInt1Bit8

`Static` `Readonly`SignedInt2Bit16

`Static` `Readonly`SignedInt2Bit32

`Static` `Readonly`SignedInt2Bit8

`Static` `Readonly`SignedInt3Bit32

`Static` `Readonly`SignedInt4Bit16

`Static` `Readonly`SignedInt4Bit32

`Static` `Readonly`SignedInt4Bit8

`Static` `Readonly`Unknown

`Static` `Readonly`UnsignedInt1Bit16

`Static` `Readonly`UnsignedInt1Bit32

`Static` `Readonly`UnsignedInt1Bit8

`Static` `Readonly`UnsignedInt2Bit16

`Static` `Readonly`UnsignedInt2Bit32

`Static` `Readonly`UnsignedInt2Bit8

`Static` `Readonly`UnsignedInt3Bit32

`Static` `Readonly`UnsignedInt4Bit16

`Static` `Readonly`UnsignedInt4Bit32

`Static` `Readonly`UnsignedInt4Bit8

`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