mirrors/bgfx
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added Shader Compiler's default defines to the docs (#2911)

Browse Source 
* Added shaderc default defines to docs

* Update tools.rst

* Update tools.rst

Co-authored-by: Бранимир Караџић <branimirkaradzic@gmail.com>
This commit is contained in:
ichordev 2022-09-03 00:08:22 +10:00 committed by GitHub
parent eacf36abb0
commit 255a19d397
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 25 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
docs/tools.rst
View File

@ -30,7 +30,6 @@ Options:
--ccw Front face is counter-clockwise winding order. --ccw Front face is counter-clockwise winding order.
--flipv Flip texture coordinate V. --flipv Flip texture coordinate V.
--obb <num> Number of steps for calculating oriented bounding box. --obb <num> Number of steps for calculating oriented bounding box.
Defaults to 17. Defaults to 17.
Less steps = less precise OBB. Less steps = less precise OBB.
@ -75,6 +74,31 @@ Some differences between bgfx's shaderc flavor of GLSL and vanilla GLSL:
- ``$input/$output`` tokens corresponding to inputs and outputs defined in - ``$input/$output`` tokens corresponding to inputs and outputs defined in
``varying.def.sc`` must be used at the beginning of shader. ``varying.def.sc`` must be used at the beginning of shader.
Shader Compiler also has the following default defines:
=============================== ======================= =======
Define symbol Description Option
=============================== ======================= =======
``BX_PLATFORM_ANDROID`` Android platform ``--platform android``
``BX_PLATFORM_EMSCRIPTEN`` Emscripten platform ``--platform asm.js``
``BX_PLATFORM_IOS`` iOS platform ``--platform ios``
``BX_PLATFORM_LINUX`` Linux platform ``--platform linux``
``BX_PLATFORM_OSX`` macOS platform ``--platform osx``
``BX_PLATFORM_PS4`` PlayStation 4 platform ``--platform orbis``
``BX_PLATFORM_WINDOWS`` Windows platform ``--platform windows``
``BX_PLATFORM_XBOXONE`` *Not implemented*
------------------------------- ----------------------- -------
``BGFX_SHADER_LANGUAGE_GLSL`` GLSL profile ``-p NNN`` and ``-p NNN_es``
``BGFX_SHADER_LANGUAGE_HLSL`` HLSL profile ``-p s_N_N``
``BGFX_SHADER_LANGUAGE_METAL`` Metal profile ``-p metal``
``BGFX_SHADER_LANGUAGE_PSSL`` PSSL profile ``-p pssl``
``BGFX_SHADER_LANGUAGE_SPIRV`` SPIR-V profile ``-p spirv`` and ``-p spirvNN-NN``
------------------------------- ----------------------- -------
``BGFX_SHADER_TYPE_COMPUTE`` Compute shader ``--type compute`` or ``--type c``
``BGFX_SHADER_TYPE_FRAGMENT`` Fragment shader ``--type fragment`` or ``--type f``
``BGFX_SHADER_TYPE_VERTEX`` Vertex shader ``--type vertex`` or ``--type v``
=============================== ======================= ========
For more info, see the `shader helper macros For more info, see the `shader helper macros
<https://github.com/bkaradzic/bgfx/blob/master/src/bgfx_shader.sh>`__. <https://github.com/bkaradzic/bgfx/blob/master/src/bgfx_shader.sh>`__.
@ -89,13 +113,11 @@ Options:
--depends Generate makefile style depends file. --depends Generate makefile style depends file.
--platform <platform> Target platform. --platform <platform> Target platform.
-p, --profile <profile> Shader model. -p, --profile <profile> Shader model.
Defaults to GLSL. Defaults to GLSL.
--preprocess Only pre-process. --preprocess Only pre-process.
--define <defines> Add defines to preprocessor. (semicolon separated) --define <defines> Add defines to preprocessor. (semicolon separated)
--raw Do not process shader. No preprocessor, and no glsl-optimizer. (GLSL only) --raw Do not process shader. No preprocessor, and no glsl-optimizer. (GLSL only)
--type <type> Shader type. --type <type> Shader type.
Can be 'vertex', 'fragment, or 'compute'. Can be 'vertex', 'fragment, or 'compute'.
--varyingdef <file path> A varying.def.sc's file path. --varyingdef <file path> A varying.def.sc's file path.
--verbose Be verbose. --verbose Be verbose.
@ -105,7 +127,6 @@ Options:
--debug Debug information. --debug Debug information.
--disasm Disassemble a compiled shader. --disasm Disassemble a compiled shader.
-O <level> Set optimization level. -O <level> Set optimization level.
Can be 0–3. Can be 0–3.
--Werror Treat warnings as errors. --Werror Treat warnings as errors.
@ -152,7 +173,6 @@ Options:
-o <file path> Output's file path. -o <file path> Output's file path.
-t <format> Output format type. (BC1/2/3/4/5, ETC1, PVR14, etc.) -t <format> Output format type. (BC1/2/3/4/5, ETC1, PVR14, etc.)
-q <quality> Encoding quality. -q <quality> Encoding quality.
Can be 'default', 'fastest', or 'highest'. Can be 'default', 'fastest', or 'highest'.
-m, --mips Generate mip-maps. -m, --mips Generate mip-maps.
--mipskip <N> Skip <N> number of mips. --mipskip <N> Skip <N> number of mips.
@ -166,7 +186,6 @@ Options:
--linear Input and output texture is linear color space. (Gamma correction won't be applied) --linear Input and output texture is linear color space. (Gamma correction won't be applied)
--max <max size> Maximum width/height. (Image will be scaled down and aspect ratio will be preserved) --max <max size> Maximum width/height. (Image will be scaled down and aspect ratio will be preserved)
--radiance <model> Radiance cubemap filter. --radiance <model> Radiance cubemap filter.
Model can be 'Phong', 'PhongBrdf', 'Blinn', 'BlinnBrdf', or 'GGX'. Model can be 'Phong', 'PhongBrdf', 'Blinn', 'BlinnBrdf', or 'GGX'.
--as <extension> Save as. --as <extension> Save as.
--formats List all supported formats. --formats List all supported formats.