From 89d5084c91c6839b6bde7087101d6040ffd0dfe8 Mon Sep 17 00:00:00 2001 From: Garux Date: Mon, 4 May 2020 11:22:05 +0300 Subject: [PATCH] docs: shaderManual: note working block comments --- docs/shaderManual/shader-concepts.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/shaderManual/shader-concepts.html b/docs/shaderManual/shader-concepts.html index caa93477..04f55c1a 100644 --- a/docs/shaderManual/shader-concepts.html +++ b/docs/shaderManual/shader-concepts.html @@ -140,7 +140,7 @@ textures/liquids/lava-example //Shader name

Documenting With Comments

It is often useful to document parts of shaders, especially for testing purposes or when working with a development team of other designers. Comments added to shaders are ignored completely, making it useful for adding notes, or for temporarily removing directives for testing.

-Shaders use the same double forward slashes "//" convention common with many programming languages for commenting. All text after the "//" on the same line are ignored from the shader. Block comments such as "/* , */" from other programming languages do not work. See various shaders for examples.

+Shaders use the same double forward slashes "//" convention common with many programming languages for commenting. All text after the "//" on the same line are ignored from the shader. Block comments such as "/* , */" from other programming languages work too. See various shaders for examples.

:q3map Suffix

The :q3map suffix can be added to the end of the shader name of "compile-time" shaders. This means that shaders with names marked with :q3map will be used by the compiler only and will be ignored by the game engine. This is especially useful if you want to add Q3Map2-relevant shader directives to basic lightmapped textures. This allows Quake 3 to generate the stages implicitly while Q3Map2 processes the Q3Map2-relevant sections of the shader. Consider the following shaders: