UserRenderResourceDesc.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008-2017, NVIDIA CORPORATION.  All rights reserved.
 *
 * NVIDIA CORPORATION and its licensors retain all intellectual property
 * and proprietary rights in and to this software, 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.
 */


#ifndef USER_RENDER_RESOURCE_DESC_H
#define USER_RENDER_RESOURCE_DESC_H

#include "UserRenderResourceManager.h"
#include "foundation/PxAssert.h"

namespace nvidia
{
namespace apex
{

PX_PUSH_PACK_DEFAULT

class Renderable;
class UserOpaqueMesh;
class UserRenderVertexBuffer;
class UserRenderIndexBuffer;
class UserRenderBoneBuffer;
class UserRenderInstanceBuffer;
class UserRenderSpriteBuffer;

class UserRenderResourceDesc
{
public:
    UserRenderResourceDesc(void)
    {
        firstVertex      = 0;
        numVerts         = 0;

        indexBuffer      = 0;
        firstIndex       = 0;
        numIndices       = 0;

        boneBuffer       = 0;
        firstBone        = 0;
        numBones         = 0;

        instanceBuffer   = 0;
        firstInstance    = 0;
        numInstances     = 0;

        spriteBuffer     = 0;
        firstSprite      = 0;
        numSprites       = 0;
        visibleSpriteCount = 0;

        material         = 0;
        submeshIndex     = 0;

        userRenderData   = 0;

        numVertexBuffers = 0;
        vertexBuffers     = NULL;

        cullMode         = RenderCullMode::CLOCKWISE;
        primitives       = RenderPrimitiveType::UNKNOWN;

        opaqueMesh      = NULL;
    }

    bool isValid(void) const
    {
        uint32_t numFailed = 0;
        if (numVertexBuffers >= 255)
        {
            numFailed++;
        }
        if (numIndices   && !indexBuffer)
        {
            numFailed++;
        }
        if (numBones     && !boneBuffer)
        {
            numFailed++;
        }
        if (numInstances && !instanceBuffer)
        {
            numFailed++;
        }
        if (numSprites   && !spriteBuffer)
        {
            numFailed++;
        }
        PX_ASSERT(numFailed == 0);
        return numFailed == 0;
    }

public:
    UserOpaqueMesh*             opaqueMesh;         
    UserRenderVertexBuffer**    vertexBuffers;      

    uint32_t                    numVertexBuffers;   

    uint32_t                    firstVertex;        
    uint32_t                    numVerts;           

    UserRenderIndexBuffer*      indexBuffer;        
    uint32_t                    firstIndex;         
    uint32_t                    numIndices;         

    UserRenderBoneBuffer*       boneBuffer;         
    uint32_t                    firstBone;          
    uint32_t                    numBones;           

    UserRenderInstanceBuffer*   instanceBuffer; 
    uint32_t                    firstInstance;      
    uint32_t                    numInstances;       

    UserRenderSpriteBuffer*     spriteBuffer;       
    uint32_t                    firstSprite;        
    uint32_t                    numSprites;         
    uint32_t                    visibleSpriteCount; 

    UserRenderSurfaceBuffer**   surfaceBuffers;     
    uint32_t                    numSurfaceBuffers;  
    uint32_t                    widthSurfaceBuffers;
    uint32_t                    heightSurfaceBuffers;

    void*                       material;           
    uint32_t                    submeshIndex;       

    void*                       userRenderData;

    RenderCullMode::Enum        cullMode;           
    RenderPrimitiveType::Enum   primitives;         
};

PX_POP_PACK

}
} // end namespace nvidia::apex

#endif