// Copyright 2019 The Dawn & Tint Authors // // Redistribution and use in source and binary forms, with or without // modification, are permitted provided that the following conditions are met: // // 1. Redistributions of source code must retain the above copyright notice, this // list of conditions and the following disclaimer. // // 2. Redistributions in binary form must reproduce the above copyright notice, // this list of conditions and the following disclaimer in the documentation // and/or other materials provided with the distribution. // // 3. Neither the name of the copyright holder nor the names of its // contributors may be used to endorse or promote products derived from // this software without specific prior written permission. // // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE // DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE // FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL // DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR // SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER // CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, // OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. #ifndef SRC_DAWN_NATIVE_VULKAN_UTILSVULKAN_H_ #define SRC_DAWN_NATIVE_VULKAN_UTILSVULKAN_H_ #include <string> #include <vector> #include "dawn/common/StackAllocated.h" #include "dawn/common/vulkan_platform.h" #include "dawn/native/Commands.h" #include "dawn/native/dawn_platform.h" namespace dawn::native { struct ProgrammableStage; OverrideScalar; } // namespace dawn::native namespace dawn::native::vulkan { class Device; struct VulkanFunctions; // A Helper type used to build a pNext chain of extension structs. // Usage is: // 1) Create instance, passing the address of the first struct in the chain. This requires // pNext to be nullptr. If you already have a chain you need to pass a pointer to the tail // of it. // // 2) Call Add(&vk_struct) every time a new struct needs to be appended to the chain. // // 3) Alternatively, call Add(&vk_struct, VK_STRUCTURE_TYPE_XXX) to initialize the struct // with a given VkStructureType value while appending it to the chain. // // Examples: // VkPhysicalFeatures2 features2 = { // .sType = VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_FEATURES_2, // .pNext = nullptr, // }; // // PNextChainBuilder featuresChain(&features2); // // featuresChain.Add(&featuresExtensions.subgroupSizeControl, // VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_SUBGROUP_SIZE_CONTROL_FEATURES_EXT); // // Note: // The build option `use_asan_unowned_ptr` checks the pointer to the current // tail it is not dangling. So every structs in the chain must be declared // before `PNextChainBuilder`. // struct PNextChainBuilder : public StackAllocated { … }; VkCompareOp ToVulkanCompareOp(wgpu::CompareFunction op); VkFilter ToVulkanSamplerFilter(wgpu::FilterMode filter); VkImageAspectFlags VulkanAspectMask(const Aspect& aspects); Extent3D ComputeTextureCopyExtent(const TextureCopy& textureCopy, const Extent3D& copySize); VkBufferImageCopy ComputeBufferImageCopyRegion(const BufferCopy& bufferCopy, const TextureCopy& textureCopy, const Extent3D& copySize); VkBufferImageCopy ComputeBufferImageCopyRegion(const TextureDataLayout& dataLayout, const TextureCopy& textureCopy, const Extent3D& copySize); // Gets the associated VkObjectType for any non-dispatchable handle template <class HandleType> VkObjectType GetVkObjectType(HandleType handle); void SetDebugNameInternal(Device* device, VkObjectType objectType, uint64_t objectHandle, const char* prefix, std::string label); // The majority of Vulkan handles are "non-dispatchable". Dawn wraps these by overriding // VK_DEFINE_NON_DISPATCHABLE_HANDLE to add some capabilities like making null comparisons // easier. In those cases we can make setting the debug name a bit easier by getting the // object type automatically and handling the indirection to the native handle. template <typename Tag, typename HandleType> void SetDebugName(Device* device, detail::VkHandle<Tag, HandleType> objectHandle, const char* prefix, std::string label = "") { … } // Handles like VkQueue and VKDevice require a special path because they are dispatchable, so // they require an explicit VkObjectType and cast to a uint64_t directly rather than by getting // the non-dispatchable wrapper's underlying handle. template <typename HandleType> void SetDebugName(Device* device, VkObjectType objectType, HandleType objectHandle, const char* prefix, std::string label = "") { … } std::string GetNextDeviceDebugPrefix(); std::string GetDeviceDebugPrefixFromDebugName(const char* debugName); // Get the properties for the given format. // https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VkDrmFormatModifierPropertiesEXT.html std::vector<VkDrmFormatModifierPropertiesEXT> GetFormatModifierProps( const VulkanFunctions& fn, VkPhysicalDevice vkPhysicalDevice, VkFormat format); // Get the properties for the (format, modifier) pair. // https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VkDrmFormatModifierPropertiesEXT.html ResultOrError<VkDrmFormatModifierPropertiesEXT> GetFormatModifierProps( const VulkanFunctions& fn, VkPhysicalDevice vkPhysicalDevice, VkFormat format, uint64_t modifier); ResultOrError<VkSamplerYcbcrConversion> CreateSamplerYCbCrConversionCreateInfo( YCbCrVkDescriptor yCbCrDescriptor, Device* device); } // namespace dawn::native::vulkan #endif // SRC_DAWN_NATIVE_VULKAN_UTILSVULKAN_H_