UserRenderVertexBufferDesc.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_VERTEX_BUFFER_DESC_H
#define USER_RENDER_VERTEX_BUFFER_DESC_H

#include "ApexUsingNamespace.h"
#include "UserRenderResourceManager.h"
#include "RenderDataFormat.h"
#include "ApexSDK.h"

namespace physx
{
    class PxCudaContextManager;
};

namespace nvidia
{
namespace apex
{

PX_PUSH_PACK_DEFAULT

struct RenderVertexSemantic
{
    enum Enum
    {
        CUSTOM = -1,            

        POSITION = 0,           
        NORMAL,                 
        TANGENT,                
        BINORMAL,               
        COLOR,                  
        TEXCOORD0,              
        TEXCOORD1,              
        TEXCOORD2,              
        TEXCOORD3,              
        BONE_INDEX,             
        BONE_WEIGHT,            

        DISPLACEMENT_TEXCOORD,  
        DISPLACEMENT_FLAGS,     

        NUM_SEMANTICS           
    };
};

struct TextureUVOrigin
{
    enum Enum
    {
        ORIGIN_TOP_LEFT = 0,        
        ORIGIN_TOP_RIGHT = 1,       
        ORIGIN_BOTTOM_LEFT = 2,     
        ORIGIN_BOTTOM_RIGHT = 3,    

        ORIGIN_UNKNOWN = 0xFFFFFFFF 
    };
};


class UserRenderVertexBufferDesc
{
public:
    UserRenderVertexBufferDesc(void)
    {
        interopContext = 0;
        registerInCUDA = false;
        maxVerts = 0;
        hint     = RenderBufferHint::STATIC;
        for (uint32_t i = 0; i < RenderVertexSemantic::NUM_SEMANTICS; i++)
        {
            buffersRequest[i] = RenderDataFormat::UNSPECIFIED;
        }
        moduleIdentifier = 0;
        numCustomBuffers = 0;
        customBuffersIdents = NULL;
        customBuffersRequest = NULL;
        uvOrigin         = TextureUVOrigin::ORIGIN_TOP_LEFT;
        canBeShared      = true;
    }

    bool isValid(void) const
    {
        uint32_t numFailed = 0;
        if (maxVerts == 0)
        {
            numFailed++;
        }
        if (!customBuffersRequest)
        {
            uint32_t vertexSize = 0;
            for (uint32_t i = 0; i < RenderVertexSemantic::NUM_SEMANTICS; i++)
            {
                vertexSize += RenderDataFormat::getFormatDataSize(buffersRequest[i]);
            }
            if (vertexSize == 0)
            {
                numFailed++;
            }
        }
        return (numFailed == 0);
    }

public:
    uint32_t                    maxVerts;

    RenderBufferHint::Enum      hint;

    RenderDataFormat::Enum      buffersRequest[RenderVertexSemantic::NUM_SEMANTICS];

    uint32_t                    numCustomBuffers;

    void**                      customBuffersIdents;

    RenderDataFormat::Enum*     customBuffersRequest;

    AuthObjTypeID               moduleIdentifier;

    TextureUVOrigin::Enum       uvOrigin;

    bool                        canBeShared;
    
    bool                        registerInCUDA;

    PxCudaContextManager*       interopContext;
};

PX_POP_PACK

}
} // end namespace nvidia::apex

#endif // USER_RENDER_VERTEX_BUFFER_DESC_H