Skip to content

Commit

Permalink
tweak shader manual anchors
Browse files Browse the repository at this point in the history
  • Loading branch information
Garux committed Dec 27, 2024
1 parent 8b4f661 commit 4aedb78
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 12 deletions.
6 changes: 3 additions & 3 deletions docs/shaderManual/contents.html
Original file line number Diff line number Diff line change
Expand Up @@ -205,9 +205,9 @@ <h1>Contents</h1>
</li>
<li><a href="quake-editor-radiant-directives.html" tppabs="http://robotrenegade.com/q3map2/docs/shader_manual/quake-editor-radiant-directives.html">Quake Editor Radiant Directives</a>
<ul>
<li><a href="quake-editor-radiant-directives.html#editorImage" tppabs="http://robotrenegade.com/q3map2/docs/shader_manual/quake-editor-radiant-directives.html#editorImage">qer_editorImage</a></li>
<li><a href="quake-editor-radiant-directives.html#trans" tppabs="http://robotrenegade.com/q3map2/docs/shader_manual/quake-editor-radiant-directives.html#trans">qer_trans</a></li>
<li><a href="quake-editor-radiant-directives.html#alphaFunc" tppabs="http://robotrenegade.com/q3map2/docs/shader_manual/quake-editor-radiant-directives.html#alphaFunc">qer_alphaFunc</a></li>
<li><a href="quake-editor-radiant-directives.html#qer_editorImage" tppabs="http://robotrenegade.com/q3map2/docs/shader_manual/quake-editor-radiant-directives.html#editorImage">qer_editorImage</a></li>
<li><a href="quake-editor-radiant-directives.html#qer_trans" tppabs="http://robotrenegade.com/q3map2/docs/shader_manual/quake-editor-radiant-directives.html#trans">qer_trans</a></li>
<li><a href="quake-editor-radiant-directives.html#qer_alphaFunc" tppabs="http://robotrenegade.com/q3map2/docs/shader_manual/quake-editor-radiant-directives.html#alphaFunc">qer_alphaFunc</a></li>
</ul>
</li>
<li><a href="stage-directives.html" tppabs="http://robotrenegade.com/q3map2/docs/shader_manual/stage-directives.html">Stage Directives</a>
Expand Down
6 changes: 3 additions & 3 deletions docs/shaderManual/quake-editor-radiant-directives.html
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@
<h1>Radiant Editor Directives</h1>
<p>These directives only affect the texture when it is seen in the Radiant editor. They have no effect on the surface in-game. They should be grouped with the surface parameters but ahead of them in sequence.</p>

<h2 id="editorImage">qer_editorImage textureName</h2>
<h2 id="qer_editorImage">qer_editorImage textureName</h2>
<p>This directive creates a shader name in memory, but in the editor, it displays the TGA art image specified in qer_editorImage (in the shader below this is, textures/eerie/lavahell.tga).</p>
<p>The editor maps a texture using the size attributes of the TGA file used for the editor image. When that editor image represents a shader, any texture used in any of the shader stages will be scaled up or down to the dimensions of the editor image. If a 128x128 pixel image is used to represent the shader in the editor, then a 256x256 image used in a later stage will be shrunk to fit. A 64x64 image would be stretched to fit. Be sure to check this on bouncy, acceleration, and power-up pads placed on surfaces other than 256 x 256. Use tcMod scale to change the size of the stretched texture. Remember that tcMod scale 0.5 0.5 will double your image, while tcMod scale 2 2 will halve it.</p>
<pre>
Expand Down Expand Up @@ -87,14 +87,14 @@ <h2 id="noCarve">qer_noCarve</h2>
<p>A brush marked with this instruction will not be affected by CSG subtract functions. It is especially useful for water and fog textures.</p>
-->

<h2 id="trans">qer_trans N.N</h2>
<h2 id="qer_trans">qer_trans N.N</h2>
<p>This directive makes brush transparent when seen in the editor and filterable by 'translucent' filter (no effect on game rendering at all). It can have a positive value between 0 and 1. The higher the value, the less transparent the texture. Example: qer_trans 0.2 means the brush is 20% opaque and nearly invisible.</p>
<blockquote>
<h4>Design Notes:</h4>
<p>On GtkRadiant 1.4 and earlier, if the shader uses qer_trans and a qer_editorImage with an alpha channel, the transparent areas of the editorImage will be 100% transparent. To keep the solid areas of the editorImage opaque, use a near 1 value for qer_trans (eg. 0.9999). This is useful for grates, windows, fences, etc. If using GtkRadiant 1.5 or later, use qer_alphaFunc for editorImage masking instead. In NetRadiant-custom any value of qer_trans enables alpha channel transparency display, this may be used when alpha blending is wanted instead of alpha masking.</p>
</blockquote>

<h2 id="alphaFunc">qer_alphaFunc func N.N</h2>
<h2 id="qer_alphaFunc">qer_alphaFunc func N.N</h2>
<p>This directive is only supported by GtkRadiant 1.5 based editors. This is used when you have an alpha channel in the editorImage that you want to appear as an alpha mask in the editor. qer_alphaFunc by itself does not get filtered with qer_trans. This is useful for grates, windows, fences, etc.</p>

<p>Supported functions are: equal, greater, less, gequal, lequal.<br>Values: positive between 0 and 1.</p>
Expand Down
6 changes: 3 additions & 3 deletions docs/shaderManual/stage-directives.html
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ <h3>map <em>$lightmap</em></h3>
<h3>map <em>$whiteimage</em></h3>
<p>This is used for specular lighting on MD3 models. This is a white image generated internally by the game. This image can be used in lieu of $lightmap or an actual texture map if, for example, you wish for the vertex colors to come through unaltered.</p>

<h3>clampMap <em>texturename</em></h3>
<h3 id="clampMap">clampMap <em>texturename</em></h3>
<!-- obsidian: clampMap may have been once named clampTexCoords. Changed all instances of clampTexCoords (2nd paragraph) to clampMap -->
<p>Dictates that this stage should clamp texture coordinates instead of wrapping them. During a stretch function, the area, which the texture must cover during a wave cycle, enlarges and decreases. Instead of repeating a texture multiple times during enlargement (or seeing only a portion of the texture during shrinking) the texture dimensions increase or contract accordingly. This is only relevant when using something like deformTexCoordParms to stretch/compress texture coordinates for a specific special effect. Remember that the Quake III Arena engine normalizes all texture coordinates (regardless of actual texture size) into a scale of 0.0 to 1.0.</p>
<p>When using clampMap make sure the texture is properly aligned on the brush. The clampMap function keeps the image from tiling. However, the editor doesn't represent this properly and shows a tiled image. Therefore, what appears to be the correct position may be offset. This is very apparent on anything with a tcMod rotate and clampMap function.</p>
Expand Down Expand Up @@ -109,7 +109,7 @@ <h3>clampMap <em>texturename</em></h3>
}
</pre>

<h3>animMap <em>frequency texture1... texture8</em></h3>
<h3 id="animMap">animMap <em>frequency texture1... texture8</em></h3>
<p>The surfaces in the game can be animated by displaying a sequence of 1 to 8 frames (separate texture maps). These animations are affected by other keyword effects in the same and later shader stages.</p>
<dl>
<dt>frequency</dt><dd>The number of frames to display per one second time period (fps).</dd>
Expand Down Expand Up @@ -164,7 +164,7 @@ <h4>Design Notes:</h4>
<p>To make a texture image appear for an unequal (longer) amount of time (compared to other frames), repeat that frame more than once in the sequence.</p>
</blockquote>

<h3>videoMap <em>videoname</em></h3>
<h3 id="videoMap">videoMap <em>videoname</em></h3>
<p>Surfaces marked with a shader containing this directive in one of its stages will display an animated video playing in a continuous loop. The video clip must be in ROQ format and playing at 30 frames per second. The ROQ file is stored in the "video" directory within the main mod directory. A third-party program is required to convert other video formats to the ROQ format for use within Quake III engine games.</p>
<pre>
textures/obsidian_video/intro
Expand Down
6 changes: 3 additions & 3 deletions radiant/gtkdlgs.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -934,13 +934,13 @@ static const std::vector<ShaderFormat> g_shaderGeneralFormats{
}
},
{
"qer_editorImage %t", "quake-editor-radiant-directives.html#editorImage", c_colorKeyLv1
"qer_editorImage %t", c_pageQER, c_colorKeyLv1
},
{
"qer_trans %f", "quake-editor-radiant-directives.html#trans", c_colorKeyLv1
"qer_trans %f", c_pageQER, c_colorKeyLv1
},
{
"qer_alphaFunc %s %f", "quake-editor-radiant-directives.html#alphaFunc", c_colorKeyLv1, {
"qer_alphaFunc %s %f", c_pageQER, c_colorKeyLv1, {
"equal",
"greater",
"less",
Expand Down

0 comments on commit 4aedb78

Please sign in to comment.