Skip to content

G
glslang
Commit ade8bbbf by John Kessenich
Options

Fix #1393: rationalize usage, in the spirit of #1393.

Order is kept about the same.
parent ec5c1193
Showing with 63 additions and 62 deletions
StandAlone/StandAlone.cpp
...@@ -1326,22 +1326,22 @@ void usage() ...@@ -1326,22 +1326,22 @@ void usage()
"\n" "\n"
"Options:\n" "Options:\n"
" -C cascading errors; risk crash from accumulation of error recoveries\n" " -C cascading errors; risk crash from accumulation of error recoveries\n"
" -D input is HLSL (default when any suffix is .hlsl)\n" " -D input is HLSL (this is the default when any suffix is .hlsl)\n"
" -D<macro=def>\n" " -D<macro=def>\n"
" -D<macro> define a pre-processor macro\n" " -D<macro> define a pre-processor macro\n"
" -E print pre-processed GLSL; cannot be used with -l;\n" " -E print pre-processed GLSL; cannot be used with -l;\n"
" errors will appear on stderr.\n" " errors will appear on stderr\n"
" -G[ver] create SPIR-V binary, under OpenGL semantics; turns on -l;\n" " -G[ver] create SPIR-V binary, under OpenGL semantics; turns on -l;\n"
" default file name is <stage>.spv (-o overrides this)\n" " default file name is <stage>.spv (-o overrides this);\n"
" 'ver', when present, is the version of the input semantics,\n" " 'ver', when present, is the version of the input semantics,\n"
" which will appear in #define GL_SPIRV ver\n" " which will appear in #define GL_SPIRV ver;\n"
" '--client opengl100' is the same as -G100\n" " '--client opengl100' is the same as -G100;\n"
" a '--target-env' for OpenGL will also imply '-G'\n" " a '--target-env' for OpenGL will also imply '-G'\n"
" -H print human readable form of SPIR-V; turns on -V\n" " -H print human readable form of SPIR-V; turns on -V\n"
" -I<dir> add dir to the include search path; includer's directory\n" " -I<dir> add dir to the include search path; includer's directory\n"
" is searched first, followed by left-to-right order of -I\n" " is searched first, followed by left-to-right order of -I\n"
" -Od disables optimization. May cause illegal SPIR-V for HLSL.\n" " -Od disables optimization; may cause illegal SPIR-V for HLSL\n"
" -Os optimizes SPIR-V to minimize size.\n" " -Os optimizes SPIR-V to minimize size\n"
" -S <stage> uses specified stage rather than parsing the file extension\n" " -S <stage> uses specified stage rather than parsing the file extension\n"
" choices for <stage> are vert, tesc, tese, geom, frag, or comp\n" " choices for <stage> are vert, tesc, tese, geom, frag, or comp\n"
" -U<macro> undefine a pre-processor macro\n" " -U<macro> undefine a pre-processor macro\n"
...@@ -1355,8 +1355,8 @@ void usage() ...@@ -1355,8 +1355,8 @@ void usage()
" creates the default configuration file (redirect to a .conf file)\n" " creates the default configuration file (redirect to a .conf file)\n"
" -d default to desktop (#version 110) when there is no shader #version\n" " -d default to desktop (#version 110) when there is no shader #version\n"
" (default is ES version 100)\n" " (default is ES version 100)\n"
" --entry-point <name>\n" " -e <name> | --entry-point <name>\n"
" -e <name> specify <name> as the entry-point function name\n" " specify <name> as the entry-point function name\n"
" -f{hlsl_functionality1}\n" " -f{hlsl_functionality1}\n"
" 'hlsl_functionality1' enables use of the\n" " 'hlsl_functionality1' enables use of the\n"
" SPV_GOOGLE_hlsl_functionality1 extension\n" " SPV_GOOGLE_hlsl_functionality1 extension\n"
...@@ -1367,80 +1367,81 @@ void usage() ...@@ -1367,80 +1367,81 @@ void usage()
" -m memory leak mode\n" " -m memory leak mode\n"
" -o <file> save binary to <file>, requires a binary option (e.g., -V)\n" " -o <file> save binary to <file>, requires a binary option (e.g., -V)\n"
" -q dump reflection query database\n" " -q dump reflection query database\n"
" -r synonym for --relaxed-errors\n" " -r | --relaxed-errors"
" relaxed GLSL semantic error-checking mode\n"
" -s silence syntax and semantic error reporting\n" " -s silence syntax and semantic error reporting\n"
" -t multi-threaded mode\n" " -t multi-threaded mode\n"
" -v print version strings\n" " -v | --version\n"
" -w synonym for --suppress-warnings\n" " print version strings\n"
" -w | --suppress-warnings\n"
" suppress GLSL warnings, except as required by \"#extension : warn\"\n"
" -x save binary output as text-based 32-bit hexadecimal numbers\n" " -x save binary output as text-based 32-bit hexadecimal numbers\n"
" --auto-map-bindings automatically bind uniform variables\n" " --auto-map-bindings | --amb automatically bind uniform variables\n"
" without explicit bindings.\n" " without explicit bindings\n"
" --amb synonym for --auto-map-bindings\n" " --auto-map-locations | --aml automatically locate input/output lacking\n"
" --auto-map-locations automatically locate input/output lacking\n"
" 'location' (fragile, not cross stage)\n" " 'location' (fragile, not cross stage)\n"
" --aml synonym for --auto-map-locations\n"
" --client {vulkan<ver>|opengl<ver>} see -V and -G\n" " --client {vulkan<ver>|opengl<ver>} see -V and -G\n"
" -dumpfullversion print bare major.minor.patchlevel\n" " -dumpfullversion | -dumpversion print bare major.minor.patchlevel\n"
" -dumpversion same as -dumpfullversion\n" " --flatten-uniform-arrays | --fua flatten uniform texture/sampler arrays to\n"
" --flatten-uniform-arrays flatten uniform texture/sampler arrays to\n"
" scalars\n" " scalars\n"
" --fua synonym for --flatten-uniform-arrays\n" " --hlsl-offsets allow block offsets to follow HLSL rules\n"
" --hlsl-offsets Allow block offsets to follow HLSL rules\n" " works independently of source language\n"
" Works independently of source language\n" " --hlsl-iomap perform IO mapping in HLSL register space\n"
" --hlsl-iomap Perform IO mapping in HLSL register space\n" " --hlsl-enable-16bit-types allow 16-bit types in SPIR-V for HLSL\n"
" --hlsl-enable-16bit-types Allow use of 16-bit types in SPIR-V for HLSL\n"
" --invert-y | --iy invert position.Y output in vertex shader\n" " --invert-y | --iy invert position.Y output in vertex shader\n"
" --keep-uncalled don't eliminate uncalled functions\n" " --keep-uncalled | --ku don't eliminate uncalled functions\n"
" --ku synonym for --keep-uncalled\n" " --no-storage-format | --nsf use Unknown image format\n"
" --no-storage-format use Unknown image format\n"
" --nsf synonym for --no-storage-format\n"
" --relaxed-errors relaxed GLSL semantic error-checking mode\n"
" --resource-set-binding [stage] name set binding\n" " --resource-set-binding [stage] name set binding\n"
" Set descriptor set and binding for individual resources\n" " set descriptor set and binding for\n"
" individual resources\n"
" --resource-set-binding [stage] set\n" " --resource-set-binding [stage] set\n"
" Set descriptor set for all resources\n" " set descriptor set for all resources\n"
" --rsb [stage] type set binding synonym for --resource-set-binding\n" " --rsb synonym for --resource-set-binding\n"
" --shift-image-binding [stage] num base binding number for images (uav)\n" " --shift-image-binding [stage] num\n"
" --shift-image-binding [stage] [num set]... per-descriptor-set shift values\n" " base binding number for images (uav)\n"
" --sib [stage] num synonym for --shift-image-binding\n" " --shift-image-binding [stage] [num set]...\n"
" --shift-sampler-binding [stage] num base binding number for samplers\n" " per-descriptor-set shift values\n"
" --shift-sampler-binding [stage] [num set]... per-descriptor-set shift values\n" " --sib synonym for --shift-image-binding\n"
" --ssb [stage] num synonym for --shift-sampler-binding\n" " --shift-sampler-binding [stage] num\n"
" base binding number for samplers\n"
" --shift-sampler-binding [stage] [num set]...\n"
" per-descriptor-set shift values\n"
" --ssb synonym for --shift-sampler-binding\n"
" --shift-ssbo-binding [stage] num base binding number for SSBOs\n" " --shift-ssbo-binding [stage] num base binding number for SSBOs\n"
" --shift-ssbo-binding [stage] [num set]... per-descriptor-set shift values\n" " --shift-ssbo-binding [stage] [num set]...\n"
" --sbb [stage] num synonym for --shift-ssbo-binding\n" " per-descriptor-set shift values\n"
" --shift-texture-binding [stage] num base binding number for textures\n" " --sbb synonym for --shift-ssbo-binding\n"
" --shift-texture-binding [stage] [num set]... per-descriptor-set shift values\n" " --shift-texture-binding [stage] num\n"
" --stb [stage] num synonym for --shift-texture-binding\n" " base binding number for textures\n"
" --shift-texture-binding [stage] [num set]...\n"
" per-descriptor-set shift values\n"
" --stb synonym for --shift-texture-binding\n"
" --shift-uav-binding [stage] num base binding number for UAVs\n" " --shift-uav-binding [stage] num base binding number for UAVs\n"
" --shift-uav-binding [stage] [num set]... per-descriptor-set shift values\n" " --shift-uav-binding [stage] [num set]...\n"
" --suavb [stage] num synonym for --shift-uav-binding\n" " per-descriptor-set shift values\n"
" --suavb synonym for --shift-uav-binding\n"
" --shift-UBO-binding [stage] num base binding number for UBOs\n" " --shift-UBO-binding [stage] num base binding number for UBOs\n"
" --shift-UBO-binding [stage] [num set]... per-descriptor-set shift values\n" " --shift-UBO-binding [stage] [num set]...\n"
" --shift-cbuffer-binding [stage] num synonym for --shift-UBO-binding\n" " per-descriptor-set shift values\n"
" --shift-cbuffer-binding [stage] [num set]... per-descriptor-set shift values\n" " --sub synonym for --shift-UBO-binding\n"
" --spirv-dis output standard form disassembly; works only\n" " --shift-cbuffer-binding | --scb synonyms for --shift-UBO-binding\n"
" --spirv-dis output standard-form disassembly; works only\n"
" when a SPIR-V generation option is also used\n" " when a SPIR-V generation option is also used\n"
" --sub [stage] num synonym for --shift-UBO-binding\n"
" --source-entrypoint <name> the given shader source function is\n" " --source-entrypoint <name> the given shader source function is\n"
" renamed to be the <name> given in -e\n" " renamed to be the <name> given in -e\n"
" --sep synonym for --source-entrypoint\n" " --sep synonym for --source-entrypoint\n"
" --stdin Read from stdin instead of from a file.\n" " --stdin read from stdin instead of from a file;\n"
" You'll have to provide the shader stage\n" " requires providing the shader stage using -S\n"
" using -S.\n"
" --suppress-warnings suppress GLSL warnings\n"
" (except as required by #extension : warn)\n"
" --target-env {vulkan1.0 | vulkan1.1 | opengl} \n" " --target-env {vulkan1.0 | vulkan1.1 | opengl} \n"
" set execution environment that emitted code\n" " set execution environment that emitted code\n"
" will execute in (as opposed to the language\n" " will execute in (as opposed to the language\n"
" semantics selected by --client) defaults:\n" " semantics selected by --client) defaults:\n"
" 'vulkan1.0' under '--client vulkan<ver>'\n" " * 'vulkan1.0' under '--client vulkan<ver>'\n"
" 'opengl' under '--client opengl<ver>'\n" " * 'opengl' under '--client opengl<ver>'\n"
" --variable-name <name> Creates a C header file that contains a\n" " --variable-name <name>\n"
" --vn <name> creates a C header file that contains a\n"
" uint32_t array named <name>\n" " uint32_t array named <name>\n"
" initialized with the shader binary code.\n" " initialized with the shader binary code\n"
" --version synonym for -v\n"
" --vn <name> synonym for --variable-name <name>\n"
); );
exit(EFailUsage); exit(EFailUsage);
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment