Giovanni Mascellani : include: Document structure vkd3d_host_time_domain_info.

[Alexandre Julliard]

Module: vkd3d
Branch: master
Commit: 7fbd753cf7f4585d14d144b2dcf03892855c2687
URL:    https://gitlab.winehq.org/wine/vkd3d/-/commit/7fbd753cf7f4585d14d144b2dcf038...

Author: Giovanni Mascellani 
Date:   Sun Apr 21 00:01:03 2024 +0200

include: Document structure vkd3d_host_time_domain_info.

---

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

diff --git a/include/vkd3d.h b/include/vkd3d.h
index 46867d73..c350c5ea 100644
--- a/include/vkd3d.h
+++ b/include/vkd3d.h
@@ -214,12 +214,26 @@ struct vkd3d_application_info
     enum vkd3d_api_version api_version;
 };

-/* Extends vkd3d_instance_create_info. Available since 1.3. */
+/**
+ * A chained structure to specify the host time domain.
+ *
+ * This structure extends vkd3d_instance_create_info.
+ *
+ * \since 1.3
+ */
 struct vkd3d_host_time_domain_info
 {
+    /** Must be set to VKD3D_STRUCTURE_TYPE_HOST_TIME_DOMAIN_INFO. */
     enum vkd3d_structure_type type;
+    /** Optional pointer to a structure containing further parameters. */
     const void *next;

+    /**
+     * The number of clock ticks per second, used for GetClockCalibration(). It should normally
+     * match the expected result of QueryPerformanceFrequency(). If this chained structure is not
+     * used then 10 millions is used, which means that each tick is a tenth of microsecond, or
+     * equivalently 100 nanoseconds.
+     */
     uint64_t ticks_per_second;
 };