Enumeration PixelFormat

Pixel formats usable by images, textures and render surfaces.

Constructors

constructor

Values

BC1 BC2 BC3 BC4 BC5 BC6H BC7 BGR8 BGRA8 D16 D24S8 D32 D32_S8X24 R16 R16F R16I R16S R16U R32F R32I R32U R8 R8I R8S R8U RG11B10F RG16 RG16F RG16I RG16S RG16U RG32F RG32I RG32U RG8 RG8I RG8S RG8U Rgb10a2 RGB16 RGB32F RGB32I RGB32U RGB8 RGBA16 RGBA16F RGBA16I RGBA16S RGBA16U RGBA32F RGBA32I RGBA32U RGBA8 RGBA8I RGBA8S RGBA8U Unknown

Methods

addFlag combineFlags getEnumName getEnumNames getEnumValue getEnumValues getNameForValue getNames getValueAtIndex getValues hasFlag hasFlagChanged iterateNames iterateValues removeFlag splitFlags

Constructors

Protectedconstructor

  • new PixelFormat(do_not_, construct_, this_, type_): PixelFormat

  • Parameters

    • do_not_: undefined
    • construct_: undefined
    • this_: undefined
    • type_: undefined

    Returns PixelFormat

Values

Static ReadonlyBC1

BC1 = 13

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

Static ReadonlyBC2

BC2 = 15

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

Static ReadonlyBC3

BC3 = 16

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

Static ReadonlyBC4

BC4 = 17

One channel compressed format. 4 bits per pixel.

Static ReadonlyBC5

BC5 = 18

Two channel compressed format. 8 bits per pixel.

Static ReadonlyBC6H

BC6H = 19

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

Static ReadonlyBC7

BC7 = 20

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 ReadonlyBGR8

BGR8 = 4

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 ReadonlyBGRA8

BGRA8 = 7

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

Static ReadonlyD16

D16 = 32

Depth format, 16bits. Unsigned normalized.

Static ReadonlyD24S8

D24S8 = 30

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

Static ReadonlyD32

D32 = 31

Depth format, 32bits. Signed float.

Static ReadonlyD32_S8X24

D32_S8X24 = 29

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

Static ReadonlyR16

R16 = 61

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

Static ReadonlyR16F

R16F = 21

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

Static ReadonlyR16I

R16I = 44

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

Static ReadonlyR16S

R16S = 58

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

Static ReadonlyR16U

R16U = 47

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

Static ReadonlyR32F

R32F = 25

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

Static ReadonlyR32I

R32I = 50

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

Static ReadonlyR32U

R32U = 54

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

Static ReadonlyR8

R8 = 1

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

Static ReadonlyR8I

R8I = 35

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

Static ReadonlyR8S

R8S = 41

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

Static ReadonlyR8U

R8U = 38

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

Static ReadonlyRG11B10F

RG11B10F = 33

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

Static ReadonlyRG16

RG16 = 62

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

Static ReadonlyRG16F

RG16F = 22

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

Static ReadonlyRG16I

RG16I = 45

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

Static ReadonlyRG16S

RG16S = 59

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

Static ReadonlyRG16U

RG16U = 48

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

Static ReadonlyRG32F

RG32F = 26

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

Static ReadonlyRG32I

RG32I = 51

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

Static ReadonlyRG32U

RG32U = 55

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

Static ReadonlyRG8

RG8 = 2

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

Static ReadonlyRG8I

RG8I = 36

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

Static ReadonlyRG8S

RG8S = 42

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

Static ReadonlyRG8U

RG8U = 39

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

Static ReadonlyRgb10a2

Rgb10a2 = 34

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

Static ReadonlyRGB16

RGB16 = 63

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

Static ReadonlyRGB32F

RGB32F = 27

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

Static ReadonlyRGB32I

RGB32I = 52

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

Static ReadonlyRGB32U

RGB32U = 56

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

Static ReadonlyRGB8

RGB8 = 3

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 ReadonlyRGBA16

RGBA16 = 64

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

Static ReadonlyRGBA16F

RGBA16F = 24

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

Static ReadonlyRGBA16I

RGBA16I = 46

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

Static ReadonlyRGBA16S

RGBA16S = 60

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

Static ReadonlyRGBA16U

RGBA16U = 49

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

Static ReadonlyRGBA32F

RGBA32F = 28

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

Static ReadonlyRGBA32I

RGBA32I = 53

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

Static ReadonlyRGBA32U

RGBA32U = 57

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

Static ReadonlyRGBA8

RGBA8 = 8

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

Static ReadonlyRGBA8I

RGBA8I = 37

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

Static ReadonlyRGBA8S

RGBA8S = 43

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

Static ReadonlyRGBA8U

RGBA8U = 40

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

Static ReadonlyUnknown

Unknown = 0

Unknown pixel format.

Methods

StaticaddFlag

StaticcombineFlags

  • 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

    Parameters

    Returns EnumValueTyped<T, number>

    The combined enum value.

StaticgetEnumName

  • getEnumName<T>(index): string

  • Type Parameters

    • T

    Parameters

    Returns string

    Obsolete

    Compatibility

StaticgetEnumNames

  • getEnumNames(): string[]

  • Returns string[]

    Obsolete

    Compatibility

StaticgetEnumValue

  • getEnumValue(index): number

  • Parameters

    • index: number

    Returns number

    Obsolete

    Compatibility

StaticgetEnumValues

  • getEnumValues(): number[]

  • Returns number[]

    Obsolete

    Compatibility

StaticgetNameForValue

  • getNameForValue<T>(enumValue): string

  • Gets the name for the enumeration value that matches the specified enumValue.

    Type Parameters

    • T

    Parameters

    Returns string

    The enumeration value or undefined if not found.

StaticgetNames

  • getNames(): string[]

  • Gets the enumeration names

    Returns string[]

    The enumeration names.

StaticgetValueAtIndex

  • 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.

StaticgetValues

StatichasFlag

  • hasFlag<T, K>(value, bits): boolean

  • Determines if the enum value has the flags set.

    Type Parameters

    Parameters

    Returns boolean

StatichasFlagChanged

  • hasFlagChanged<T, K>(previousValue, newValue, bits): boolean

  • Determines if the enum bits were changed from previousValue to currentValue.

    Type Parameters

    Parameters

    Returns boolean

StaticiterateNames

  • iterateNames(): Generator<string, any, any>

  • Iterates the enumeration names

    Returns Generator<string, any, any>

    The enumeration names.

StaticiterateValues

  • 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.

StaticremoveFlag

StaticsplitFlags

  • 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

    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.

Settings

Member Visibility

On This Page

Constructors
Values
Methods