UserRenderSurfaceBufferDesc.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008-2017, NVIDIA CORPORATION.  All rights reserved.
 *
 * NVIDIA CORPORATION and its licensors retain all intellectual property
 * and proprietary rights in and to this software, related documentation
 * and any modifications thereto.  Any use, reproduction, disclosure or
 * distribution of this software and related documentation without an express
 * license agreement from NVIDIA CORPORATION is strictly prohibited.
 */


#ifndef USER_RENDER_SURFACE_BUFFER_DESC_H
#define USER_RENDER_SURFACE_BUFFER_DESC_H

#include "ApexUsingNamespace.h"
#include "UserRenderResourceManager.h"
#include "RenderDataFormat.h"
#include "ApexSDK.h"

namespace physx
{
    class PxCudaContextManager;
}

namespace nvidia
{
namespace apex
{

PX_PUSH_PACK_DEFAULT

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

    void setDefaults()
    {
//      hint   = RenderBufferHint::STATIC;      
        format = RenderDataFormat::UNSPECIFIED;
        
        width = 0;
        height = 0;
        depth = 1;

        //moduleIdentifier = 0;
        
        registerInCUDA = false;
        interopContext = 0;
//      stride = 0;
    }

    bool isValid(void) const
    {
        uint32_t numFailed = 0;
        numFailed += (format == RenderDataFormat::UNSPECIFIED);
        numFailed += (width == 0) && (height == 0) && (depth == 0);
        numFailed += registerInCUDA && (interopContext == 0);
//      numFailed += registerInCUDA && (stride == 0);
        
        return (numFailed == 0);
    }

public:
    uint32_t                width;
    
    uint32_t                height;

    uint32_t                depth;

    RenderDataFormat::Enum  format;

    bool                    registerInCUDA;  

    PxCudaContextManager*   interopContext;
};

PX_POP_PACK

}
} // end namespace nvidia::apex

#endif // USER_RENDER_SURFACE_BUFFER_DESC_H