UserRenderResourceDesc.h

Go to the documentation of this file.

//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
//  * Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//  * Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//  * Neither the name of NVIDIA CORPORATION nor the names of its
//    contributors may be used to endorse or promote products derived
//    from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
// OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Copyright (c) 2018 NVIDIA Corporation. All rights reserved.



#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