[PATCH vkd3d] include: Clarify that struct vkd3d_shader_code is not null-terminated.

15 Oct 2020

Signed-off-by: Zebediah Figura <zfigura(a)codeweavers.com>
---
 include/vkd3d_shader.h | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/include/vkd3d_shader.h b/include/vkd3d_shader.h
index b677d365..c168621a 100644
--- a/include/vkd3d_shader.h
+++ b/include/vkd3d_shader.h
@@ -155,7 +155,13 @@ enum vkd3d_shader_visibility
 /** A generic structure containing a GPU shader, in text or byte-code format. */
 struct vkd3d_shader_code
 {
-    /** Pointer to the code. */
+    /**
+     * Pointer to the code. Note that textual formats are not null-terminated.
+     * Therefore \a size should not include a null terminator, when this
+     * structure is passed as input to a vkd3d-shader function, and the
+     * allocated string will not include a null terminator when this structure
+     * is used as output.
+     */
     const void *code;
     /** Size of \a code, in bytes. */
     size_t size;
-- 
2.28.0

    

Zebediah Figura