Module: vkd3d Branch: master Commit: a1ebb3925bbeb37cae1aa22d426c13d7db0969fa URL: https://gitlab.winehq.org/wine/vkd3d/-/commit/a1ebb3925bbeb37cae1aa22d426c13... Author: Giovanni Mascellani <gmascellani(a)codeweavers.com> Date: Sat Apr 20 23:36:17 2024 +0200 include: Document struct vkd3d_structure_type. --- include/vkd3d.h | 24 ++++++++++++++++++++---- 1 file changed, 20 insertions(+), 4 deletions(-) diff --git a/include/vkd3d.h b/include/vkd3d.h index c2b6877c..d72a7b38 100644 --- a/include/vkd3d.h +++ b/include/vkd3d.h @@ -46,21 +46,37 @@ extern "C" { * \since 1.0 */ +/** The type of a chained structure. */ enum vkd3d_structure_type { - /* 1.0 */ + /** The structure is a vkd3d_instance_create_info structure. */ VKD3D_STRUCTURE_TYPE_INSTANCE_CREATE_INFO, + /** The structure is a vkd3d_device_create_info structure. */ VKD3D_STRUCTURE_TYPE_DEVICE_CREATE_INFO, + /** The structure is a vkd3d_image_resource_create_info structure. */ VKD3D_STRUCTURE_TYPE_IMAGE_RESOURCE_CREATE_INFO, - /* 1.1 */ + /** + * The structure is a vkd3d_optional_instance_extensions_info structure. + * \since 1.1 + */ VKD3D_STRUCTURE_TYPE_OPTIONAL_INSTANCE_EXTENSIONS_INFO, - /* 1.2 */ + /** + * The structure is a vkd3d_optional_device_extensions_info structure. + * \since 1.2 + */ VKD3D_STRUCTURE_TYPE_OPTIONAL_DEVICE_EXTENSIONS_INFO, + /** + * The structure is a vkd3d_application_info structure. + * \since 1.2 + */ VKD3D_STRUCTURE_TYPE_APPLICATION_INFO, - /* 1.3 */ + /** + * The structure is a vkd3d_host_time_domain_info structure. + * \since 1.3 + */ VKD3D_STRUCTURE_TYPE_HOST_TIME_DOMAIN_INFO, VKD3D_FORCE_32_BIT_ENUM(VKD3D_STRUCTURE_TYPE),