Module: vkd3d
Branch: master
Commit: 72e8b6e0dce8e0422483f69e3e9a18e3a8414e9c
URL: https://gitlab.winehq.org/wine/vkd3d/-/commit/72e8b6e0dce8e0422483f69e3e9a1…
Author: Zebediah Figura <zfigura(a)codeweavers.com>
Date: Mon Oct 9 17:15:11 2023 -0500
include: Fix some confusingly structured documentation.
Fixes: 7a4ae434dfa4cccc1e832455133930066d2ab575.
---
include/vkd3d_shader.h | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/include/vkd3d_shader.h b/include/vkd3d_shader.h
index 9d0d768b..f112e7c7 100644
--- a/include/vkd3d_shader.h
+++ b/include/vkd3d_shader.h
@@ -1387,7 +1387,10 @@ struct vkd3d_shader_descriptor_info
* as follows:
*
* - Each constant register set used by the shader is scanned as a single
- * constant buffer descriptor, as follows:
+ * constant buffer descriptor.
+ * There may therefore be up to three such descriptors, one for each register
+ * set used by the shader: float, integer, and boolean.
+ * The fields are set as follows:
* * The \ref vkd3d_shader_descriptor_info.type field is set to
* VKD3D_SHADER_DESCRIPTOR_TYPE_CBV.
* * The \ref vkd3d_shader_descriptor_info.register_space field is set to zero.
@@ -1407,9 +1410,6 @@ struct vkd3d_shader_descriptor_info
* * The \ref vkd3d_shader_descriptor_info.register_index field is set to the
* binding index of the original sampler, for both descriptors.
* * The \ref vkd3d_shader_descriptor_info.count field is set to one.
- *
- * In summary, there may be up to three such descriptors, one for each register
- * set used by the shader: float, integer, and boolean.
*/
struct vkd3d_shader_scan_descriptor_info
{
Module: vkd3d
Branch: master
Commit: 7a4ae434dfa4cccc1e832455133930066d2ab575
URL: https://gitlab.winehq.org/wine/vkd3d/-/commit/7a4ae434dfa4cccc1e83245513393…
Author: Zebediah Figura <zfigura(a)codeweavers.com>
Date: Tue Mar 7 18:05:09 2023 -0600
include: Define an API for mapping sm1 samplers to the target environment.
---
include/vkd3d_shader.h | 34 ++++++++++++++++++++++++----------
1 file changed, 24 insertions(+), 10 deletions(-)
diff --git a/include/vkd3d_shader.h b/include/vkd3d_shader.h
index 01356ce3..9d0d768b 100644
--- a/include/vkd3d_shader.h
+++ b/include/vkd3d_shader.h
@@ -1383,16 +1383,30 @@ struct vkd3d_shader_descriptor_info
*
* This structure extends vkd3d_shader_compile_info.
*
- * When scanning a legacy Direct3D shader, vkd3d-shader enumerates each
- * constant register set used by the shader as a single constant buffer
- * descriptor, as follows:
- * - The \ref vkd3d_shader_descriptor_info.type field is set to
- * VKD3D_SHADER_DESCRIPTOR_TYPE_CBV.
- * - The \ref vkd3d_shader_descriptor_info.register_space field is set to zero.
- * - The \ref vkd3d_shader_descriptor_info.register_index field is set to a
- * member of enum vkd3d_shader_d3dbc_constant_register denoting which set
- * is used.
- * - The \ref vkd3d_shader_descriptor_info.count field is set to one.
+ * When scanning a legacy Direct3D shader, vkd3d-shader enumerates descriptors
+ * as follows:
+ *
+ * - Each constant register set used by the shader is scanned as a single
+ * constant buffer descriptor, as follows:
+ * * The \ref vkd3d_shader_descriptor_info.type field is set to
+ * VKD3D_SHADER_DESCRIPTOR_TYPE_CBV.
+ * * The \ref vkd3d_shader_descriptor_info.register_space field is set to zero.
+ * * The \ref vkd3d_shader_descriptor_info.register_index field is set to a
+ * member of enum vkd3d_shader_d3dbc_constant_register denoting which set
+ * is used.
+ * * The \ref vkd3d_shader_descriptor_info.count field is set to one.
+ * - Each sampler used by the shader is scanned as two separate descriptors,
+ * one representing the texture, and one representing the sampler state.
+ * If desired, these may be mapped back into a single combined sampler using
+ * struct vkd3d_shader_combined_resource_sampler.
+ * The fields are set as follows:
+ * * The \ref vkd3d_shader_descriptor_info.type field is set to
+ * VKD3D_SHADER_DESCRIPTOR_TYPE_SRV and VKD3D_SHADER_DESCRIPTOR_TYPE_SAMPLER
+ * respectively.
+ * * The \ref vkd3d_shader_descriptor_info.register_space field is set to zero.
+ * * The \ref vkd3d_shader_descriptor_info.register_index field is set to the
+ * binding index of the original sampler, for both descriptors.
+ * * The \ref vkd3d_shader_descriptor_info.count field is set to one.
*
* In summary, there may be up to three such descriptors, one for each register
* set used by the shader: float, integer, and boolean.