UserRenderCallback.h

//
// 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_CALLBACK_H
#define USER_RENDER_CALLBACK_H

#include "RenderDataFormat.h"

typedef struct CUgraphicsResource_st* CUgraphicsResource;


namespace nvidia
{
namespace apex
{

PX_PUSH_PACK_DEFAULT

struct RenderInteropFlags
{
    enum Enum
    {
        NO_INTEROP = 0,
        CUDA_INTEROP,
    };
};

struct RenderMapType
{
    enum Enum
    {
        MAP_READ                 = 1,
        MAP_WRITE                = 2,
        MAP_READ_WRITE           = 3,
        MAP_WRITE_DISCARD        = 4,
        MAP_WRITE_NO_OVERWRITE   = 5 
    };
};

class UserRenderData
{
public:
    
    virtual void addRef() = 0;
    
    virtual void release() = 0;
};

class UserRenderDataHolder
{
public:
    UserRenderDataHolder()
        : userData(NULL)
    {
    }
    
    ~UserRenderDataHolder()
    {
        if (userData)
        {
            userData->release();
        }
    }
    
    UserRenderDataHolder(const UserRenderDataHolder& other)
        : userData(other.userData)
    {
        if (userData)
        {
            userData->addRef();
        }
    }
    
    UserRenderDataHolder& operator=(const UserRenderDataHolder& other)
    {
        setUserData(other.userData);
        return *this;
    }

    void setUserData(UserRenderData* newUserData)
    {
        if (userData != newUserData)
        {
            if (userData)
            {
                userData->release();
            }
            userData = newUserData;
            if (userData)
            {
                userData->addRef();
            }
        }
    }
    
    UserRenderData* getUserData() const
    {
        return userData;
    }

private:

    UserRenderData* userData;
};

class UserRenderStorage
{
public:

    virtual void release() = 0;

    enum Type
    {
        BUFFER = 0,
        SURFACE,
    };
    
    virtual Type getType() const = 0;
};

struct UserRenderBufferDesc : public UserRenderDataHolder
{
    UserRenderBufferDesc(void)
    {
        setDefaults();
    }

    void setDefaults()
    {
        size = 0;
        setUserData(NULL);
        userFlags = 0;
        interopFlags = RenderInteropFlags::NO_INTEROP;
    }

    bool isValid(void) const
    {
        return (size > 0);
    }

    bool isTheSameAs(const UserRenderBufferDesc& other) const
    {
        if (size != other.size) return false;
        if (userFlags != other.userFlags) return false;
        if (getUserData() != other.getUserData()) return false;
        if (interopFlags != other.interopFlags) return false;
        return true;
    }

    size_t                      size;           
    uint32_t                    userFlags;      
    RenderInteropFlags::Enum    interopFlags;   
};

class UserRenderBuffer : public UserRenderStorage
{
public:

    virtual Type getType() const
    {
        return BUFFER;
    }

    virtual void* map(RenderMapType::Enum mapType, size_t offset = 0, size_t size = SIZE_MAX) = 0;
    
    virtual void unmap() = 0;

    virtual bool getCUDAgraphicsResource(CUgraphicsResource &ret) = 0;
};

struct UserRenderSurfaceDesc : public UserRenderDataHolder
{
    UserRenderSurfaceDesc(void)
    {
        setDefaults();
    }

    void setDefaults()
    {
        width = 0;
        height = 0;
        depth = 0;
        format = RenderDataFormat::UNSPECIFIED;
        setUserData(NULL);
        userFlags = 0;
        interopFlags = RenderInteropFlags::NO_INTEROP;
    }

    bool isValid(void) const
    {
        uint32_t numFailed = 0;
        numFailed += (width == 0);
        numFailed += (format == RenderDataFormat::UNSPECIFIED);
        return (numFailed == 0);
    }

    bool isTheSameAs(const UserRenderSurfaceDesc& other) const
    {
        if (width != other.width) return false;
        if (height != other.height) return false;
        if (depth != other.depth) return false;
        if (format != other.format) return false;
        if (userFlags != other.userFlags) return false;
        if (getUserData() != other.getUserData()) return false;
        if (interopFlags != other.interopFlags) return false;
        return true;
    }

    size_t                      width;          
    size_t                      height;         
    size_t                      depth;          
    RenderDataFormat::Enum      format;         
    uint32_t                    userFlags;      
    RenderInteropFlags::Enum    interopFlags;   
};

class UserRenderSurface : public UserRenderStorage
{
public:

    virtual Type getType() const
    {
        return SURFACE;
    }

    struct MappedInfo
    {
        void*       pData;      
        uint32_t    rowPitch;   
        uint32_t    depthPitch; 
    };

    virtual bool map(RenderMapType::Enum mapType, MappedInfo& info) = 0;
    
    virtual void unmap() = 0;

    virtual bool getCUDAgraphicsResource(CUgraphicsResource &ret) = 0;
};

class UserRenderCallback
{
public:
    
    virtual UserRenderBuffer* createRenderBuffer(const UserRenderBufferDesc& )
    {
        return NULL;
    }
    virtual UserRenderSurface* createRenderSurface(const UserRenderSurfaceDesc& )
    {
        return NULL;
    }
};

PX_POP_PACK

}
} // end namespace nvidia::apex

#endif