Fix comment for setEnvInput()
authorGreg Fischer <greg@lunarg.com>
Tue, 25 Jan 2022 20:40:07 +0000 (13:40 -0700)
committerGreg Fischer <greg@lunarg.com>
Tue, 25 Jan 2022 20:40:07 +0000 (13:40 -0700)
Specifically, add text to clarify dialect and dialectVersion

Fixes #2872

glslang/Public/ShaderLang.h

index 7744abf..29b7535 100644 (file)
@@ -150,8 +150,8 @@ typedef enum {
 
 typedef enum {
     EShClientNone,               // use when there is no client, e.g. for validation
-    EShClientVulkan,
-    EShClientOpenGL,
+    EShClientVulkan,             // as GLSL dialect, specifies KHR_vulkan_glsl extension
+    EShClientOpenGL,             // as GLSL dialect, specifies ARB_gl_spirv extension
     LAST_ELEMENT_MARKER(EShClientCount),
 } EShClient;
 
@@ -518,6 +518,9 @@ public:
     //                 use EShClientNone and version of 0, e.g. for validation mode.
     //                 Note 'version' does not describe the target environment,
     //                 just the version of the source dialect to compile under.
+    //                 For example, to choose the Vulkan dialect of GLSL defined by
+    //                 version 100 of the KHR_vulkan_glsl extension: lang = EShSourceGlsl,
+    //                 dialect = EShClientVulkan, and version = 100.
     //
     //                 See the definitions of TEnvironment, EShSource, EShLanguage,
     //                 and EShClient for choices and more detail.