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

This commit is contained in:
Zebediah Figura 2023-02-22 17:41:12 -06:00 committed by Alexandre Julliard
parent bb2fa97c33
commit 98624f2e8f
Notes: Alexandre Julliard 2023-03-08 21:51:31 +01:00
Approved-by: Giovanni Mascellani (@giomasce)
Approved-by: Henri Verbeet (@hverbeet)
Approved-by: Alexandre Julliard (@julliard)
Merge-Request: https://gitlab.winehq.org/wine/vkd3d/-/merge_requests/112

View File

@ -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.