Encapsulate GPUObject in a safer way

libraries/gpu/src/gpu/Context.h

@@ -97,68 +97,16 @@ public:
         TransformCamera getEyeCamera(int eye, const StereoState& stereo) const;
     };
 
-    template< typename T >
+
-    static void setGPUObject(const Buffer& buffer, T* object) {
+    template<typename T>
-        buffer.setGPUObject(object);
+    static void setGPUObject(const GPUObjectWrapper& wrapper, T* object) {
+        wrapper.setGPUObject(object);
     }
-    template< typename T >
+    template<typename T>
-    static T* getGPUObject(const Buffer& buffer) {
+    static T* getGPUObject(const GPUObjectWrapper& wrapper) {
-        return reinterpret_cast<T*>(buffer.getGPUObject());
+        return reinterpret_cast<T*>(wrapper.getGPUObject());
     }
 
-    template< typename T >
-    static void setGPUObject(const Texture& texture, T* object) {
-        texture.setGPUObject(object);
-    }
-    template< typename T >
-    static T* getGPUObject(const Texture& texture) {
-        return reinterpret_cast<T*>(texture.getGPUObject());
-    }
-    
-    template< typename T >
-    static void setGPUObject(const Shader& shader, T* object) {
-        shader.setGPUObject(object);
-    }
-    template< typename T >
-    static T* getGPUObject(const Shader& shader) {
-        return reinterpret_cast<T*>(shader.getGPUObject());
-    }
-
-    template< typename T >
-    static void setGPUObject(const Pipeline& pipeline, T* object) {
-        pipeline.setGPUObject(object);
-    }
-    template< typename T >
-    static T* getGPUObject(const Pipeline& pipeline) {
-        return reinterpret_cast<T*>(pipeline.getGPUObject());
-    }
-
-    template< typename T >
-    static void setGPUObject(const State& state, T* object) {
-        state.setGPUObject(object);
-    }
-    template< typename T >
-    static T* getGPUObject(const State& state) {
-        return reinterpret_cast<T*>(state.getGPUObject());
-    }
-
-    template< typename T >
-    static void setGPUObject(const Framebuffer& framebuffer, T* object) {
-        framebuffer.setGPUObject(object);
-    }
-    template< typename T >
-    static T* getGPUObject(const Framebuffer& framebuffer) {
-        return reinterpret_cast<T*>(framebuffer.getGPUObject());
-    }
-
-    template< typename T >
-    static void setGPUObject(const Query& query, T* object) {
-        query.setGPUObject(object);
-    }
-    template< typename T >
-    static T* getGPUObject(const Query& query) {
-        return reinterpret_cast<T*>(query.getGPUObject());
-    }
 
 protected:
     StereoState  _stereo;

libraries/gpu/src/gpu/Format.h

@@ -16,10 +16,25 @@
 
 namespace gpu {
 
+class Backend;
+
 class GPUObject {
 public:
-    GPUObject() {}
+    virtual ~GPUObject() = default;
-    virtual ~GPUObject() {}
+};
+
+class GPUObjectWrapper {
+public:
+    virtual ~GPUObjectWrapper() { delete _gpuObject; }
+
+private:
+    // This shouldn't be used by anything else than the Backend class with the proper casting.
+    // TODO: Consider using std::unique_ptr to get rid of dtor and ensure correct destruction of GPU objects
+    mutable GPUObject* _gpuObject { nullptr };
+    void setGPUObject(GPUObject* gpuObject) const { _gpuObject = gpuObject; }
+    GPUObject* getGPUObject() const { return _gpuObject; }
+
+    friend class Backend;
 };
 
 typedef int  Stamp;

libraries/gpu/src/gpu/Framebuffer.h

@@ -64,7 +64,7 @@ protected:
 typedef std::shared_ptr<Swapchain> SwapchainPointer;
 
 
-class Framebuffer {
+class Framebuffer : public GPUObjectWrapper {
 public:
     enum BufferMask {
         BUFFER_COLOR0 = 1,
@@ -153,12 +153,6 @@ protected:
     // Non exposed
     Framebuffer(const Framebuffer& framebuffer) = delete;
     Framebuffer() {}
-    
-    // This shouldn't be used by anything else than the Backend class with the proper casting.
-    mutable GPUObject* _gpuObject = NULL;
-    void setGPUObject(GPUObject* gpuObject) const { _gpuObject = gpuObject; }
-    GPUObject* getGPUObject() const { return _gpuObject; }
-    friend class Backend;
 };
 typedef std::shared_ptr<Framebuffer> FramebufferPointer;
 

libraries/gpu/src/gpu/Pipeline.h

@@ -20,7 +20,7 @@
  
 namespace gpu {
 
-class Pipeline {
+class Pipeline : public GPUObjectWrapper {
 public:
     using Pointer = std::shared_ptr< Pipeline >;
 
@@ -38,12 +38,6 @@ protected:
     Pipeline();
     Pipeline(const Pipeline& pipeline); // deep copy of the sysmem shader
     Pipeline& operator=(const Pipeline& pipeline); // deep copy of the sysmem texture
-
-    // This shouldn't be used by anything else than the Backend class with the proper casting.
-    mutable GPUObject* _gpuObject = nullptr;
-    void setGPUObject(GPUObject* gpuObject) const { _gpuObject = gpuObject; }
-    GPUObject* getGPUObject() const { return _gpuObject; }
-    friend class Backend;
 };
 
 typedef Pipeline::Pointer PipelinePointer;

libraries/gpu/src/gpu/Query.h

@@ -19,7 +19,7 @@
 
 namespace gpu {
 
-    class Query {
+    class Query : public GPUObjectWrapper {
     public:
         Query();
         ~Query();
@@ -27,14 +27,6 @@ namespace gpu {
         uint32 queryResult;
 
         double getElapsedTime();
-
-    protected:
-        
-        // This shouldn't be used by anything else than the Backend class with the proper casting.
-        mutable GPUObject* _gpuObject = NULL;
-        void setGPUObject(GPUObject* gpuObject) const { _gpuObject = gpuObject; }
-        GPUObject* getGPUObject() const { return _gpuObject; }
-        friend class Backend; 
     };
     
     typedef std::shared_ptr<Query> QueryPointer;

libraries/gpu/src/gpu/Resource.cpp

@@ -170,20 +170,17 @@ Resource::Size Resource::Sysmem::append(Size size, const Byte* bytes) {
 
 Buffer::Buffer() :
     Resource(),
-    _sysmem(new Sysmem()),
+    _sysmem(new Sysmem()) {
-    _gpuObject(NULL) {
 }
 
 Buffer::Buffer(Size size, const Byte* bytes) :
     Resource(),
-    _sysmem(new Sysmem(size, bytes)),
+    _sysmem(new Sysmem(size, bytes)) {
-    _gpuObject(NULL) {
 }
 
 Buffer::Buffer(const Buffer& buf) :
     Resource(),
-    _sysmem(new Sysmem(buf.getSysmem())),
+    _sysmem(new Sysmem(buf.getSysmem())) {
-    _gpuObject(NULL) {
 }
 
 Buffer& Buffer::operator=(const Buffer& buf) {
@@ -196,10 +193,6 @@ Buffer::~Buffer() {
         delete _sysmem;
         _sysmem = NULL;
     }
-    if (_gpuObject) {
-        delete _gpuObject;
-        _gpuObject = NULL;
-    }
 }
 
 Buffer::Size Buffer::resize(Size size) {

libraries/gpu/src/gpu/Resource.h

@@ -108,7 +108,7 @@ protected:
 
 };
 
-class Buffer : public Resource {
+class Buffer : public Resource, public GPUObjectWrapper  {
 public:
 
     Buffer();
@@ -156,13 +156,6 @@ public:
 protected:
 
     Sysmem* _sysmem = NULL;
-
-
-    // This shouldn't be used by anything else than the Backend class with the proper casting.
-    mutable GPUObject* _gpuObject = NULL;
-    void setGPUObject(GPUObject* gpuObject) const { _gpuObject = gpuObject; }
-    GPUObject* getGPUObject() const { return _gpuObject; }
-    friend class Backend;
 };
 
 typedef std::shared_ptr<Buffer> BufferPointer;

libraries/gpu/src/gpu/Shader.h

@@ -20,7 +20,7 @@
  
 namespace gpu {
 
-class Shader {
+class Shader : public GPUObjectWrapper {
 public:
 
     typedef std::shared_ptr< Shader > Pointer;
@@ -178,12 +178,6 @@ protected:
 
     // The type of the shader, the master key
     Type _type;
-
-    // This shouldn't be used by anything else than the Backend class with the proper casting.
-    mutable GPUObject* _gpuObject = NULL;
-    void setGPUObject(GPUObject* gpuObject) const { _gpuObject = gpuObject; }
-    GPUObject* getGPUObject() const { return _gpuObject; }
-    friend class Backend;
 };
 
 typedef Shader::Pointer ShaderPointer;

libraries/gpu/src/gpu/State.h

@@ -36,7 +36,7 @@ namespace gpu {
 
 class GPUObject;
 
-class State {
+class State : public GPUObjectWrapper {
 public:
     State();
     virtual ~State();
@@ -392,12 +392,6 @@ protected:
     Data _values;
     Signature _signature{0};
     Stamp _stamp{0};
-
-    // This shouldn't be used by anything else than the Backend class with the proper casting.
-    mutable GPUObject* _gpuObject = nullptr;
-    void setGPUObject(GPUObject* gpuObject) const { _gpuObject = gpuObject; }
-    GPUObject* getGPUObject() const { return _gpuObject; }
-    friend class Backend;
 };
 
 typedef std::shared_ptr< State > StatePointer;

libraries/gpu/src/gpu/Texture.h

@@ -136,7 +136,7 @@ protected:
     Desc _desc;
 };
 
-class Texture : public Resource {
+class Texture : public Resource, public GPUObjectWrapper {
 public:
 
     class Pixels {
@@ -386,13 +386,6 @@ protected:
     static Texture* create(Type type, const Element& texelFormat, uint16 width, uint16 height, uint16 depth, uint16 numSamples, uint16 numSlices, const Sampler& sampler);
 
     Size resize(Type type, const Element& texelFormat, uint16 width, uint16 height, uint16 depth, uint16 numSamples, uint16 numSlices);
-
-    // This shouldn't be used by anything else than the Backend class with the proper casting.
-    mutable GPUObject* _gpuObject = NULL;
-    void setGPUObject(GPUObject* gpuObject) const { _gpuObject = gpuObject; }
-    GPUObject* getGPUObject() const { return _gpuObject; }
-
-    friend class Backend;
 };
 
 typedef std::shared_ptr<Texture> TexturePointer;