IofxRenderable.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 IOFX_RENDERABLE_H
#define IOFX_RENDERABLE_H

#include "foundation/Px.h"
#include "ApexInterface.h"
#include "Renderable.h"
#include "IofxRenderCallback.h"

namespace nvidia
{
namespace apex
{

PX_PUSH_PACK_DEFAULT

struct IofxSharedRenderData
{
    uint32_t    maxObjectCount; 
    uint32_t    activeObjectCount; 
};

struct IofxSpriteSharedRenderData : IofxSharedRenderData
{
    IofxSpriteRenderLayout  spriteRenderLayout; 
    UserRenderBuffer*           spriteRenderBuffer; 
    UserRenderSurface*      spriteRenderSurfaces[IofxSpriteRenderLayout::MAX_SURFACE_COUNT]; 
};

struct IofxMeshSharedRenderData : IofxSharedRenderData
{
    IofxMeshRenderLayout        meshRenderLayout; 
    UserRenderBuffer*           meshRenderBuffer; 
};

struct IofxCommonRenderData
{
    uint32_t        startIndex; 
    uint32_t        objectCount; 

    const char*     renderResourceNameSpace; 
    const char*     renderResourceName; 
    void*           renderResource; 
};

struct IofxSpriteRenderData : IofxCommonRenderData
{
    uint32_t        visibleCount; 

    const IofxSpriteSharedRenderData* sharedRenderData; 
};

struct IofxMeshRenderData : IofxCommonRenderData
{
    const IofxMeshSharedRenderData* sharedRenderData; 
};

class IofxSpriteRenderable;
class IofxMeshRenderable;

class IofxRenderable : public ApexInterface
{
public:
    enum Type
    {
        SPRITE, 
        MESH 
    };

    virtual Type                        getType() const = 0;

    virtual const IofxSpriteRenderData* getSpriteRenderData() const = 0;

    virtual const IofxMeshRenderData*   getMeshRenderData() const = 0;

    virtual const physx::PxBounds3&     getBounds() const = 0;

protected:
    virtual ~IofxRenderable() {}

};

PX_POP_PACK

}
} // end namespace nvidia

#endif // IOFX_RENDERABLE_H