[PATCH vkd3d 3/5] include: Document struct vkd3d_shader_compile_info and members.

[Henri Verbeet]

On Thu, 27 Aug 2020 at 23:21, Zebediah Figura <z.figura12 at gmail.com> wrote:
> >>  enum vkd3d_shader_compile_option_name
> >>  {
> >> +    /**
> >> +     * If \a value is nonzero, do not include debug information in the
> >> +     * compiled shader. The default value is zero.
> >> +     *
> >> +     * This option is supported by vkd3d_compiler. However, not all compilers
> >> +     * support generating debug information.
> >> +     */
> >>      VKD3D_SHADER_COMPILE_OPTION_STRIP_DEBUG = 0x00000001,
> > I'm not sure I understand the vkd3d_compiler (vkd3d-compiler?)
> > reference.
>
> That was an error for "vkd3d_shader_compile()".
>
> > For what it's worth, in the context of SPIR-V, debug
> > information is things like variable names (i.e., it gets you names
> > like "%main" instead of "%1"), and source information. We don't
> > currently use the latter, but we could embed the D3D assembly for the
> > source shader, which would probably help a little with debugging
> > SPIR-V shaders.
>
> Do you think it's a good idea to go into exact detail on what kind of
> debug information is included for each target, then? I kind of figured
> that'd be out of scope for this documentation.
>
Probably not, no. The above was mostly me trying to clarify what debug
information is stripped in practice, due to being confused by
"vkd3d_compiler".