Mirrors/bgfx
1
0
Fork 0
mirror of https://github.com/bkaradzic/bgfx.git synced 2026-02-17 20:52:36 +01:00
Code Issues Packages Projects Releases Wiki Activity

Documentation update 2 (#2756)

Browse Source 
* Reworded & reformatted bgfx.rst for better clarity

* Reworded for clarity; made option format more consistent

* Added one character!

* Updated shaderc help

Will update docs to 100% match soon

* Updated geometryc's help

Co-authored-by: Бранимир Караџић <branimirkaradzic@gmail.com>
This commit is contained in:
ichordev
2022-04-05 05:57:00 +10:00
committed by GitHub
parent 11ba8de2d1
commit 7a5fec1580
5 changed files with 149 additions and 128 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
tools/shaderc/shaderc.cpp
View File

@@ -1002,11 +1002,11 @@ namespace bgfx
"\n"
"Options:\n"
" -h, --help Help.\n"
" -v, --version Version information only.\n"
" -f <file path> Input file path.\n"
" -i <include path> Include path (for multiple paths use -i multiple times).\n"
" -o <file path> Output file path.\n"
" -h, --help Display this help and exit.\n"
" -v, --version Output version information and exit.\n"
" -f <file path> Input's file path.\n"
" -i <include path> Include path. (for multiple paths use -i multiple times)\n"
" -o <file path> Output's file path.\n"
" --stdout Output to console.\n"
" --bin2c [array name] Generate C header file. If array name is not specified base file name will be used as name.\n"
" --depends Generate makefile style depends file.\n"
@@ -1018,7 +1018,7 @@ namespace bgfx
" orbis\n"
" osx\n"
" windows\n"
" -p, --profile <profile> Shader model (default GLSL).\n"
" -p, --profile <profile> Shader model. Defaults to GLSL.\n"
);
{
@@ -1041,20 +1041,20 @@ namespace bgfx
}
bx::printf(
" --preprocess Preprocess only.\n"
" --define <defines> Add defines to preprocessor (semicolon separated).\n"
" --raw Do not process shader. No preprocessor, and no glsl-optimizer (GLSL only).\n"
" --type <type> Shader type (vertex, fragment, compute)\n"
" --varyingdef <file path> Path to varying.def.sc file.\n"
" --verbose Verbose.\n"
" --preprocess Only pre-process.\n"
" --define <defines> Add defines to preprocessor. (Semicolon-separated)\n"
" --raw Do not process shader. No preprocessor, and no glsl-optimizer. (GLSL only)\n"
" --type <type> Shader type. Can be 'vertex', 'fragment, or 'compute'.\n"
" --varyingdef <file path> varying.def.sc's file path.\n"
" --verbose Be verbose.\n"
"\n"
"Options (DX9 and DX11 only):\n"
"(DX9 and DX11 only):\n"
"\n"
" --debug Debug information.\n"
" --disasm Disassemble compiled shader.\n"
" -O <level> Optimization level (0, 1, 2, 3).\n"
" -O <level> Set optimization level. Can be 0 to 3.\n"
" --Werror Treat warnings as errors.\n"
"\n"