Giovanni Mascellani : include: Document structure vkd3d_optional_device_extensions_info.

[Alexandre Julliard]

Module: vkd3d
Branch: master
Commit: 2679b10fcbd041460baeb4ef9de05d82eb4b4e3c
URL:    https://gitlab.winehq.org/wine/vkd3d/-/commit/2679b10fcbd041460baeb4ef9de05d...

Author: Giovanni Mascellani 
Date:   Sun Apr 21 19:45:49 2024 +0200

include: Document structure vkd3d_optional_device_extensions_info.

---

include/vkd3d.h | 15 ++++++++++++++-
 1 file changed, 14 insertions(+), 1 deletion(-)

diff --git a/include/vkd3d.h b/include/vkd3d.h
index b8584b68..6b44b3c8 100644
--- a/include/vkd3d.h
+++ b/include/vkd3d.h
@@ -290,13 +290,26 @@ struct vkd3d_device_create_info
     LUID adapter_luid;
 };

-/* Extends vkd3d_device_create_info. Available since 1.2. */
+/**
+ * A chained structure to specify optional device extensions.
+ *
+ * This structure extends vkd3d_device_create_info.
+ *
+ * \since 1.2
+ */
 struct vkd3d_optional_device_extensions_info
 {
+    /** Must be set to VKD3D_STRUCTURE_TYPE_OPTIONAL_DEVICE_EXTENSIONS_INFO. */
     enum vkd3d_structure_type type;
+    /** Optional pointer to a structure containing further parameters. */
     const void *next;

+    /**
+     * A list of optional Vulkan device extensions to request. Device creation does not fail if
+     * they are not available.
+     */
     const char * const *extensions;
+    /** The number of elements in the extensions array. */
     uint32_t extension_count;
 };