Ahh! Okay. I plan to make the change to the documentation shown below. Please review.

I realized in investigating this that ktxVulkanDeviceInfo has no knowledge of the queue family index of the queue - I can't find any way to query it when I only have the VkQueue handle - so there is no way that ktxTexture_VkUploadEx can be modified to create shared images. It looks like at some point I'll have to add some new functions. So far nobody has requested shared image support.

diff --git a/lib/vkloader.c b/lib/vkloader.c
index eeabf490..2940aeb9 100644
--- a/lib/vkloader.c
+++ b/lib/vkloader.c
@@ -183,6 +183,19 @@ ktxVulkanDeviceInfo_Construct(ktxVulkanDeviceInfo* This,
  * device memory properties for ease of use when allocating device memory for
  * the images.
  *
+ * If @c VK_IMAGE_TILING_OPTIMAL will be passed to ktxTexture_VkUploadEx(), the
+ * family of the @a queue parameter must support transfers. This is true if
+ * any of @c VK_QUEUE_GRAPHICS_BIT, @c VK_QUEUE_COMPUTE_BIT or
+ * @c VK_QUEUE_TRANSFER_BIT is set in the @c queueFlags property of the queue's
+ * @c VkQueueFamilyProperties. If protected memory is being used, i.e
+ * @c queueFlags has @c VK_QUEUE_PROTECTED_BIT set, then
+ * @c VK_IMAGE_TILING_OPTIMAL must be passed to ktxTexture_VkUploadEx().
+ *
+ * All VkImages and intermediate VkBuffers used in VkUploadEx() will be created
+ * with @c VK_SHARING_MODE_EXCLUSIVE set so the queue family index property
+ * of their CreateInfo structures is ignored.
+ * of their CreateInfo structures is ignored.
+ *
  * Pass a valid ktxVulkanDeviceInfo* to any Vulkan KTX image loading
  * function to provide it with the information.
  *
@@ -344,7 +357,7 @@ do {                             \
     result = This->vkFuncs.vkAllocateCommandBuffers(device, &cmdBufInfo,
                                                     &This->cmdBuffer);
     if (result != VK_SUCCESS) {
-        return KTX_OUT_OF_MEMORY; // XXX Consider an equivalent to pGlError
+        return KTX_OUT_OF_MEMORY; // TODO: Consider an equivalent to pGlError
     }
     return KTX_SUCCESS;

VkQueue flags #627

Description

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions