UserRenderResourceManager.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_MANAGER_H
#define USER_RENDER_RESOURCE_MANAGER_H

#include "ApexUsingNamespace.h"

namespace nvidia
{
namespace apex
{

PX_PUSH_PACK_DEFAULT

class UserRenderVertexBuffer;
class UserRenderVertexBufferDesc;
class UserRenderIndexBuffer;
class UserRenderIndexBufferDesc;
class UserRenderSurfaceBuffer;
class UserRenderSurfaceBufferDesc;
class UserRenderBoneBuffer;
class UserRenderBoneBufferDesc;
class UserRenderInstanceBuffer;
class UserRenderInstanceBufferDesc;
class UserRenderSpriteBuffer;
class UserRenderSpriteBufferDesc;
class UserRenderResource;
class UserRenderResourceDesc;
class UserOpaqueMesh;
class UserOpaqueMeshDesc;

class UserRenderSpriteTextureDesc;

struct RenderPrimitiveType
{
    enum Enum
    {
        UNKNOWN = 0,

        TRIANGLES,
        TRIANGLE_STRIP,

        LINES,
        LINE_STRIP,

        POINTS,
        POINT_SPRITES,
    };
};

struct RenderCullMode
{
    enum Enum
    {
        CLOCKWISE = 0,
        COUNTER_CLOCKWISE,
        NONE
    };
};

struct RenderBufferHint
{
    enum Enum
    {
        STATIC = 0,
        DYNAMIC,
        STREAMING,
    };
};

class UserRenderResourceManager
{
public:
    virtual                             ~UserRenderResourceManager() {}

    virtual UserRenderVertexBuffer*     createVertexBuffer(const UserRenderVertexBufferDesc& desc)     = 0;
    virtual void                        releaseVertexBuffer(UserRenderVertexBuffer& buffer)            = 0;

    virtual UserRenderIndexBuffer*      createIndexBuffer(const UserRenderIndexBufferDesc& desc)       = 0;
    virtual void                        releaseIndexBuffer(UserRenderIndexBuffer& buffer)              = 0;

    virtual UserRenderBoneBuffer*       createBoneBuffer(const UserRenderBoneBufferDesc& desc)         = 0;
    virtual void                        releaseBoneBuffer(UserRenderBoneBuffer& buffer)                = 0;

    virtual UserRenderInstanceBuffer*   createInstanceBuffer(const UserRenderInstanceBufferDesc& desc) = 0;
    virtual void                        releaseInstanceBuffer(UserRenderInstanceBuffer& buffer)        = 0;

    virtual UserRenderSpriteBuffer*     createSpriteBuffer(const UserRenderSpriteBufferDesc& desc)     = 0;
    virtual void                        releaseSpriteBuffer(UserRenderSpriteBuffer& buffer)            = 0;

    virtual UserRenderSurfaceBuffer*    createSurfaceBuffer(const UserRenderSurfaceBufferDesc& desc)   = 0;
    virtual void                        releaseSurfaceBuffer(UserRenderSurfaceBuffer& buffer)          = 0;

    virtual UserRenderResource*         createResource(const UserRenderResourceDesc& desc)             = 0;

    virtual void                        releaseResource(UserRenderResource& resource)                  = 0;

    virtual uint32_t                    getMaxBonesForMaterial(void* material)                         = 0;


    virtual bool                        getSpriteLayoutData(uint32_t spriteCount, uint32_t spriteSemanticsBitmap, UserRenderSpriteBufferDesc* textureDescArray) = 0;

    virtual bool                        getInstanceLayoutData(uint32_t spriteCount, uint32_t spriteSemanticsBitmap, UserRenderInstanceBufferDesc* instanceDescArray) = 0;

};

PX_POP_PACK

}
} // end namespace nvidia::apex

#endif