NxApexRenderDataFormat.h

// This code contains NVIDIA Confidential Information and is disclosed to you
// under a form of NVIDIA software license agreement provided separately to you.
//
// Notice
// NVIDIA Corporation and its licensors retain all intellectual property and
// proprietary rights in and to this software and related documentation and
// any modifications thereto. Any use, reproduction, disclosure, or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA Corporation is strictly prohibited.
//
// ALL NVIDIA DESIGN SPECIFICATIONS, CODE ARE PROVIDED "AS IS.". NVIDIA MAKES
// NO WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO
// THE MATERIALS, AND EXPRESSLY DISCLAIMS ALL IMPLIED WARRANTIES OF NONINFRINGEMENT,
// MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE.
//
// Information and code furnished is believed to be accurate and reliable.
// However, NVIDIA Corporation assumes no responsibility for the consequences of use of such
// information or for any infringement of patents or other rights of third parties that may
// result from its use. No license is granted by implication or otherwise under any patent
// or patent rights of NVIDIA Corporation. Details are subject to change without notice.
// This code supersedes and replaces all information previously supplied.
// NVIDIA Corporation products are not authorized for use as critical
// components in life support devices or systems without express written approval of
// NVIDIA Corporation.
//
// Copyright (c) 2008-2014 NVIDIA Corporation. All rights reserved.

#ifndef NX_APEX_RENDER_DATA_FORMAT_H
#define NX_APEX_RENDER_DATA_FORMAT_H

#include "NxApexUsingNamespace.h"
#include "foundation/PxAssert.h"
#include "foundation/PxMat33.h"

namespace physx
{
namespace apex
{

PX_PUSH_PACK_DEFAULT

struct NxRenderDataFormat
{
    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, 

        FLOAT3x4 =              45, 
        FLOAT3x3 =              46, 

        FLOAT4_QUAT =           47, 
        BYTE_SNORM4_QUATXYZW =  48, 
        SHORT_SNORM4_QUATXYZW = 49, 

        NUM_FORMATS
    };

    static PX_INLINE physx::PxU32 getFormatDataSize(Enum format)
    {
        switch (format)
        {
        default:
            PX_ALWAYS_ASSERT();
        case UNSPECIFIED:
            return 0;

        case UBYTE1:
        case BYTE_UNORM1:
        case BYTE_SNORM1:
            return sizeof(physx::PxU8);
        case UBYTE2:
        case BYTE_UNORM2:
        case BYTE_SNORM2:
            return sizeof(physx::PxU8) * 2;
        case UBYTE3:
        case BYTE_UNORM3:
        case BYTE_SNORM3:
            return sizeof(physx::PxU8) * 3;
        case UBYTE4:
        case BYTE_UNORM4:
        case BYTE_SNORM4:
        case BYTE_SNORM4_QUATXYZW:
            return sizeof(physx::PxU8) * 4;

        case USHORT1:
        case SHORT1:
        case HALF1:
        case SHORT_UNORM1:
        case SHORT_SNORM1:
            return sizeof(physx::PxU16);
        case USHORT2:
        case SHORT2:
        case HALF2:
        case SHORT_UNORM2:
        case SHORT_SNORM2:
            return sizeof(physx::PxU16) * 2;
        case USHORT3:
        case SHORT3:
        case HALF3:
        case SHORT_UNORM3:
        case SHORT_SNORM3:
            return sizeof(physx::PxU16) * 3;
        case USHORT4:
        case SHORT4:
        case HALF4:
        case SHORT_UNORM4:
        case SHORT_SNORM4:
        case SHORT_SNORM4_QUATXYZW:
            return sizeof(physx::PxU16) * 4;

        case UINT1:
            return sizeof(physx::PxU32);
        case UINT2:
            return sizeof(physx::PxU32) * 2;
        case UINT3:
            return sizeof(physx::PxU32) * 3;
        case UINT4:
            return sizeof(physx::PxU32) * 4;

        case R8G8B8A8:
        case B8G8R8A8:
            return sizeof(physx::PxU8) * 4;

        case R32G32B32A32_FLOAT:
        case B32G32R32A32_FLOAT:
            return sizeof(physx::PxF32) * 4;

        case FLOAT1:
            return sizeof(physx::PxF32);
        case FLOAT2:
            return sizeof(physx::PxF32) * 2;
        case FLOAT3:
            return sizeof(physx::PxF32) * 3;
        case FLOAT4:
            return sizeof(physx::PxF32) * 4;

        case FLOAT3x4:
            return sizeof(physx::PxF32) * 12;

        case FLOAT3x3:
            return sizeof(physx::PxMat33);

        case FLOAT4_QUAT:
            return sizeof(physx::PxQuat);
        }
    }
};

PX_POP_PACK

}
} // end namespace physx::apex

#endif  // NX_APEX_RENDER_DATA_FORMAT_H