Refactored mipmap layout handling with introduction of dedicated vsg::MipmapLayout class.

CMakeLists.txt

@@ -1,11 +1,11 @@
 cmake_minimum_required(VERSION 3.7)
 
 project(vsg
-    VERSION 1.1.11
+    VERSION 1.1.12
     DESCRIPTION "VulkanSceneGraph library"
     LANGUAGES CXX
 )
-set(VSG_SOVERSION 14)
+set(VSG_SOVERSION 15)
 SET(VSG_RELEASE_CANDIDATE 0)
 set(Vulkan_MIN_VERSION 1.1.70.0)
 

include/vsg/all.h

@@ -27,6 +27,7 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
 #include <vsg/core/IntrusiveAllocator.h>
 #include <vsg/core/Mask.h>
 #include <vsg/core/MemorySlots.h>
+#include <vsg/core/MipmapLayout.h>
 #include <vsg/core/Object.h>
 #include <vsg/core/Objects.h>
 #include <vsg/core/ScratchMemory.h>

include/vsg/app/RecordTraversal.h

@@ -170,7 +170,6 @@ namespace vsg
         // clear the bins to record a new frame.
         void clearBins();
 
-
         // list of pairs of modelview matrix & region of interest
         std::vector<std::pair<dmat4, const RegionOfInterest*>> regionsOfInterest;
 

include/vsg/app/TransferTask.h

@@ -118,4 +118,7 @@ namespace vsg
     };
     VSG_type_name(vsg::TransferTask);
 
+    /// convenience function that uploads staging buffer data to device including mipmaps.
+    extern VSG_DECLSPEC void transferImageData(ref_ptr<ImageView> imageView, VkImageLayout targetImageLayout, Data::Properties properties, uint32_t width, uint32_t height, uint32_t depth, uint32_t mipLevels, ref_ptr<Buffer> stagingBuffer, VkDeviceSize stagingBufferOffset, VkCommandBuffer vk_commandBuffer, vsg::Device* device);
+
 } // namespace vsg

include/vsg/commands/CopyAndReleaseImage.h

@@ -40,7 +40,6 @@ namespace vsg
             uint32_t width = 0;
             uint32_t height = 0;
             uint32_t depth = 0;
-            Data::MipmapOffsets mipmapOffsets;
 
             void record(CommandBuffer& commandBuffer) const;
         };

include/vsg/core/Array.h

@@ -31,7 +31,6 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
 
 namespace vsg
 {
-
     template<typename T>
     class Array : public Data
     {
@@ -63,10 +62,14 @@ namespace vsg
             _data(_allocate(numElements)),
             _size(numElements) { dirty(); }
 
-        Array(uint32_t numElements, value_type* data, Properties in_properties = {}) :
+        Array(uint32_t numElements, value_type* data, Properties in_properties = {}, MipmapLayout* mipmapLayout = nullptr) :
             Data(in_properties, sizeof(value_type)),
             _data(data),
-            _size(numElements) { dirty(); }
+            _size(numElements)
+        {
+            setMipmapLayout(mipmapLayout);
+            dirty();
+        }
 
         Array(uint32_t numElements, const value_type& value, Properties in_properties = {}) :
             Data(in_properties, sizeof(value_type)),
@@ -77,12 +80,12 @@ namespace vsg
             dirty();
         }
 
-        Array(ref_ptr<Data> data, uint32_t offset, uint32_t stride, uint32_t numElements, Properties in_properties = {}) :
+        Array(ref_ptr<Data> data, uint32_t offset, uint32_t stride, uint32_t numElements, Properties in_properties = {}, MipmapLayout* mipmapLayout = nullptr) :
             Data(),
             _data(nullptr),
             _size(0)
         {
-            assign(data, offset, stride, numElements, in_properties);
+            assign(data, offset, stride, numElements, in_properties, mipmapLayout);
         }
 
         explicit Array(std::initializer_list<value_type> l) :
@@ -165,7 +168,10 @@ namespace vsg
 
             if (input.matchPropertyName("data"))
             {
-                size_t new_total_size = computeValueCountIncludingMipmaps(width_size, 1, 1, properties.maxNumMipmaps);
+                properties.stride = sizeof(value_type);
+                _size = width_size;
+                _storage = nullptr;
+                size_t new_total_size = computeValueCountIncludingMipmaps();
 
                 if (_data) // if data exists already may be able to reuse it
                 {
@@ -181,10 +187,6 @@ namespace vsg
                     _data = _allocate(new_total_size);
                 }
 
-                properties.stride = sizeof(value_type);
-                _size = width_size;
-                _storage = nullptr;
-
                 if (_data) input.read(new_total_size, _data);
 
                 dirty();
@@ -209,7 +211,7 @@ namespace vsg
             output.writeEndOfLine();
         }
 
-        size_t size() const { return (properties.maxNumMipmaps <= 1) ? _size : computeValueCountIncludingMipmaps(_size, 1, 1, properties.maxNumMipmaps); }
+        size_t size() const { return (properties.mipLevels <= 1) ? _size : computeValueCountIncludingMipmaps(); }
 
         bool available() const { return _data != nullptr; }
         bool empty() const { return _data == nullptr; }
@@ -229,7 +231,8 @@ namespace vsg
 
             clear();
 
-            properties = rhs.properties;
+            _copy(rhs);
+
             _size = rhs._size;
 
             if (_size != 0)
@@ -244,7 +247,7 @@ namespace vsg
             return *this;
         }
 
-        void assign(uint32_t numElements, value_type* data, Properties in_properties = {})
+        void assign(uint32_t numElements, value_type* data, Properties in_properties = {}, MipmapLayout* mipmapLayout = nullptr)
         {
             _delete();
 
@@ -254,10 +257,12 @@ namespace vsg
             _data = data;
             _storage = nullptr;
 
+            setMipmapLayout(mipmapLayout);
+
             dirty();
         }
 
-        void assign(ref_ptr<Data> storage, uint32_t offset, uint32_t stride, uint32_t numElements, Properties in_properties = {})
+        void assign(ref_ptr<Data> storage, uint32_t offset, uint32_t stride, uint32_t numElements, Properties in_properties = {}, MipmapLayout* mipmapLayout = nullptr)
         {
             _delete();
 
@@ -275,6 +280,8 @@ namespace vsg
                 _size = 0;
             }
 
+            setMipmapLayout(mipmapLayout);
+
             dirty();
         }
 
@@ -365,6 +372,8 @@ namespace vsg
                 else if (properties.allocatorType != 0)
                     vsg::deallocate(_data);
             }
+
+            _clear();
         }
 
     private:

include/vsg/core/Array2D.h

@@ -13,7 +13,6 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
 </editor-fold> */
 
 #include <vsg/core/Data.h>
-
 #include <vsg/maths/mat4.h>
 #include <vsg/maths/vec2.h>
 #include <vsg/maths/vec3.h>
@@ -68,11 +67,15 @@ namespace vsg
             dirty();
         }
 
-        Array2D(uint32_t width, uint32_t height, value_type* data, Properties in_properties = {}) :
+        Array2D(uint32_t width, uint32_t height, value_type* data, Properties in_properties = {}, MipmapLayout* mipmapLayout = nullptr) :
             Data(in_properties, sizeof(value_type)),
             _data(data),
             _width(width),
-            _height(height) { dirty(); }
+            _height(height)
+        {
+            setMipmapLayout(mipmapLayout);
+            dirty();
+        }
 
         Array2D(uint32_t width, uint32_t height, const value_type& value, Properties in_properties = {}) :
             Data(in_properties, sizeof(value_type)),
@@ -88,13 +91,13 @@ namespace vsg
             }
         }
 
-        Array2D(ref_ptr<Data> data, uint32_t offset, uint32_t stride, uint32_t width, uint32_t height, Properties in_properties = {}) :
+        Array2D(ref_ptr<Data> data, uint32_t offset, uint32_t stride, uint32_t width, uint32_t height, Properties in_properties = {}, MipmapLayout* mipmapLayout = nullptr) :
             Data(),
             _data(nullptr),
             _width(0),
             _height(0)
         {
-            assign(data, offset, stride, width, height, in_properties);
+            assign(data, offset, stride, width, height, in_properties, mipmapLayout);
         }
 
         template<typename... Args>
@@ -144,7 +147,12 @@ namespace vsg
 
             if (input.matchPropertyName("data"))
             {
-                size_t new_size = computeValueCountIncludingMipmaps(w, h, 1, properties.maxNumMipmaps);
+                properties.stride = sizeof(value_type);
+                _width = w;
+                _height = h;
+                _storage = nullptr;
+
+                size_t new_size = computeValueCountIncludingMipmaps();
 
                 if (_data) // if data exists already may be able to reuse it
                 {
@@ -159,11 +167,6 @@ namespace vsg
                     _data = _allocate(new_size);
                 }
 
-                properties.stride = sizeof(value_type);
-                _width = w;
-                _height = h;
-                _storage = nullptr;
-
                 if (_data) input.read(new_size, _data);
 
                 dirty();
@@ -190,7 +193,7 @@ namespace vsg
             output.writeEndOfLine();
         }
 
-        size_t size() const { return (properties.maxNumMipmaps <= 1) ? (static_cast<size_t>(_width) * static_cast<size_t>(_height)) : computeValueCountIncludingMipmaps(_width, _height, 1, properties.maxNumMipmaps); }
+        size_t size() const { return (properties.mipLevels <= 1) ? (static_cast<size_t>(_width) * static_cast<size_t>(_height)) : computeValueCountIncludingMipmaps(); }
 
         bool available() const { return _data != nullptr; }
         bool empty() const { return _data == nullptr; }
@@ -211,7 +214,8 @@ namespace vsg
 
             clear();
 
-            properties = rhs.properties;
+            _copy(rhs);
+
             _width = rhs._width;
             _height = rhs._height;
 
@@ -227,7 +231,7 @@ namespace vsg
             return *this;
         }
 
-        void assign(uint32_t width, uint32_t height, value_type* data, Properties in_properties = {})
+        void assign(uint32_t width, uint32_t height, value_type* data, Properties in_properties = {}, MipmapLayout* mipmapLayout = nullptr)
         {
             _delete();
 
@@ -238,10 +242,12 @@ namespace vsg
             _data = data;
             _storage = nullptr;
 
+            setMipmapLayout(mipmapLayout);
+
             dirty();
         }
 
-        void assign(ref_ptr<Data> storage, uint32_t offset, uint32_t stride, uint32_t width, uint32_t height, Properties in_properties = {})
+        void assign(ref_ptr<Data> storage, uint32_t offset, uint32_t stride, uint32_t width, uint32_t height, Properties in_properties = {}, MipmapLayout* mipmapLayout = nullptr)
         {
             _delete();
 
@@ -261,6 +267,8 @@ namespace vsg
                 _height = 0;
             }
 
+            setMipmapLayout(mipmapLayout);
+
             dirty();
         }
 
@@ -360,6 +368,8 @@ namespace vsg
                 else if (properties.allocatorType != 0)
                     vsg::deallocate(_data);
             }
+
+            _clear();
         }
 
     private: