Documentation update 2 (#2756)

* 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

View File

@@ -947,26 +947,27 @@ void help(const char* _error = NULL)
"\n"
"Options:\n"
" -h, --help Help.\n"
" -v, --version Version information only.\n"
" -f <file path> Input file path.\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"
" -o <file path> Output's file path.\n"
" -s, --scale <num> Scale factor.\n"
" --ccw Front face is counter-clockwise winding order.\n"
" --flipv Flip texture coordinate V.\n"
" --obb <num> Number of steps for calculating oriented bounding box.\n"
" Default value is 17. Less steps less precise OBB is.\n"
" More steps slower calculation.\n"
" Defaults to 17.\n
" Less steps = less precise OBB.\n"
" More steps = slower calculation.\n"
" --packnormal <num> Normal packing.\n"
" 0 - unpacked 12 bytes (default).\n"
" 0 - unpacked 12 bytes. (default)\n"
" 1 - packed 4 bytes.\n"
" --packuv <num> Texture coordinate packing.\n"
" 0 - unpacked 8 bytes (default).\n"
" 0 - unpacked 8 bytes. (default)\n"
" 1 - packed 4 bytes.\n"
" --tangent Calculate tangent vectors (packing mode is the same as normal).\n"
" --barycentric Adds barycentric vertex attribute (packed in bgfx::Attrib::Color1).\n"
" --tangent Calculate tangent vectors. (packing mode is the same as normal)\n"
" --barycentric Adds barycentric vertex attribute. (Packed in bgfx::Attrib::Color1)\n"
" -c, --compress Compress indices.\n"
" --[l/r]h-up+[y/z] Coordinate system. Default is '--lh-up+y' Left-Handed +Y is up.\n"
" --[l/r]h-up+[y/z] Coordinate system. Defaults to '--lh-up+y' Left-Handed +Y is up.\n"
"\n"
"For additional information, see https://github.com/bkaradzic/bgfx\n"