Enumeration PixelFormat

Pixel formats usable by images, textures and render surfaces.

Constructors

`Protected`constructor

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

Values

`Static` `Readonly`BC1

BC1: EnumValue<PixelFormat, number>

DXT1/BC1 format containing opaque RGB. 4 bits per pixel.

`Static` `Readonly`BC2

BC2: EnumValue<PixelFormat, number>

DXT3/BC2 format containing RGB with explicit alpha. 8 bits per pixel.

`Static` `Readonly`BC3

BC3: EnumValue<PixelFormat, number>

DXT5/BC2 format containing RGB with explicit alpha. 8 bits per pixel. Better alpha gradients than BC2.

`Static` `Readonly`BC4

BC4: EnumValue<PixelFormat, number>

One channel compressed format. 4 bits per pixel.

`Static` `Readonly`BC5

BC5: EnumValue<PixelFormat, number>

Two channel compressed format. 8 bits per pixel.

`Static` `Readonly`BC6H

BC6H: EnumValue<PixelFormat, number>

Format storing RGB in half (16-bit) signed floating point format usable for HDR. 8 bits per pixel.

`Static` `Readonly`BC7

BC7: EnumValue<PixelFormat, number>

Format storing RGB with optional alpha channel. Similar to BC1/BC2/BC3 formats but with higher quality and higher decompress overhead. 8 bits per pixel.

`Static` `Readonly`BGR8

BGR8: EnumValue<PixelFormat, number>

8-bit 3-channel pixel format, unsigned normalized.

Note

Most GPUs do not support it and the format will have to be converted to RGBA8. Usage is discouraged.

`Static` `Readonly`BGRA8

BGRA8: EnumValue<PixelFormat, number>

8-bit 4-channel pixel format, unsigned normalized.

`Static` `Readonly`D16

D16: EnumValue<PixelFormat, number>

Depth format, 16bits. Unsigned normalized.

`Static` `Readonly`D24S8

D24S8: EnumValue<PixelFormat, number>

Depth stencil fomrat, 24bit depth + 8bit stencil. Depth stored as unsigned normalized.

`Static` `Readonly`D32

D32: EnumValue<PixelFormat, number>

Depth format, 32bits. Signed float.

`Static` `Readonly`D32_S8X24

D32_S8X24: EnumValue<PixelFormat, number>

Depth stencil format, 32bit depth, 8bit stencil + 24 unused. Depth stored as signed float.

`Static` `Readonly`R16

R16: EnumValue<PixelFormat, number>

16-bit 1-channel pixel format, unsigned normalized.

`Static` `Readonly`R16F

R16F: EnumValue<PixelFormat, number>

16-bit 1-channel pixel format, signed float.

`Static` `Readonly`R16I

R16I: EnumValue<PixelFormat, number>

16-bit 1-channel pixel format, signed integer.

`Static` `Readonly`R16S

R16S: EnumValue<PixelFormat, number>

16-bit 1-channel pixel format, signed normalized.

`Static` `Readonly`R16U

R16U: EnumValue<PixelFormat, number>

16-bit 1-channel pixel format, unsigned integer.

`Static` `Readonly`R32F

R32F: EnumValue<PixelFormat, number>

32-bit 1-channel pixel format, signed float.

`Static` `Readonly`R32I

R32I: EnumValue<PixelFormat, number>

32-bit 1-channel pixel format, signed integer.

`Static` `Readonly`R32U

R32U: EnumValue<PixelFormat, number>

32-bit 1-channel pixel format, unsigned integer.

`Static` `Readonly`R8

R8: EnumValue<PixelFormat, number>

8-bit 1-channel pixel format, unsigned normalized.

`Static` `Readonly`R8I

R8I: EnumValue<PixelFormat, number>

8-bit 1-channel pixel format, signed integer.

`Static` `Readonly`R8S

R8S: EnumValue<PixelFormat, number>

8-bit 1-channel pixel format, signed normalized.

`Static` `Readonly`R8U

R8U: EnumValue<PixelFormat, number>

8-bit 1-channel pixel format, unsigned integer.

`Static` `Readonly`RG11B10F

RG11B10F: EnumValue<PixelFormat, number>

Packed unsigned float format, 11 bits for red, 11 bits for green, 10 bits for blue.

`Static` `Readonly`RG16

RG16: EnumValue<PixelFormat, number>

16-bit 2-channel pixel format, unsigned normalized.

`Static` `Readonly`RG16F

RG16F: EnumValue<PixelFormat, number>

16-bit 2-channel pixel format, signed float.

`Static` `Readonly`RG16I

RG16I: EnumValue<PixelFormat, number>

16-bit 2-channel pixel format, signed integer.

`Static` `Readonly`RG16S

RG16S: EnumValue<PixelFormat, number>

16-bit 2-channel pixel format, signed normalized.

`Static` `Readonly`RG16U

RG16U: EnumValue<PixelFormat, number>

16-bit 2-channel pixel format, unsigned integer.

`Static` `Readonly`RG32F

RG32F: EnumValue<PixelFormat, number>

32-bit 2-channel pixel format, signed float.

`Static` `Readonly`RG32I

RG32I: EnumValue<PixelFormat, number>

32-bit 2-channel pixel format, signed integer.

`Static` `Readonly`RG32U

RG32U: EnumValue<PixelFormat, number>

32-bit 2-channel pixel format, unsigned integer.

`Static` `Readonly`RG8

RG8: EnumValue<PixelFormat, number>

8-bit 2-channel pixel format, unsigned normalized.

`Static` `Readonly`RG8I

RG8I: EnumValue<PixelFormat, number>

8-bit 2-channel pixel format, signed integer.

`Static` `Readonly`RG8S

RG8S: EnumValue<PixelFormat, number>

8-bit 2-channel pixel format, signed normalized.

`Static` `Readonly`RG8U

RG8U: EnumValue<PixelFormat, number>

8-bit 2-channel pixel format, unsigned integer.

`Static` `Readonly`Rgb10a2

Rgb10a2: EnumValue<PixelFormat, number>

Packed unsigned normalized format, 10 bits for red, 10 bits for green, 10 bits for blue, and two bits for alpha.

`Static` `Readonly`RGB16

RGB16: EnumValue<PixelFormat, number>

16-bit 3-channel pixel format, unsigned normalized.

`Static` `Readonly`RGB32F

RGB32F: EnumValue<PixelFormat, number>

32-bit 3-channel pixel format, signed float.

`Static` `Readonly`RGB32I

RGB32I: EnumValue<PixelFormat, number>

32-bit 3-channel pixel format, signed integer.

`Static` `Readonly`RGB32U

RGB32U: EnumValue<PixelFormat, number>

32-bit 3-channel pixel format, unsigned integer.

`Static` `Readonly`RGB8

RGB8: EnumValue<PixelFormat, number>

8-bit 3-channel pixel format, unsigned normalized.

Note

Most GPUs do not support it and the format will have to be converted to RGBA8. Usage is discouraged.

`Static` `Readonly`RGBA16

RGBA16: EnumValue<PixelFormat, number>

16-bit 4-channel pixel format, unsigned normalized.

`Static` `Readonly`RGBA16F

RGBA16F: EnumValue<PixelFormat, number>

16-bit 4-channel pixel format, signed float.

`Static` `Readonly`RGBA16I

RGBA16I: EnumValue<PixelFormat, number>

16-bit 4-channel pixel format, signed integer.

`Static` `Readonly`RGBA16S

RGBA16S: EnumValue<PixelFormat, number>

16-bit 4-channel pixel format, signed normalized.

`Static` `Readonly`RGBA16U

RGBA16U: EnumValue<PixelFormat, number>

16-bit 4-channel pixel format, unsigned integer.

`Static` `Readonly`RGBA32F

RGBA32F: EnumValue<PixelFormat, number>

32-bit 4-channel pixel format, signed float.

`Static` `Readonly`RGBA32I

RGBA32I: EnumValue<PixelFormat, number>

32-bit 4-channel pixel format, signed integer.

`Static` `Readonly`RGBA32U

RGBA32U: EnumValue<PixelFormat, number>

32-bit 4-channel pixel format, unsigned integer.

`Static` `Readonly`RGBA8

RGBA8: EnumValue<PixelFormat, number>

8-bit 4-channel pixel format, unsigned normalized.

`Static` `Readonly`RGBA8I

RGBA8I: EnumValue<PixelFormat, number>

8-bit 4-channel pixel format, signed integer.

`Static` `Readonly`RGBA8S

RGBA8S: EnumValue<PixelFormat, number>

8-bit 4-channel pixel format, signed normalized.

`Static` `Readonly`RGBA8U

RGBA8U: EnumValue<PixelFormat, number>

8-bit 4-channel pixel format, unsigned integer.

`Static` `Readonly`Unknown

Unknown: EnumValue<PixelFormat, number>

Unknown pixel 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 PixelFormat

Index

Constructors

Values

Methods

Constructors

Protectedconstructor

Parameters

Returns PixelFormat

Values

Static ReadonlyBC1

Static ReadonlyBC2

Static ReadonlyBC3

Static ReadonlyBC4

Static ReadonlyBC5

Static ReadonlyBC6H

Static ReadonlyBC7

Static ReadonlyBGR8

Note

Static ReadonlyBGRA8

Static ReadonlyD16

Static ReadonlyD24S8

Static ReadonlyD32

Static ReadonlyD32_S8X24

Static ReadonlyR16

Static ReadonlyR16F

Static ReadonlyR16I

Static ReadonlyR16S

Static ReadonlyR16U

Static ReadonlyR32F

Static ReadonlyR32I

Static ReadonlyR32U

Static ReadonlyR8

Static ReadonlyR8I

Static ReadonlyR8S

Static ReadonlyR8U

Static ReadonlyRG11B10F

Static ReadonlyRG16

Static ReadonlyRG16F

Static ReadonlyRG16I

Static ReadonlyRG16S

Static ReadonlyRG16U

Static ReadonlyRG32F

Static ReadonlyRG32I

Static ReadonlyRG32U

Static ReadonlyRG8

Static ReadonlyRG8I

Static ReadonlyRG8S

Static ReadonlyRG8U

Static ReadonlyRgb10a2

Static ReadonlyRGB16

Static ReadonlyRGB32F

Static ReadonlyRGB32I

Static ReadonlyRGB32U

Static ReadonlyRGB8

Note

Static ReadonlyRGBA16

Static ReadonlyRGBA16F

Static ReadonlyRGBA16I

Static ReadonlyRGBA16S

Static ReadonlyRGBA16U

Static ReadonlyRGBA32F

Static ReadonlyRGBA32I

Static ReadonlyRGBA32U

Static ReadonlyRGBA8

Static ReadonlyRGBA8I

Static ReadonlyRGBA8S

Static ReadonlyRGBA8U

Static ReadonlyUnknown

Methods

StaticaddFlag

Type Parameters

Parameters

Returns K

StaticcombineFlags

Type Parameters

Parameters

Returns EnumValueTyped<T, number>

StaticgetEnumName

Type Parameters

`Protected`constructor

`Static` `Readonly`BC1

`Static` `Readonly`BC2

`Static` `Readonly`BC3

`Static` `Readonly`BC4

`Static` `Readonly`BC5

`Static` `Readonly`BC6H

`Static` `Readonly`BC7

`Static` `Readonly`BGR8

`Static` `Readonly`BGRA8

`Static` `Readonly`D16

`Static` `Readonly`D24S8

`Static` `Readonly`D32

`Static` `Readonly`D32_S8X24

`Static` `Readonly`R16

`Static` `Readonly`R16F

`Static` `Readonly`R16I

`Static` `Readonly`R16S

`Static` `Readonly`R16U

`Static` `Readonly`R32F

`Static` `Readonly`R32I

`Static` `Readonly`R32U

`Static` `Readonly`R8

`Static` `Readonly`R8I

`Static` `Readonly`R8S

`Static` `Readonly`R8U

`Static` `Readonly`RG11B10F

`Static` `Readonly`RG16

`Static` `Readonly`RG16F

`Static` `Readonly`RG16I

`Static` `Readonly`RG16S

`Static` `Readonly`RG16U

`Static` `Readonly`RG32F

`Static` `Readonly`RG32I

`Static` `Readonly`RG32U

`Static` `Readonly`RG8

`Static` `Readonly`RG8I

`Static` `Readonly`RG8S

`Static` `Readonly`RG8U

`Static` `Readonly`Rgb10a2

`Static` `Readonly`RGB16

`Static` `Readonly`RGB32F

`Static` `Readonly`RGB32I

`Static` `Readonly`RGB32U

`Static` `Readonly`RGB8

`Static` `Readonly`RGBA16

`Static` `Readonly`RGBA16F

`Static` `Readonly`RGBA16I

`Static` `Readonly`RGBA16S

`Static` `Readonly`RGBA16U

`Static` `Readonly`RGBA32F

`Static` `Readonly`RGBA32I

`Static` `Readonly`RGBA32U

`Static` `Readonly`RGBA8

`Static` `Readonly`RGBA8I

`Static` `Readonly`RGBA8S

`Static` `Readonly`RGBA8U

`Static` `Readonly`Unknown

`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