VertexFormat.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 VERTEX_FORMAT_H
#define VERTEX_FORMAT_H

#include "ApexUsingNamespace.h"
#include "UserRenderResourceManager.h"
#include "UserRenderVertexBufferDesc.h"

namespace nvidia
{
namespace apex
{

PX_PUSH_PACK_DEFAULT

struct ColorRGBA
{
    ColorRGBA() : r(0xFF), g(0xFF), b(0xFF), a(0xFF) {}
    ColorRGBA(uint8_t _r, uint8_t _g, uint8_t _b, uint8_t _a) : r(_r), g(_g), b(_b), a(_a) {}

    uint8_t r;
    uint8_t g;
    uint8_t b;
    uint8_t a;
};

struct RenderDataAccess
{
    enum Enum
    {
        STATIC = 0,
        DYNAMIC,
        STREAMING,

        ACCESS_TYPE_COUNT
    };
};

class VertexFormat
{
public:

    enum
    {
        MAX_UV_COUNT = 4,
        MAX_BONE_PER_VERTEX_COUNT = 4,
    };

    typedef uint32_t BufferID;


    virtual void                            reset() = 0;


    virtual void                            setWinding(RenderCullMode::Enum winding) = 0;

    virtual void                            setHasSeparateBoneBuffer(bool hasSeparateBoneBuffer) = 0;

    virtual RenderCullMode::Enum            getWinding() const = 0;

    virtual bool                            hasSeparateBoneBuffer() const = 0;


    virtual const char*                     getSemanticName(RenderVertexSemantic::Enum semantic) const = 0;

    virtual BufferID                        getSemanticID(RenderVertexSemantic::Enum semantic) const = 0;

    virtual BufferID                        getID(const char* name) const = 0;


    virtual int32_t                         addBuffer(const char* name) = 0;

    virtual bool                            bufferReplaceWithLast(uint32_t index) = 0;


    virtual bool                            setBufferFormat(uint32_t index, RenderDataFormat::Enum format) = 0;

    virtual bool                            setBufferAccess(uint32_t index, RenderDataAccess::Enum access) = 0;

    virtual bool                            setBufferSerialize(uint32_t index, bool serialize) = 0;


    virtual const char*                     getBufferName(uint32_t index) const = 0;

    virtual RenderVertexSemantic::Enum      getBufferSemantic(uint32_t index) const = 0;

    virtual BufferID                        getBufferID(uint32_t index) const = 0;

    virtual RenderDataFormat::Enum          getBufferFormat(uint32_t index) const = 0;

    virtual RenderDataAccess::Enum          getBufferAccess(uint32_t index) const = 0;

    virtual bool                            getBufferSerialize(uint32_t index) const = 0;


    virtual uint32_t                        getBufferCount() const = 0;

    virtual uint32_t                        getCustomBufferCount() const = 0;

    virtual int32_t                         getBufferIndexFromID(BufferID id) const = 0;


protected:
    VertexFormat()  {}
    virtual                                 ~VertexFormat() {}
};

PX_POP_PACK

}
} // end namespace nvidia::apex

#endif // VERTEX_FORMAT_H