GR_TextureRef.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 * 
 * NAME:        GR_TextureRef.h ( GR Library, C++)
 *
 * COMMENTS:
 *      texture ref that could be from different rendering backends
 */

#ifndef GR_TextureRef_h
#define GR_TextureRef_h

#include "GR_API.h"

#include <RE/RE_Texture.h>
#include <UT/UT_Array.h>
#include <UT/UT_SharedPtr.h>
#include <UT/UT_VectorTypes.h>

#include "GR_Defines.h"

class RV_OGLInteropTextureBase;
class RV_VKImage;

// Reference to a texture created by one of the underlying
// renderer, to be passed back during a draw
// Can be backed by OpenGL, Vulkan, or interop texture.
// Renders should check that the type matches their own
// before using
class GR_API GR_TextureRef
{
public:
    void clear() { *this = GR_TextureRef(); }

    bool isValid() { return isGL() || isVulkan();}
    bool isGL() const { return myInterop || myRE; }
    bool isVulkan() const { return myInterop || myRV; }

    // NOTE: will be nullptr if `isGL` is false
    RE_Texture* getGL() const;
    // NOTE: will be NULL if `isVulkan` is false
    RV_VKImage* getVulkan() const;

    operator RE_Texture* () const { return this->getGL(); }
    RE_Texture* operator*() const  { return this->getGL(); }
    RE_Texture* operator->() const { UT_ASSERT(isGL()); return getGL(); }
    
    explicit operator RV_VKImage* () const { return getVulkan(); }

    GR_TextureRef() = default;

    GR_TextureRef(std::nullptr_t)
    : GR_TextureRef()
    {}
    
    GR_TextureRef(RV_OGLInteropTextureBase* i)
    : myInterop(i), myRE(nullptr), myRV(nullptr)
    {}

    GR_TextureRef(RE_Texture* re)
    : myInterop(nullptr), myRE(re), myRV(nullptr)
    {}

    GR_TextureRef(RV_VKImage* rv)
    : myInterop(nullptr), myRE(nullptr), myRV(rv)
    {}

    GR_TextureRef(RE_Texture* re, RV_VKImage* rv)
    : myInterop(nullptr), myRE(re), myRV(rv)
    {}


    bool         operator==(const GR_TextureRef &rhs) const
                        { return myInterop == rhs.myInterop
                                 && myRE == rhs.myRE
                                 && myRV == rhs.myRV; }
    bool         operator!=(const GR_TextureRef &rhs) const
                        { return !(*this == rhs); }

    bool         operator==(const RE_Texture *rhs) const
                        { return rhs == getGL(); }
    bool         operator!=(const RE_Texture *rhs) const
                        { return rhs != getGL(); }

    bool         operator==(const RV_VKImage *rhs) const
                        { return rhs == getVulkan(); }
    bool         operator!=(const RV_VKImage *rhs) const
                        { return rhs != getVulkan(); }

private:
    RV_OGLInteropTextureBase* myInterop = nullptr;
    RE_Texture*               myRE = nullptr;
    RV_VKImage*               myRV = nullptr;
};

#endif