UserRenderInstanceBufferDesc.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_INSTANCE_BUFFER_DESC_H
#define USER_RENDER_INSTANCE_BUFFER_DESC_H

#include "UserRenderResourceManager.h"
#include "RenderDataFormat.h"

namespace physx
{
    class PxCudaContextManager;
};

namespace nvidia
{
namespace apex
{

PX_PUSH_PACK_DEFAULT

#if !PX_PS4
    #pragma warning(push)
    #pragma warning(disable:4121)
#endif  //!PX_PS4

struct RenderInstanceSemantic
{
    enum Enum
    {
        POSITION = 0,   
        ROTATION_SCALE, 
        VELOCITY_LIFE,  
        DENSITY,        
        COLOR,          
        UV_OFFSET,      
        LOCAL_OFFSET,   

        USER_DATA,      

        POSE,           

        NUM_SEMANTICS   
    };
};

struct RenderInstanceLayoutElement
{
    enum Enum
    {
        POSITION_FLOAT3,
        ROTATION_SCALE_FLOAT3x3,
        VELOCITY_LIFE_FLOAT4,
        DENSITY_FLOAT1,
        COLOR_RGBA8,
        COLOR_BGRA8,
        COLOR_FLOAT4,
        UV_OFFSET_FLOAT2,
        LOCAL_OFFSET_FLOAT3,
        USER_DATA_UINT1,
        POSE_FLOAT3x4,

        NUM_SEMANTICS
    };

    static PX_INLINE RenderDataFormat::Enum getSemanticFormat(Enum semantic)
    {
        switch (semantic)
        {
        case POSITION_FLOAT3:
            return RenderDataFormat::FLOAT3;        
        case ROTATION_SCALE_FLOAT3x3:
            return RenderDataFormat::FLOAT3x3;
        case VELOCITY_LIFE_FLOAT4:
            return RenderDataFormat::FLOAT4;
        case DENSITY_FLOAT1:
            return RenderDataFormat::FLOAT1;
        case COLOR_RGBA8:
            return RenderDataFormat::R8G8B8A8;
        case COLOR_BGRA8:
            return RenderDataFormat::B8G8R8A8;
        case COLOR_FLOAT4:
            return RenderDataFormat::FLOAT4;
        case UV_OFFSET_FLOAT2:
            return RenderDataFormat::FLOAT2;
        case LOCAL_OFFSET_FLOAT3:
            return RenderDataFormat::FLOAT3;
        case USER_DATA_UINT1:
            return RenderDataFormat::UINT1;
        case POSE_FLOAT3x4:
            return RenderDataFormat::FLOAT3x4;
        default:
            PX_ALWAYS_ASSERT();
            return RenderDataFormat::NUM_FORMATS;
        }
    }
    static PX_INLINE RenderInstanceSemantic::Enum getSemantic(Enum semantic)
    {
        switch (semantic)
        {
        case POSITION_FLOAT3:
            return RenderInstanceSemantic::POSITION;        
        case ROTATION_SCALE_FLOAT3x3:
            return RenderInstanceSemantic::ROTATION_SCALE;
        case VELOCITY_LIFE_FLOAT4:
            return RenderInstanceSemantic::VELOCITY_LIFE;
        case DENSITY_FLOAT1:
            return RenderInstanceSemantic::DENSITY;
        case COLOR_RGBA8:
        case COLOR_BGRA8:
        case COLOR_FLOAT4:
            return RenderInstanceSemantic::COLOR;
        case UV_OFFSET_FLOAT2:
            return RenderInstanceSemantic::UV_OFFSET;
        case LOCAL_OFFSET_FLOAT3:
            return RenderInstanceSemantic::LOCAL_OFFSET;
        case USER_DATA_UINT1:
            return RenderInstanceSemantic::USER_DATA;
        case POSE_FLOAT3x4:
            return RenderInstanceSemantic::POSE;
        default:
            PX_ALWAYS_ASSERT();
            return RenderInstanceSemantic::NUM_SEMANTICS;
        }
    }
};

class UserRenderInstanceBufferDesc
{
public:
    UserRenderInstanceBufferDesc(void)
    {
        setDefaults();
    }

    void setDefaults()
    {
        registerInCUDA = false;
        interopContext = 0;
        maxInstances = 0;
        hint         = RenderBufferHint::STATIC;
        for (uint32_t i = 0; i < RenderInstanceLayoutElement::NUM_SEMANTICS; i++)
        {
            semanticOffsets[i] = uint32_t(-1);
        }
        stride = 0;
    }

    bool isValid(void) const
    {
        uint32_t numFailed = 0;

        numFailed += (maxInstances == 0);
        numFailed += (stride == 0);
        numFailed += (semanticOffsets[RenderInstanceLayoutElement::POSITION_FLOAT3] == uint32_t(-1))
            && (semanticOffsets[RenderInstanceLayoutElement::POSE_FLOAT3x4] == uint32_t(-1));
        numFailed += registerInCUDA && (interopContext == 0);

        numFailed += ((stride & 0x03) != 0);
        for (uint32_t i = 0; i < RenderInstanceLayoutElement::NUM_SEMANTICS; i++)
        {
            if (semanticOffsets[i] != static_cast<uint32_t>(-1))
            {
                numFailed += (semanticOffsets[i] >= stride);
                numFailed += ((semanticOffsets[i] & 0x03) != 0);
            }
        }

        return (numFailed == 0);
    }

    bool isTheSameAs(const UserRenderInstanceBufferDesc& other) const
    {
        if (registerInCUDA != other.registerInCUDA) return false;
        if (maxInstances != other.maxInstances) return false;
        if (hint != other.hint) return false;

        if (stride != other.stride) return false;
        for (uint32_t i = 0; i < RenderInstanceLayoutElement::NUM_SEMANTICS; i++)
        {
            if (semanticOffsets[i] != other.semanticOffsets[i]) return false;
        }
        return true;
    }

public:
    uint32_t                    maxInstances; 
    RenderBufferHint::Enum      hint; 
    
    uint32_t                    semanticOffsets[RenderInstanceLayoutElement::NUM_SEMANTICS];

    uint32_t                    stride; 

    bool                        registerInCUDA; 

    PxCudaContextManager*       interopContext;
};

#if !PX_PS4
    #pragma warning(pop)
#endif  //!PX_PS4

PX_POP_PACK

}
} // end namespace nvidia::apex

#endif // USER_RENDER_INSTANCE_BUFFER_DESC_H