APEX Framework: nvidia::apex::RenderDataFormat Struct Reference

NVIDIA APEX

nvidia::apex::RenderDataFormat Struct Reference

Enumeration of possible formats of various buffer semantics. More...

#include <RenderDataFormat.h>

List of all members.

Public Types

enum  Enum {
  UNSPECIFIED = 0,
  UBYTE1 = 1,
  UBYTE2 = 2,
  UBYTE3 = 3,
  UBYTE4 = 4,
  USHORT1 = 5,
  USHORT2 = 6,
  USHORT3 = 7,
  USHORT4 = 8,
  SHORT1 = 9,
  SHORT2 = 10,
  SHORT3 = 11,
  SHORT4 = 12,
  UINT1 = 13,
  UINT2 = 14,
  UINT3 = 15,
  UINT4 = 16,
  R8G8B8A8 = 17,
  B8G8R8A8 = 18,
  R32G32B32A32_FLOAT = 19,
  B32G32R32A32_FLOAT = 20,
  BYTE_UNORM1 = 21,
  BYTE_UNORM2 = 22,
  BYTE_UNORM3 = 23,
  BYTE_UNORM4 = 24,
  SHORT_UNORM1 = 25,
  SHORT_UNORM2 = 26,
  SHORT_UNORM3 = 27,
  SHORT_UNORM4 = 28,
  BYTE_SNORM1 = 29,
  BYTE_SNORM2 = 30,
  BYTE_SNORM3 = 31,
  BYTE_SNORM4 = 32,
  SHORT_SNORM1 = 33,
  SHORT_SNORM2 = 34,
  SHORT_SNORM3 = 35,
  SHORT_SNORM4 = 36,
  HALF1 = 37,
  HALF2 = 38,
  HALF3 = 39,
  HALF4 = 40,
  FLOAT1 = 41,
  FLOAT2 = 42,
  FLOAT3 = 43,
  FLOAT4 = 44,
  FLOAT4x4 = 45,
  FLOAT3x4 = 46,
  FLOAT3x3 = 47,
  FLOAT4_QUAT = 48,
  BYTE_SNORM4_QUATXYZW = 49,
  SHORT_SNORM4_QUATXYZW = 50,
  NUM_FORMATS
}
 the enum type More...

Static Public Member Functions

static PX_INLINE uint32_t getFormatDataSize (Enum format)
 Get byte size of format type.

Detailed Description

Enumeration of possible formats of various buffer semantics.

N.B.: DO NOT CHANGE THE VALUES OF OLD FORMATS.


Member Enumeration Documentation

the enum type

Enumerator:
UNSPECIFIED 

No format (semantic not used)

Integer formats

UBYTE1 

One unsigned 8-bit integer (uint8_t[1])

UBYTE2 

Two unsigned 8-bit integers (uint8_t[2])

UBYTE3 

Three unsigned 8-bit integers (uint8_t[3])

UBYTE4 

Four unsigned 8-bit integers (uint8_t[4])

USHORT1 

One unsigned 16-bit integer (uint16_t[1])

USHORT2 

Two unsigned 16-bit integers (uint16_t[2])

USHORT3 

Three unsigned 16-bit integers (uint16_t[3])

USHORT4 

Four unsigned 16-bit integers (uint16_t[4])

SHORT1 

One signed 16-bit integer (int16_t[1])

SHORT2 

Two signed 16-bit integers (int16_t[2])

SHORT3 

Three signed 16-bit integers (int16_t[3])

SHORT4 

Four signed 16-bit integers (int16_t[4])

UINT1 

One unsigned integer (uint32_t[1])

UINT2 

Two unsigned integers (uint32_t[2])

UINT3 

Three unsigned integers (uint32_t[3])

UINT4 

Four unsigned integers (uint32_t[4])

Color formats

R8G8B8A8 

Four unsigned bytes (uint8_t[4]) representing red, green, blue, alpha.

B8G8R8A8 

Four unsigned bytes (uint8_t[4]) representing blue, green, red, alpha.

R32G32B32A32_FLOAT 

Four floats (float[4]) representing red, green, blue, alpha.

B32G32R32A32_FLOAT 

Four floats (float[4]) representing blue, green, red, alpha.

Normalized formats

BYTE_UNORM1 

One unsigned normalized value in the range [0,1], packed into 8 bits (uint8_t[1])

BYTE_UNORM2 

Two unsigned normalized value in the range [0,1], each packed into 8 bits (uint8_t[2])

BYTE_UNORM3 

Three unsigned normalized value in the range [0,1], each packed into bits (uint8_t[3])

BYTE_UNORM4 

Four unsigned normalized value in the range [0,1], each packed into 8 bits (uint8_t[4])

SHORT_UNORM1 

One unsigned normalized value in the range [0,1], packed into 16 bits (uint16_t[1])

SHORT_UNORM2 

Two unsigned normalized value in the range [0,1], each packed into 16 bits (uint16_t[2])

SHORT_UNORM3 

Three unsigned normalized value in the range [0,1], each packed into 16 bits (uint16_t[3])

SHORT_UNORM4 

Four unsigned normalized value in the range [0,1], each packed into 16 bits (uint16_t[4])

BYTE_SNORM1 

One signed normalized value in the range [-1,1], packed into 8 bits (uint8_t[1])

BYTE_SNORM2 

Two signed normalized value in the range [-1,1], each packed into 8 bits (uint8_t[2])

BYTE_SNORM3 

Three signed normalized value in the range [-1,1], each packed into bits (uint8_t[3])

BYTE_SNORM4 

Four signed normalized value in the range [-1,1], each packed into 8 bits (uint8_t[4])

SHORT_SNORM1 

One signed normalized value in the range [-1,1], packed into 16 bits (uint16_t[1])

SHORT_SNORM2 

Two signed normalized value in the range [-1,1], each packed into 16 bits (uint16_t[2])

SHORT_SNORM3 

Three signed normalized value in the range [-1,1], each packed into 16 bits (uint16_t[3])

SHORT_SNORM4 

Four signed normalized value in the range [-1,1], each packed into 16 bits (uint16_t[4])

Float formats

HALF1 

One 16-bit floating point value.

HALF2 

Two 16-bit floating point values.

HALF3 

Three 16-bit floating point values.

HALF4 

Four 16-bit floating point values.

FLOAT1 

One 32-bit floating point value.

FLOAT2 

Two 32-bit floating point values.

FLOAT3 

Three 32-bit floating point values.

FLOAT4 

Four 32-bit floating point values.

FLOAT4x4 

A 4x4 matrix (see PxMat44)

FLOAT3x4 

A 3x4 matrix (see float[12])

FLOAT3x3 

A 3x3 matrix (see PxMat33)

FLOAT4_QUAT 

A quaternion (see PxQuat)

BYTE_SNORM4_QUATXYZW 

A normalized quaternion with signed byte elements, X,Y,Z,W format (uint8_t[4])

SHORT_SNORM4_QUATXYZW 

A normalized quaternion with signed short elements, X,Y,Z,W format (uint16_t[4])


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

Generated on Fri Dec 15 2017 13:58:40

Copyright © 2012-2017 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved.