Zen API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kPixelFormat Struct Reference

Description

Pixel format descriptor.

kPixelFormat supports the kdat6 serialization protocol. Values reflect Pixel Format Naming Convention (like GvPixelFormat.h and PFNC.h).

Inheritance diagram for kPixelFormat:
Inheritance graph

Public Member Functions

kSize kPixelFormat_AllocSize (kPixelFormat format, kSize width, kSize height)
 Returns size in bytes when buffer is situated in CPU/GPU memory. More...
 
kStatus kPixelFormat_Description (kPixelFormat format, kChar *text, kSize capacity)
 Formats the pixel format descriptions as a string. More...
 
kStatus kPixelFormat_Name (kPixelFormat format, kChar *text, kSize capacity)
 Formats the pixel format name as a string. More...
 
kSize kPixelFormat_PixelBits (kPixelFormat format)
 Returns number of bits per pixel, e.g. More...
 
kSize kPixelFormat_Size (kPixelFormat format, kSize width, kSize height)
 Returns size in bytes, when data is serialized. More...
 
kSize kPixelFormat_Stride (kPixelFormat format, kSize width)
 Returns stride in bytes from width (in pixels). More...
 
kSize kPixelFormat_Width (kPixelFormat format, kSize stride)
 Returns width in pixels from stride (in bytes). More...
 
- Public Member Functions inherited from kValue
kBool kValue_Equals (kType type, const void *value, const void *other)
 Determines whether a value is equal to another value. More...
 
kSize kValue_HashCode (kType type, const void *value)
 Gets a hash code representing the state of this value. More...
 
void kValue_Import (kType type, void *value, const void *source)
 Imports the content of another value into this value. More...
 

Related

#define kPIXEL_FORMAT_MONO1p
 Monochrome, 1-bit.
 
#define kPIXEL_FORMAT_MONO2p
 Monochrome, 2-bit.
 
#define kPIXEL_FORMAT_MONO4p
 Monochrome, 4-bit.
 
#define kPIXEL_FORMAT_MONO8
 Monochrome, 8-bit.
 
#define kPIXEL_FORMAT_MONO10
 Monochrome, 10-bit.
 
#define kPIXEL_FORMAT_MONO10p
 Monochrome, 10-bit packed.
 
#define kPIXEL_FORMAT_MONO12
 Monochrome, 12-bit.
 
#define kPIXEL_FORMAT_MONO12p
 Monochrome, 12-bit packed.
 
#define kPIXEL_FORMAT_MONO14
 Monochrome, 14 bit.
 
#define kPIXEL_FORMAT_MONO14p
 Monochrome, 14 bit packed.
 
#define kPIXEL_FORMAT_MONO16
 Monochrome, 16 bit.
 
#define kPIXEL_FORMAT_MONO32
 Monochrome, 32 bit.
 
#define kPIXEL_FORMAT_DATA8
 Data, 8-bit.
 
#define kPIXEL_FORMAT_DATA8s
 Data, 8-bit signed.
 
#define kPIXEL_FORMAT_DATA16
 Data, 16-bit.
 
#define kPIXEL_FORMAT_DATA16s
 Data, 16-bit signed.
 
#define kPIXEL_FORMAT_DATA32
 Data, 32-bit.
 
#define kPIXEL_FORMAT_DATA32s
 Data, 32-bit signed.
 
#define kPIXEL_FORMAT_DATA64
 Data, 64-bit.
 
#define kPIXEL_FORMAT_DATA64s
 Data, 64-bit signed.
 
#define kPIXEL_FORMAT_DATA32f
 Data, 32-bit floating point.
 
#define kPIXEL_FORMAT_DATA64f
 Data, 64-bit floating point.
 
#define kPIXEL_FORMAT_BAYER_BG8
 Bayer, Blue-Green 8-bit.
 
#define kPIXEL_FORMAT_BAYER_BG10
 Bayer, Blue-Green 10-bit unpacked.
 
#define kPIXEL_FORMAT_BAYER_BG10p
 Bayer, Blue-Green 10-bit packed.
 
#define kPIXEL_FORMAT_BAYER_BG12
 Bayer, Blue-Green 12-bit unpacked.
 
#define kPIXEL_FORMAT_BAYER_BG12p
 Bayer, Blue-Green 12-bit packed.
 
#define kPIXEL_FORMAT_BAYER_BG16
 Bayer, Blue-Green 16-bit.
 
#define kPIXEL_FORMAT_BAYER_GB8
 Bayer, Green-Blue 8-bit.
 
#define kPIXEL_FORMAT_BAYER_GB10
 Bayer, Green-Blue 10-bit unpacked.
 
#define kPIXEL_FORMAT_BAYER_GB10p
 Bayer, Green-Blue 10-bit packed.
 
#define kPIXEL_FORMAT_BAYER_GB12
 Bayer, Green-Blue 12-bit unpacked.
 
#define kPIXEL_FORMAT_BAYER_GB12p
 Bayer, Green-Blue 12-bit packed.
 
#define kPIXEL_FORMAT_BAYER_GB16
 Bayer, Green-Blue 16-bit.
 
#define kPIXEL_FORMAT_BAYER_GR8
 Bayer, Green-Red 8-bit.
 
#define kPIXEL_FORMAT_BAYER_GR10
 Bayer, Green-Red 10-bit unpacked.
 
#define kPIXEL_FORMAT_BAYER_GR10p
 Bayer, Green-Red 10-bit packed.
 
#define kPIXEL_FORMAT_BAYER_GR12
 Bayer, Green-Red 12-bit unpacked.
 
#define kPIXEL_FORMAT_BAYER_GR12p
 Bayer, Green-Red 12-bit packed.
 
#define kPIXEL_FORMAT_BAYER_GR16
 Bayer, Green-Red 16-bit.
 
#define kPIXEL_FORMAT_BAYER_RG8
 Bayer, Red-Green 8-bit.
 
#define kPIXEL_FORMAT_BAYER_RG10
 Bayer, Red-Green 10-bit unpacked.
 
#define kPIXEL_FORMAT_BAYER_RG10p
 Bayer, Red-Green 10-bit packed.
 
#define kPIXEL_FORMAT_BAYER_RG12
 Bayer, Red-Green 12-bit unpacked.
 
#define kPIXEL_FORMAT_BAYER_RG12p
 Bayer, Red-Green 12-bit packed.
 
#define kPIXEL_FORMAT_BAYER_RG16
 Bayer, Red-Green 16-bit.
 
#define kPIXEL_FORMAT_RGBa8
 RGBA, 8-bit.
 
#define kPIXEL_FORMAT_RGBa10
 RGBA, 10-bit.
 
#define kPIXEL_FORMAT_RGBa12
 RGBA, 12-bit.
 
#define kPIXEL_FORMAT_RGBa14
 RGBA, 14-bit.
 
#define kPIXEL_FORMAT_RGBa16
 RGBA, 16-bit.
 
#define kPIXEL_FORMAT_RGB8
 RGB, 8-bit.
 
#define kPIXEL_FORMAT_RGB10
 RGB, 10-bit.
 
#define kPIXEL_FORMAT_RGB12
 RGB, 12-bit.
 
#define kPIXEL_FORMAT_RGB14
 RGB, 14-bit.
 
#define kPIXEL_FORMAT_RGB16
 RGB, 16-bit.
 
#define kPIXEL_FORMAT_BGRa8
 BGRA, 8-bit.
 
#define kPIXEL_FORMAT_BGRa10
 BGRA, 10-bit.
 
#define kPIXEL_FORMAT_BGRa12
 BGRA, 12-bit.
 
#define kPIXEL_FORMAT_BGRa14
 BGRA, 14-bit.
 
#define kPIXEL_FORMAT_BGRa16
 BGRA, 16-bit.
 
#define kPIXEL_FORMAT_BGR8
 BGR, 8-bit.
 
#define kPIXEL_FORMAT_BGR10
 BGR, 10-bit.
 
#define kPIXEL_FORMAT_BGR12
 BGR, 12-bit.
 
#define kPIXEL_FORMAT_BGR14
 BGR, 14-bit.
 
#define kPIXEL_FORMAT_BGR16
 BGR, 16-bit.
 

Additional Inherited Members

- Protected Member Functions inherited from kValue
kBool kValue_VEquals (kType type, const void *value, const void *other)
 Protected virtual method that compares two values for equality. More...
 
kSize kValue_VHashCode (kType type, const void *value)
 Protected virtual method that calculates a hash code representing the value instance. More...
 
void kValue_VImport (kType type, void *value, const void *source)
 Protected virtual method that imports data from an external source into an array-value type. More...
 

The documentation for this struct was generated from the following file: