Zebediah Figura : include: Document that vkd3d_shader_signature may contain pointers into the input shader blob.

[Alexandre Julliard]

Module: vkd3d
Branch: master
Commit: 98624f2e8fdfa9e86218e1738f72a989503ef7f7
URL:    https://gitlab.winehq.org/wine/vkd3d/-/commit/98624f2e8fdfa9e86218e1738f72a9...

Author: Zebediah Figura <zfigura(a)codeweavers.com>
Date:   Wed Feb 22 17:41:12 2023 -0600

include: Document that vkd3d_shader_signature may contain pointers into the input shader blob.

---

 include/vkd3d_shader.h | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/include/vkd3d_shader.h b/include/vkd3d_shader.h
index ee8ce8d0..bf5e1387 100644
--- a/include/vkd3d_shader.h
+++ b/include/vkd3d_shader.h
@@ -1839,6 +1839,9 @@ VKD3D_SHADER_API void vkd3d_shader_free_scan_descriptor_info(
  * Members of \a signature may be allocated by vkd3d-shader. The signature
  * should be freed with vkd3d_shader_free_shader_signature() when no longer
  * needed.
+ * \n
+ * The signature may contain pointers into the input shader, and should only be
+ * accessed while the input shader remains valid.
  *
  * \param messages Optional output location for error or informational messages
  * produced by the parser.