Merge branch 'master' into wayland-latest2

Author: robertosfield

CMakeLists.txt

@@ -1,11 +1,11 @@
 cmake_minimum_required(VERSION 3.10)
 
 project(vsg
-    VERSION 1.1.13
+    VERSION 1.1.14
     DESCRIPTION "VulkanSceneGraph library"
     LANGUAGES C CXX
 )
-set(VSG_SOVERSION 15)
+set(VSG_SOVERSION 16)
 SET(VSG_RELEASE_CANDIDATE 0)
 
 set(Vulkan_MIN_VERSION 1.1.70.0)
@@ -83,6 +83,8 @@ if (VSG_SUPPORTS_Windowing)
         set(FIND_DEPENDENCY_WINDOWING "find_library(COCOA_LIBRARY Cocoa)\nfind_library(QUARTZCORE_LIBRARY QuartzCore)\n")
         find_library(COCOA_LIBRARY Cocoa)
         find_library(QUARTZCORE_LIBRARY QuartzCore)
+    elseif (DEFINED OHOS_ARCH)  # OpenHarmony
+        set(FIND_DEPENDENCY_WINDOWING "")
     elseif (UNIX)
         if(BUILD_WAYLAND)
             set(FIND_DEPENDENCY_WINDOWING "find_package(PkgConfig REQUIRED)\npkg_check_modules(wayland-client REQUIRED IMPORTED_TARGET wayland-client)\npkg_check_modules(wayland-cursor REQUIRED IMPORTED_TARGET wayland-cursor)\npkg_check_modules(xkbcommon REQUIRED IMPORTED_TARGET xkbcommon)\n")

include/vsg/app/CompileManager.h

@@ -30,7 +30,7 @@ namespace vsg
         Slots maxSlots;
         bool containsPagedLOD = false;
         ResourceRequirements::Views views;
-        ResourceRequirements::DynamicData dynamicData;
+        DynamicData dynamicData;
 
         explicit operator bool() const noexcept { return result == VK_SUCCESS; }
 

include/vsg/app/TransferTask.h

@@ -51,7 +51,7 @@ namespace vsg
 
         ref_ptr<Device> device;
 
-        void assign(const ResourceRequirements::DynamicData& dynamicData);
+        void assign(const DynamicData& dynamicData);
         void assign(const BufferInfoList& bufferInfoList);
         void assign(const ImageInfoList& imageInfoList);
 

include/vsg/app/Viewer.h

@@ -104,7 +104,7 @@ namespace vsg
         /// pass the Events into any registered EventHandlers
         virtual void handleEvents();
 
-        virtual void compile(ref_ptr<ResourceHints> hints = {});
+        virtual CompileResult compile(ref_ptr<ResourceHints> hints = {});
 
         virtual bool acquireNextFrame();
 

include/vsg/platform/harmony/Harmony_Window.h

@@ -0,0 +1,101 @@
+#pragma once
+
+/* <editor-fold desc="MIT License">
+
+Copyright(c) 2025 Robert Osfield
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+</editor-fold> */
+
+#define VK_USE_PLATFORM_OHOS
+
+#include <vsg/app/Window.h>
+#include <vsg/ui/KeyEvent.h>
+
+// Forward declaration for OHOS native window type
+struct NativeWindow;
+typedef struct NativeWindow OHNativeWindow;
+
+// Forward declaration for OHOS ArkUI event type
+struct ArkUI_NodeEvent;
+
+namespace vsgHarmony
+{
+    typedef struct {
+        bool capsLock;
+        bool numLock;
+        bool shiftPressed;
+        bool ctrlPressed;
+        bool altPressed;
+    } KeyMetaState;
+
+    /// KeyboardMap maps OpenHarmony keyboard events to vsg::KeySymbol
+    class KeyboardMap : public vsg::Object
+    {
+    public:
+        KeyboardMap();
+
+        using KeyCodeToKeySymbolMap = std::map<uint32_t, vsg::KeySymbol>;
+
+        bool getKeySymbol(uint32_t keycode, KeyMetaState* KeyMetaState, vsg::KeySymbol& keySymbol, vsg::KeySymbol& modifiedKeySymbol, vsg::KeyModifier& keyModifier);
+
+    protected:
+        KeyCodeToKeySymbolMap _keycodeMap;
+    };
+
+    /// Harmony_Window implements OpenHarmony specific window creation, event handling and vulkan Surface setup.
+    ///
+    /// In order to initialise the window, an OHNativeWindow* handle must be provided through WindowTraits,
+    /// provided via the value "nativeWindow".
+    ///
+    /// ```
+    /// // void OH_main(struct OH_NativeActivity* activity)
+    /// auto traits = vsg::WindowTraits::create();
+    /// traits->setValue("nativeWindow", activity->window);
+    /// auto window = vsg::Window::create(traits);
+    /// ```
+    ///
+    /// This window handle may also be provided through WindowTraits::nativeWindow however due to
+    /// the way OpenHarmony loads shared libraries this is likely to encounter duplicate typeinfo for
+    /// OHNativeWindow, and as a result can throw a std::bad_any_cast on later SDK versions and some
+    /// system architectures.
+    class Harmony_Window : public vsg::Inherit<vsg::Window, Harmony_Window>
+    {
+    public:
+        Harmony_Window(vsg::ref_ptr<vsg::WindowTraits> traits);
+        Harmony_Window() = delete;
+        Harmony_Window(const Harmony_Window&) = delete;
+        Harmony_Window operator=(const Harmony_Window&) = delete;
+
+        const char* instanceExtensionSurfaceName() const override { return "VK_OHOS_surface"; }
+
+        bool valid() const override { return _window; }
+
+        bool pollEvents(vsg::UIEvents& events) override;
+
+        void resize() override;
+
+        bool handleOHOSInputEvent(ArkUI_NodeEvent* event);
+
+    protected:
+        virtual ~Harmony_Window();
+
+        void _initSurface() override;
+
+        OHNativeWindow* _window = nullptr;
+
+        int64_t _first_ohos_timestamp = 0;
+        vsg::clock::time_point _first_ohos_time_point;
+
+        vsg::ref_ptr<KeyboardMap> _keyboard;
+        KeyMetaState _keyMetaState;
+    };
+
+} // namespace vsgHarmony
+
+EVSG_type_name(vsgHarmony::Harmony_Window);

include/vsg/state/BufferInfo.h

@@ -38,6 +38,9 @@ namespace vsg
 
         void release();
 
+        /// compute size of associated data
+        VkDeviceSize computeDataSize() const;
+
         /// Copy data to the VkBuffer(s) for all Devices associated with vsg::Buffer
         /// Requires associated buffer memory to be host visible, for non host visible buffers you must use a staging buffer
         void copyDataToBuffer();

include/vsg/state/Image.h

@@ -67,8 +67,9 @@ namespace vsg
         /// return true if the Image's data has been modified and should be copied to the buffer, updating the device specific ModifiedCount to the Data's ModifiedCount.
         bool syncModifiedCount(uint32_t deviceID) { return data && data->getModifiedCount(_vulkanData[deviceID].copiedModifiedCount); }
 
-        virtual void compile(Device* device);
-        virtual void compile(Context& context);
+        virtual VkResult compile(Device* device);
+        virtual VkResult compile(Context& context);
+        virtual VkResult compile(MemoryBufferPools& memoryBufferPools);
 
     protected:
         virtual ~Image();

include/vsg/state/ImageInfo.h

@@ -47,6 +47,9 @@ namespace vsg
         ref_ptr<ImageView> imageView;
         VkImageLayout imageLayout = VK_IMAGE_LAYOUT_UNDEFINED;
 
+        /// compute size of associated data
+        VkDeviceSize computeDataSize() const;
+
         /// return true if the ImageInfo's data has been modified and should be copied to the buffer
         bool requiresCopy(uint32_t deviceID) const
         {

include/vsg/state/ResourceHints.h

@@ -13,6 +13,8 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
 </editor-fold> */
 
 #include <vsg/maths/vec2.h>
+#include <vsg/state/BufferInfo.h>
+#include <vsg/state/ImageInfo.h>
 #include <vsg/vk/DescriptorPool.h>
 
 namespace vsg
@@ -30,6 +32,26 @@ namespace vsg
         DYNAMIC_VIEWPORTSTATE = 1 << 1
     };
 
+    struct DynamicData
+    {
+        BufferInfoList bufferInfos;
+        ImageInfoList imageInfos;
+
+        explicit operator bool() const noexcept { return !bufferInfos.empty() || !imageInfos.empty(); }
+
+        void clear()
+        {
+            bufferInfos.clear();
+            imageInfos.clear();
+        }
+
+        void add(const DynamicData& dd)
+        {
+            bufferInfos.insert(bufferInfos.end(), dd.bufferInfos.begin(), dd.bufferInfos.end());
+            imageInfos.insert(imageInfos.end(), dd.imageInfos.begin(), dd.imageInfos.end());
+        }
+    };
+
     /// ResourceHints provides settings that help preallocation of Vulkan resources and memory.
     class VSG_DECLSPEC ResourceHints : public Inherit<Object, ResourceHints>
     {
@@ -56,6 +78,15 @@ namespace vsg
         DataTransferHint dataTransferHint = COMPILE_TRAVERSAL_USE_TRANSFER_TASK;
         uint32_t viewportStateHint = DYNAMIC_VIEWPORTSTATE;
 
+        DynamicData dynamicData;
+
+        bool containsPagedLOD = false;
+
+        /// Ratio of available device memory that can be allocated.
+        /// Ratios less than 1.0 require VK_EXT_memory_budget extension to be supported.
+        /// Ratio of 1.0 (or greater) will switch off checks for available memory and keep allocating till Vulkan memory allocations fail.
+        double allocatedMemoryLimit = 1.0;
+
     public:
         void read(Input& input) override;
         void write(Output& output) const override;

include/vsg/vk/Context.h

@@ -87,7 +87,7 @@ namespace vsg
         ref_ptr<CommandBuffer> getOrCreateCommandBuffer();
 
         /// reserve resources that may be needed during compile traversal.
-        void reserve(const ResourceRequirements& requirements);
+        VkResult reserve(ResourceRequirements& requirements);
 
         ref_ptr<DescriptorSet::Implementation> allocateDescriptorSet(DescriptorSetLayout* descriptorSetLayout);