Stride

OPEN / CLOSE
  • Features
  • Blog
  • Documentation
  • Community
(icon) Download

  • Discord
  • Facebook
  • Twitter
  • YouTube

LANGUAGE

OPEN / CLOSE
  • English
  • 日本語
    Show / Hide Table of Contents

    PixelFormat Enum

    Namespace: Stride.Graphics
    Assembly: Stride.dll

    Defines various types of pixel formats.

    [DataContract]
    public enum PixelFormat

    Fields

    Name Description
    A8_UNorm

    A single-component, 8-bit unsigned-normalized-integer format for alpha only.

    B5G5R5A1_UNorm

    A four-component, 16-bit unsigned-normalized-integer format that supports 5 bits for each color channel and 1-bit alpha.

    B5G6R5_UNorm

    A three-component, 16-bit unsigned-normalized-integer format that supports 5 bits for blue, 6 bits for green, and 5 bits for red.

    B8G8R8A8_Typeless

    A four-component, 32-bit typeless format that supports 8 bits for each channel including alpha. 4

    B8G8R8A8_UNorm

    A four-component, 32-bit unsigned-normalized-integer format that supports 8 bits for each color channel and 8-bit alpha.

    B8G8R8A8_UNorm_SRgb

    A four-component, 32-bit unsigned-normalized standard RGB format that supports 8 bits for each channel including alpha. 4

    B8G8R8X8_Typeless

    A four-component, 32-bit typeless format that supports 8 bits for each color channel, and 8 bits are unused. 4

    B8G8R8X8_UNorm

    A four-component, 32-bit unsigned-normalized-integer format that supports 8 bits for each color channel and 8 bits unused.

    B8G8R8X8_UNorm_SRgb

    A four-component, 32-bit unsigned-normalized standard RGB format that supports 8 bits for each color channel, and 8 bits are unused. 4

    BC1_Typeless

    Four-component typeless block-compression format. For information about block-compression formats, see Texture Block Compression in Direct3D 11.

    BC1_UNorm

    Four-component block-compression format. For information about block-compression formats, see Texture Block Compression in Direct3D 11.

    BC1_UNorm_SRgb

    Four-component block-compression format for sRGB data. For information about block-compression formats, see Texture Block Compression in Direct3D 11.

    BC2_Typeless

    Four-component typeless block-compression format. For information about block-compression formats, see Texture Block Compression in Direct3D 11.

    BC2_UNorm

    Four-component block-compression format. For information about block-compression formats, see Texture Block Compression in Direct3D 11.

    BC2_UNorm_SRgb

    Four-component block-compression format for sRGB data. For information about block-compression formats, see Texture Block Compression in Direct3D 11.

    BC3_Typeless

    Four-component typeless block-compression format. For information about block-compression formats, see Texture Block Compression in Direct3D 11.

    BC3_UNorm

    Four-component block-compression format. For information about block-compression formats, see Texture Block Compression in Direct3D 11.

    BC3_UNorm_SRgb

    Four-component block-compression format for sRGB data. For information about block-compression formats, see Texture Block Compression in Direct3D 11.

    BC4_SNorm

    One-component block-compression format. For information about block-compression formats, see Texture Block Compression in Direct3D 11.

    BC4_Typeless

    One-component typeless block-compression format. For information about block-compression formats, see Texture Block Compression in Direct3D 11.

    BC4_UNorm

    One-component block-compression format. For information about block-compression formats, see Texture Block Compression in Direct3D 11.

    BC5_SNorm

    Two-component block-compression format. For information about block-compression formats, see Texture Block Compression in Direct3D 11.

    BC5_Typeless

    Two-component typeless block-compression format. For information about block-compression formats, see Texture Block Compression in Direct3D 11.

    BC5_UNorm

    Two-component block-compression format. For information about block-compression formats, see Texture Block Compression in Direct3D 11.

    BC6H_Sf16

    A block-compression format. 4 For information about block-compression formats, see Texture Block Compression in Direct3D 11.

    BC6H_Typeless

    A typeless block-compression format. 4 For information about block-compression formats, see Texture Block Compression in Direct3D 11.

    BC6H_Uf16

    A block-compression format. 4 For information about block-compression formats, see Texture Block Compression in Direct3D 11.

    BC7_Typeless

    A typeless block-compression format. 4 For information about block-compression formats, see Texture Block Compression in Direct3D 11.

    BC7_UNorm

    A block-compression format. 4 For information about block-compression formats, see Texture Block Compression in Direct3D 11.

    BC7_UNorm_SRgb

    A block-compression format. 4 For information about block-compression formats, see Texture Block Compression in Direct3D 11.

    D16_UNorm

    A single-component, 16-bit unsigned-normalized-integer format that supports 16 bits for depth.

    D24_UNorm_S8_UInt

    A 32-bit z-buffer format that supports 24 bits for depth and 8 bits for stencil.

    D32_Float

    A single-component, 32-bit floating-point format that supports 32 bits for depth.

    D32_Float_S8X24_UInt

    A 32-bit floating-point component, and two unsigned-integer components (with an additional 32 bits). This format supports 32-bit depth, 8-bit stencil, and 24 bits are unused.

    EAC_R11_Signed
    EAC_R11_Unsigned
    EAC_RG11_Signed
    EAC_RG11_Unsigned
    ETC1
    ETC2_RGB
    ETC2_RGB_A1
    ETC2_RGB_SRgb
    ETC2_RGBA
    ETC2_RGBA_SRgb
    G8R8_G8B8_UNorm

    A four-component, 32-bit unsigned-normalized-integer format. This packed RGB format is analogous to the YUY2 format. Each 32-bit block describes a pair of pixels: (R8, G8, B8) and (R8, G8, B8) where the R8/B8 values are repeated, and the G8 values are unique to each pixel. 3

    None

    The format is not known.

    R1_UNorm

    A single-component, 1-bit unsigned-normalized integer format that supports 1 bit for the red channel. 2.

    R10G10B10_Xr_Bias_A2_UNorm

    A four-component, 32-bit 2.8-biased fixed-point format that supports 10 bits for each color channel and 2-bit alpha.

    R10G10B10A2_Typeless

    A four-component, 32-bit typeless format that supports 10 bits for each color and 2 bits for alpha.

    R10G10B10A2_UInt

    A four-component, 32-bit unsigned-integer format that supports 10 bits for each color and 2 bits for alpha.

    R10G10B10A2_UNorm

    A four-component, 32-bit unsigned-normalized-integer format that supports 10 bits for each color and 2 bits for alpha.

    R11G11B10_Float

    Three partial-precision floating-point numbers encoded into a single 32-bit value (a variant of s10e5, which is sign bit, 10-bit mantissa, and 5-bit biased (15) exponent). There are no sign bits, and there is a 5-bit biased (15) exponent for each channel, 6-bit mantissa for R and G, and a 5-bit mantissa for B, as shown in the following illustration.

    R16_Float

    A single-component, 16-bit floating-point format that supports 16 bits for the red channel.

    R16_SInt

    A single-component, 16-bit signed-integer format that supports 16 bits for the red channel.

    R16_SNorm

    A single-component, 16-bit signed-normalized-integer format that supports 16 bits for the red channel.

    R16_Typeless

    A single-component, 16-bit typeless format that supports 16 bits for the red channel.

    R16_UInt

    A single-component, 16-bit unsigned-integer format that supports 16 bits for the red channel.

    R16_UNorm

    A single-component, 16-bit unsigned-normalized-integer format that supports 16 bits for the red channel.

    R16G16_Float

    A two-component, 32-bit floating-point format that supports 16 bits for the red channel and 16 bits for the green channel.

    R16G16_SInt

    A two-component, 32-bit signed-integer format that supports 16 bits for the red channel and 16 bits for the green channel.

    R16G16_SNorm

    A two-component, 32-bit signed-normalized-integer format that supports 16 bits for the red channel and 16 bits for the green channel.

    R16G16_Typeless

    A two-component, 32-bit typeless format that supports 16 bits for the red channel and 16 bits for the green channel.

    R16G16_UInt

    A two-component, 32-bit unsigned-integer format that supports 16 bits for the red channel and 16 bits for the green channel.

    R16G16_UNorm

    A two-component, 32-bit unsigned-normalized-integer format that supports 16 bits each for the green and red channels.

    R16G16B16A16_Float

    A four-component, 64-bit floating-point format that supports 16 bits per channel including alpha.

    R16G16B16A16_SInt

    A four-component, 64-bit signed-integer format that supports 16 bits per channel including alpha.

    R16G16B16A16_SNorm

    A four-component, 64-bit signed-normalized-integer format that supports 16 bits per channel including alpha.

    R16G16B16A16_Typeless

    A four-component, 64-bit typeless format that supports 16 bits per channel including alpha.

    R16G16B16A16_UInt

    A four-component, 64-bit unsigned-integer format that supports 16 bits per channel including alpha.

    R16G16B16A16_UNorm

    A four-component, 64-bit unsigned-normalized-integer format that supports 16 bits per channel including alpha.

    R24_UNorm_X8_Typeless

    A 32-bit format, that contains a 24 bit, single-component, unsigned-normalized integer, with an additional typeless 8 bits. This format has 24 bits red channel and 8 bits unused.

    R24G8_Typeless

    A two-component, 32-bit typeless format that supports 24 bits for the red channel and 8 bits for the green channel.

    R32_Float

    A single-component, 32-bit floating-point format that supports 32 bits for the red channel.

    R32_Float_X8X24_Typeless

    A 32-bit floating-point component, and two typeless components (with an additional 32 bits). This format supports 32-bit red channel, 8 bits are unused, and 24 bits are unused.

    R32_SInt

    A single-component, 32-bit signed-integer format that supports 32 bits for the red channel.

    R32_Typeless

    A single-component, 32-bit typeless format that supports 32 bits for the red channel.

    R32_UInt

    A single-component, 32-bit unsigned-integer format that supports 32 bits for the red channel.

    R32G32_Float

    A two-component, 64-bit floating-point format that supports 32 bits for the red channel and 32 bits for the green channel.

    R32G32_SInt

    A two-component, 64-bit signed-integer format that supports 32 bits for the red channel and 32 bits for the green channel.

    R32G32_Typeless

    A two-component, 64-bit typeless format that supports 32 bits for the red channel and 32 bits for the green channel.

    R32G32_UInt

    A two-component, 64-bit unsigned-integer format that supports 32 bits for the red channel and 32 bits for the green channel.

    R32G32B32_Float

    A three-component, 96-bit floating-point format that supports 32 bits per color channel.

    R32G32B32_SInt

    A three-component, 96-bit signed-integer format that supports 32 bits per color channel.

    R32G32B32_Typeless

    A three-component, 96-bit typeless format that supports 32 bits per color channel.

    R32G32B32_UInt

    A three-component, 96-bit unsigned-integer format that supports 32 bits per color channel.

    R32G32B32A32_Float

    A four-component, 128-bit floating-point format that supports 32 bits per channel including alpha. 1

    R32G32B32A32_SInt

    A four-component, 128-bit signed-integer format that supports 32 bits per channel including alpha. 1

    R32G32B32A32_Typeless

    A four-component, 128-bit typeless format that supports 32 bits per channel including alpha. 1

    R32G32B32A32_UInt

    A four-component, 128-bit unsigned-integer format that supports 32 bits per channel including alpha. 1

    R32G8X24_Typeless

    A two-component, 64-bit typeless format that supports 32 bits for the red channel, 8 bits for the green channel, and 24 bits are unused.

    R8_SInt

    A single-component, 8-bit signed-integer format that supports 8 bits for the red channel.

    R8_SNorm

    A single-component, 8-bit signed-normalized-integer format that supports 8 bits for the red channel.

    R8_Typeless

    A single-component, 8-bit typeless format that supports 8 bits for the red channel.

    R8_UInt

    A single-component, 8-bit unsigned-integer format that supports 8 bits for the red channel.

    R8_UNorm

    A single-component, 8-bit unsigned-normalized-integer format that supports 8 bits for the red channel.

    R8G8_B8G8_UNorm

    A four-component, 32-bit unsigned-normalized-integer format. This packed RGB format is analogous to the UYVY format. Each 32-bit block describes a pair of pixels: (R8, G8, B8) and (R8, G8, B8) where the R8/B8 values are repeated, and the G8 values are unique to each pixel. 3

    R8G8_SInt

    A two-component, 16-bit signed-integer format that supports 8 bits for the red channel and 8 bits for the green channel.

    R8G8_SNorm

    A two-component, 16-bit signed-normalized-integer format that supports 8 bits for the red channel and 8 bits for the green channel.

    R8G8_Typeless

    A two-component, 16-bit typeless format that supports 8 bits for the red channel and 8 bits for the green channel.

    R8G8_UInt

    A two-component, 16-bit unsigned-integer format that supports 8 bits for the red channel and 8 bits for the green channel.

    R8G8_UNorm

    A two-component, 16-bit unsigned-normalized-integer format that supports 8 bits for the red channel and 8 bits for the green channel.

    R8G8B8A8_SInt

    A four-component, 32-bit signed-integer format that supports 8 bits per channel including alpha.

    R8G8B8A8_SNorm

    A four-component, 32-bit signed-normalized-integer format that supports 8 bits per channel including alpha.

    R8G8B8A8_Typeless

    A four-component, 32-bit typeless format that supports 8 bits per channel including alpha.

    R8G8B8A8_UInt

    A four-component, 32-bit unsigned-integer format that supports 8 bits per channel including alpha.

    R8G8B8A8_UNorm

    A four-component, 32-bit unsigned-normalized-integer format that supports 8 bits per channel including alpha.

    R8G8B8A8_UNorm_SRgb

    A four-component, 32-bit unsigned-normalized integer sRGB format that supports 8 bits per channel including alpha.

    R9G9B9E5_Sharedexp

    Three partial-precision floating-point numbers encoded into a single 32-bit value all sharing the same 5-bit exponent (variant of s10e5, which is sign bit, 10-bit mantissa, and 5-bit biased (15) exponent). There is no sign bit, and there is a shared 5-bit biased (15) exponent and a 9-bit mantissa for each channel, as shown in the following illustration. 2.

    X24_Typeless_G8_UInt

    A 32-bit format, that contains a 24 bit, single-component, typeless format, with an additional 8 bit unsigned integer component. This format has 24 bits unused and 8 bits green channel.

    X32_Typeless_G8X24_UInt

    A 32-bit typeless component, and two unsigned-integer components (with an additional 32 bits). This format has 32 bits unused, 8 bits for green channel, and 24 bits are unused.

    Extension Methods

    ComponentBaseExtensions.DisposeBy<PixelFormat>(ICollectorHolder)
    ComponentBaseExtensions.RemoveDisposeBy<PixelFormat>(ICollectorHolder)
    PixelFormatExtensions.BlockSize()
    PixelFormatExtensions.BlockWidth()
    PixelFormatExtensions.BlockHeight()
    PixelFormatExtensions.SizeInBytes()
    PixelFormatExtensions.SizeInBits()
    PixelFormatExtensions.AlphaSizeInBits()
    PixelFormatExtensions.IsValid()
    PixelFormatExtensions.IsCompressed()
    PixelFormatExtensions.HasAlpha32Bits()
    PixelFormatExtensions.HasAlpha()
    PixelFormatExtensions.IsPacked()
    PixelFormatExtensions.IsVideo()
    PixelFormatExtensions.IsSRgb()
    PixelFormatExtensions.IsHDR()
    PixelFormatExtensions.IsTypeless()
    PixelFormatExtensions.ComputePitch(Int32, Int32, Int32, Int32)
    PixelFormatExtensions.HasSRgbEquivalent()
    PixelFormatExtensions.HasNonSRgbEquivalent()
    PixelFormatExtensions.ToSRgb()
    PixelFormatExtensions.ToNonSRgb()
    PixelFormatExtensions.IsRGBAOrder()
    PixelFormatExtensions.IsBGRAOrder()
    • Improve this Doc
    • View Source
    In This Article

    Back to top

    Copyright © 2019-2021 .NET Foundation and Contributors
    Supported by the .NET Foundation