From 1931293d20189005f558dcdcd78d7d35a04639a4 Mon Sep 17 00:00:00 2001 From: FuXiii Date: Mon, 11 Nov 2024 16:16:07 +0800 Subject: [PATCH 1/4] Add source\memo.rst for some item need remember --- source/Memory.rst | 5 +++++ source/memo.rst | 53 +++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 58 insertions(+) create mode 100644 source/memo.rst diff --git a/source/Memory.rst b/source/Memory.rst index acffef9..1ee07f3 100644 --- a/source/Memory.rst +++ b/source/Memory.rst @@ -927,6 +927,11 @@ VkMemoryPropertyFlagBits 具体如何进行内存同步将会在之后的章节进行讲解。 +.. + Vulkan 标准要求 + * 必须有一个内存类型同时包含 HOST_VISIBLE 和 HOST_COHERENT + * 必须有一个内存类型包含 DEVICE_LOCAL + 惰性内存 ^^^^^^^^^^^^^^^^^^^^ diff --git a/source/memo.rst b/source/memo.rst new file mode 100644 index 0000000..97380d0 --- /dev/null +++ b/source/memo.rst @@ -0,0 +1,53 @@ +备忘录 +========= + +``vkGetPhysicalDeviceMemoryProperties`` + +* 必须有一个内存类型同时包含 HOST_VISIBLE 和 HOST_COHERENT +* 必须有一个内存类型包含 DEVICE_LOCAL + +--- + +``VkMemoryHeapFlagBits`` 除了 ``Vulkan 1.0`` 的 ``DEVICE_LOCAL`` 外，还有一个 ``MULTI_INSTANCE`` ，表示：一个逻辑设备 ``VkDevice`` 代表多个物理设备，每一个物理设备的堆内存都会有一个这个 ``instance`` ，默认情况下，在这样的其中一个设备内存堆上分配，将会在每一个设备堆上都进行相同的操作。 + +--- + +memory_properties + + * VK_MEMORY_PROPERTY_HOST_CACHED_BIT 缓存是存在 ``host`` 端的，非缓存内存访问比缓存内存慢。缓存内存速度 > 费缓存。然而非缓存内存 ``总是`` ``host coherent`` （同步）的 + * VK_MEMORY_PROPERTY_LAZILY_BIT 表示只有 物理设备 可以访问该内存。拥有了该类型的内存 ``不可能`` 被 ``host`` 端访问了（HOST_VISIBLE、HOST_COHERENT 和 HOST_CACHED不可能出现了）。 + * VK_MEMORY_PROPERTY_PROTECTED_BIT 表示只有 物理设备 可以访问该内存，并且只有 保护队列 可操作该内存。拥有了该类型的内存 ``不可能`` 被 ``host`` 端访问了（HOST_VISIBLE、HOST_COHERENT 和 HOST_CACHED不可能出现了）。 + +--- + +BufferView + +.. code:: c++ + + // Provided by VK_VERSION_1_0 + typedef struct VkBufferViewCreateInfo { + VkStructureType sType; + const void* pNext; + VkBufferViewCreateFlags flags; + VkBuffer buffer; + VkFormat format; + VkDeviceSize offset; + VkDeviceSize range; + } VkBufferViewCreateInfo; + +``VkBuffer`` 必须创建于 ``VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT`` 和 ``VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT`` 最少是这两个中的一个，要么就两个都是。 + +``buffer`` 包含 ``VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT`` 创建的话， ``format`` 的 ``feature`` 必须包含 ``VK_FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT`` ( ``vkGetPhysicalDeviceFormatProperties(...) VkFormatProperties::bufferFeatures`` ) +``buffer`` 包含 ``VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT`` 创建的话， ``format`` 的 ``feature`` 必须包含 ``VK_FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT`` ( ``vkGetPhysicalDeviceFormatProperties(...) VkFormatProperties::bufferFeatures`` ) + +* 如果 ``buffer`` 不是 ``稀疏`` 资源的话，则他需要完全连续的绑定到一个单一的 ``VkDeviceMemory`` 对象上。 +* 如果 ``texelBufferAlignment`` 特性没有激活的话， ``offset`` 必须是 ``VkPhysicalDeviceLimits::minTexelBufferOffsetAlignment`` 的倍数。 +* 如果 ``texelBufferAlignment`` 特性激活，并且 ``buffer`` 中包含 ``VK_BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT`` 的话， +``offset`` 必须是 ``VkPhysicalDeviceLimits::storageTexelBufferOffsetAlignmentBytes`` 或 在 ``VkPhysicalDeviceTexelBufferAlignmentProperties::storageTexelBufferOffsetSingleTexelAlignment`` 为 ``VK_TRUE`` 的条件下， +格式要求的 ``texel`` 大小中的较小值。如果 ``texel`` 的大小是 ``3 byte`` 倍数，则使用格式中单组件（通道？）的大小？ + +* 如果 ``texelBufferAlignment`` 特性激活，并且 ``buffer`` 中包含 ``VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT`` 的话， +``offset`` 必须是 ``VkPhysicalDeviceLimits::uniformTexelBufferOffsetAlignmentBytes`` 或 在 ``VkPhysicalDeviceTexelBufferAlignmentProperties::uniformTexelBufferOffsetSingleTexelAlignment`` 为 ``VK_TRUE`` 的条件下， +格式要求的 ``texel`` 大小中的较小值。如果 ``texel`` 的大小是 ``3 byte`` 倍数，则使用格式中单组件（通道？）的大小？ + +BufferView 文档阅读完毕 \ No newline at end of file From cf98492860619468c4a3066ed72d5bacf50a6a2a Mon Sep 17 00:00:00 2001 From: FuXiii Date: Tue, 12 Nov 2024 17:27:52 +0800 Subject: [PATCH 2/4] Update source\memo.rst --- source/memo.rst | 35 ++++++++++++++++++++++++++++++++++- 1 file changed, 34 insertions(+), 1 deletion(-) diff --git a/source/memo.rst b/source/memo.rst index 97380d0..ae8dde4 100644 --- a/source/memo.rst +++ b/source/memo.rst @@ -50,4 +50,37 @@ BufferView ``offset`` 必须是 ``VkPhysicalDeviceLimits::uniformTexelBufferOffsetAlignmentBytes`` 或 在 ``VkPhysicalDeviceTexelBufferAlignmentProperties::uniformTexelBufferOffsetSingleTexelAlignment`` 为 ``VK_TRUE`` 的条件下， 格式要求的 ``texel`` 大小中的较小值。如果 ``texel`` 的大小是 ``3 byte`` 倍数，则使用格式中单组件（通道？）的大小？ -BufferView 文档阅读完毕 \ No newline at end of file +BufferView 文档阅读完毕 + +--- + +VkImageCreateInfo::arrayLayers + +``RTX 3070`` 显卡中 ``VkPhysicalDeviceLimits::maxImageArrayLayers`` 为 ``2048`` （标准要求最小为 ``256`` ，如果满足 ``Roadmap 2022`` 则最小为 ``2048``） + +* ``arrayLayers`` 必须要大于 ``0`` （不能为 ``0`` ） +* ``arrayLayers`` 必须小于等于 ``imageCreateMaxArrayLayers`` +* 如果 ``imageType`` 是 ``3D`` ， ``arrayLayers`` 必须是 ``1`` + +如果 ``tiling`` 是 ``LINEAR`` 的话，有如下要求： + +* ``imageType`` 是 ``2D`` +* ``format`` 不能是 ``depth/stencil`` 格式 +* ``mipLevel`` 是 ``1`` +* ``arrayLayers`` 是 ``1`` +* ``samples`` 是 ``COUNT_1_BIT`` +* ``usage`` 只能是 ``TRANSFER_SRC_BIT`` 和/或 ``TRANSFER_DST_BIT`` + +如果格式是 ``Y'CBCR`` ，有如下要求： + +* ``imageType`` 是 ``2D`` +* ``mipLevel`` 是 ``1`` +* ``arrayLayers`` 是 ``1`` ，要么就是 ``VkImageFormatProperties::maxArrayLayers`` +* ``samples`` 是 ``COUNT_1_BIT`` + +如果 ``flags`` 包含 ``VK_IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT`` ，有如下要求： + +* ``mipLevels`` 必须是 ``1`` +* ``arrayLayers`` 必须是 ``1`` +* ``imageType`` 必须是 ``VK_IMAGE_TYPE_2D`` +* ``imageCreateMaybeLinear`` 必须是 ``VK_FALSE`` From ae7b7fbed2ab714c5a6db52e3da70396f7ba3be8 Mon Sep 17 00:00:00 2001 From: FuXiii Date: Wed, 13 Nov 2024 17:31:25 +0800 Subject: [PATCH 3/4] Update source\memo.rst --- source/memo.rst | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) diff --git a/source/memo.rst b/source/memo.rst index ae8dde4..6108f81 100644 --- a/source/memo.rst +++ b/source/memo.rst @@ -52,6 +52,14 @@ BufferView BufferView 文档阅读完毕 +.. code-block:: glsl + + // Texture Buffer(Uniform Texel Buffers) + layout(set=m, binding=n) uniform textureBuffer myUniformTexelBuffer; + + // Texture Buffer(Storage Texel Buffers) + layout(set=m, binding=n, r32f) uniform imageBuffer myStorageTexelBuffer; + --- VkImageCreateInfo::arrayLayers @@ -84,3 +92,34 @@ VkImageCreateInfo::arrayLayers * ``arrayLayers`` 必须是 ``1`` * ``imageType`` 必须是 ``VK_IMAGE_TYPE_2D`` * ``imageCreateMaybeLinear`` 必须是 ``VK_FALSE`` + +--- + +VkPhysicalDeviceLiits::maxFramebufferWidth +VkPhysicalDeviceLiits::maxFramebufferHeight + +--- + +# VkImageView + +View 的 usage 是继承自 Image 的： + +* 如果 View 设置了 ``VkImageViewUsageCreateInfo`` 的话（pNext），可以覆写该 View 的 usage ，但必须是 image 的 usage 的子集。 +* 如果 image 是 depth-stencil 格式，并且使用 ``VkImageStencilUsageCreateInfo`` 创建的 image，View 的 usage 是依据 ``subresource.aspectMask`` 确定： + * 如果 ``aspectMask`` 只包含 ``VK_IMAGE_ASPECT_STENCILE_BIT`` ，这意味着 usage 使用 ``VkImageStencilUsageCreateInfo::stencilUsage`` 的配置 + * 如果 ``aspectMask`` 只包含 ``VK_IMAGE_ASPECT_DEPTH_BIT`` ，这意味着 usage 使用 ``VkImageCreateInfo::usage`` 的配置 + * 如果 ``aspectMask`` 中上述两个都包含，这意味着 usage 使用 ``VkImageCreateInfo::usage`` 和 ``VkImageStencilUsageCreateInfo::stencilUsage`` + +如果 image 创建的时候指定了 ``VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT`` ，并且 ``format`` 不是 ``multi-planar`` 的话， view 的 format 可以和 image 的 format 不同， +此外如果 image 没有使用 ``VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT`` 创建的话，view 的 format 可以和 image 的 format 不同，但需要 ``兼容`` 。 + +* ``VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT`` 表示 image 使用的压缩格式，并且该压缩格式可在 View 端进行解压缩 + +相互兼容格式的 View 将会在 纹素坐标-内存地址 之间具有相同的映射，这仅仅是二进制解释样式发生了改变。 + +如果 image 使用 ``VK_IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT`` 创建的话， View 的 format 必须与 image 的 format 相兼容，要么 view 的 format 必须是压缩格式，且必须是 size-comatible （大小相兼容的）。在这种情况下， +获取到的 view 的 texel 维度 = 四舍五入((选择的 mip 等级 / 压缩的 texel 块大小)) + +## VkImageView ComponentMap + +如果 view 用于 storage image/ input attachment / framebuffer attachment 和与 Y'CbCr 采样器相结合的 View，必须使用 一致性排列 （identify swizzle，也就是 ``VkComponentSwizzle::VK_COMPONENT_SWIZZLE_IDENTITY``）。 \ No newline at end of file From d8b3742b4cff9b591641054639246856acfef9e8 Mon Sep 17 00:00:00 2001 From: FuXiii Date: Fri, 15 Nov 2024 12:14:36 +0800 Subject: [PATCH 4/4] Update source\Application\VulkanTriangle.rst --- source/Application/VulkanTriangle.rst | 48 +++++++++++++++++++++++++-- source/Changelog.md | 4 +++ 2 files changed, 49 insertions(+), 3 deletions(-) diff --git a/source/Application/VulkanTriangle.rst b/source/Application/VulkanTriangle.rst index aa21f83..283515c 100644 --- a/source/Application/VulkanTriangle.rst +++ b/source/Application/VulkanTriangle.rst @@ -7,6 +7,7 @@ Vulkan 三角形 * 2024/11/7 增加该文章 * 2024/11/8 更新该文章 + * 2024/11/15 更新该文章。增加编译流程说明和 ``MacOS`` 适配。 .. sidebar:: @@ -41,6 +42,39 @@ Vulkan 三角形 * ``Windows`` * ``Linux`` + * ``MacOS`` + +0. 配置环境 + +.. tab-set:: + + .. tab-item:: Windows + + ``Visual Studio`` + + .. tab-item:: Linux + + 命令行中执行如下指令： + + .. code-block:: console + + sudo apt-get install libxrandr-dev + sudo apt-get install libxinerama-dev + sudo apt-get install libxcursor-dev + sudo apt-get install libxi-dev + sudo apt-get install freeglut3-dev + + .. tab-item:: MacOS + + 命令行中执行如下指令： + + .. code-block:: console + + brew install libxrandr + brew install libxinerama + brew install libxcursor + brew install libxi + brew install freeglut 1. 下载并解压 2. 在同级目录下创建 ``build`` 文件夹 @@ -59,9 +93,9 @@ Vulkan 三角形 .. tab-set:: - .. tab-item:: Visual Studio + .. tab-item:: Windows - 打开 ``build`` 文件夹下的 ``.sln`` 文件，编译执行即可。 + 使用 ``Visual Studio`` 打开 ``build`` 文件夹下的 ``.sln`` 文件，编译执行即可。 .. tab-item:: Linux @@ -69,4 +103,12 @@ Vulkan 三角形 .. code-block:: console - make \ No newline at end of file + make + + .. tab-item:: MacOS + + 命令行中执行如下指令即可： + + .. code-block:: console + + cmake --build . \ No newline at end of file diff --git a/source/Changelog.md b/source/Changelog.md index fa3b9e7..cff9125 100644 --- a/source/Changelog.md +++ b/source/Changelog.md @@ -4,6 +4,10 @@ 此更新日志为纵览更新，对于具体文章的更新位于每个文章的开头的 `更新记录` 中。 ``` +## 2024/11/15 + +>* 更新`Vulkan 三角形`工程文档 + ## 2024/11/8 >* 更新`Vulkan 三角形`工程文档