$detail: Difference between revisions
ShiroDkxtro2 (talk | contribs) m (Added Alien Swarm to list of games where $detailtint works with $blendtintbybasealpha) |
ShiroDkxtro2 (talk | contribs) m (Re-documented Bugs and added additional information for $detailtexturetransform, $detail2 and $detail_alpha_mask_base_texture) |
||
Line 12: | Line 12: | ||
:{{todo| Document issues from other branches of source.}} | :{{todo| Document issues from other branches of source.}} | ||
:{{todo| Things that don't work in {{as}}, usually don't work in {{l4d}} either. And vice versa. But it'd be better if someone could confirm this.}} | :{{todo| Things that don't work in {{as}}, usually don't work in {{l4d}} either. And vice versa. But it'd be better if someone could confirm this.}} | ||
:{{note| Previously it was stated $blendmodulatetexture would only work with $detail in {{csgo}}. '''''however''''' | :{{note| Previously it was stated that $blendmodulatetexture would only work with $detail in {{csgo}}. '''''however'''''. '''This does appear to work''', in ''at least'' {{src13}}{{tf2}}{{as}} ''and'' {{csgo}}.}} | ||
== Syntax == | == Syntax == | ||
Line 21: | Line 21: | ||
== Parameters and Effects == | == Parameters and Effects == | ||
{{MatParam|$detailtexturetransform|matrix|Rotates, scales, etc. the detail texture. {{VMT UVtransform}}|dx9=1}}{{bug|Does not | {{MatParam|$detailtexturetransform|matrix|Rotates, scales, etc. the detail texture. {{VMT UVtransform}}|dx9=1}} | ||
{{bug|This parameter does not exist for {{ent|LightmappedGeneric}}, {{ent|WorldVertexTransition}} and {{only|{{csgo}}}} {{ent|Lightmapped_4WayBlend}}.}} | |||
{{bug|Does not work with {{ent|$treesway}}.}} | |||
{{MatParam|$detailscale|float|Fits the detail texture onto the material the given number of times (default {{=}} 4). Generally used instead of <code>$detailtexturetransform</code> with a value of around 7 or 8 for a 128px detail texture. To independently scale the X and Y coordinates, place your values in brackets: <code>$detailscale "[ 4 8 ]"</code> }} | {{MatParam|$detailscale|float|Fits the detail texture onto the material the given number of times (default {{=}} 4). Generally used instead of <code>$detailtexturetransform</code> with a value of around 7 or 8 for a 128px detail texture. To independently scale the X and Y coordinates, place your values in brackets: <code>$detailscale "[ 4 8 ]"</code> }} | ||
{{MatParam|$detailblendfactor|normal|Controls the amount that the detail texture affects the base texture. The precise use of this depends on the blend factor; in most cases it acts similarly to [[$alpha]]. A value of 0 usually makes the detail texture have no effect, whilst a value of 1 applies the full effect.}} | {{MatParam|$detailblendfactor|normal|Controls the amount that the detail texture affects the base texture. The precise use of this depends on the blend factor; in most cases it acts similarly to [[$alpha]]. A value of 0 usually makes the detail texture have no effect, whilst a value of 1 applies the full effect.}} | ||
Line 96: | Line 98: | ||
{{todo|Verify which games this is broken in ( Works in {{l4d2}} {{tf2}} {{portal2}} {{csgo}} {{as}} and {{src13}} ).}}}} | {{todo|Verify which games this is broken in ( Works in {{l4d2}} {{tf2}} {{portal2}} {{csgo}} {{as}} and {{src13}} ).}}}} | ||
{{MatParam|$detailframe|int|The frame to start an animated <code>$detail</code> texture on.|dx9=1}} | {{MatParam|$detailframe|int|The frame to start an animated <code>$detail</code> texture on.|dx9=1}} | ||
{{MatParam|$detail_alpha_mask_base_texture|bool|{{ent|WorldVertexTransition}} only. When enabled, causes the level of detail alpha to determine "base texture blending."{{ | {{MatParam|$detail_alpha_mask_base_texture|bool|{{ent|WorldVertexTransition}} only. When enabled, causes the level of detail alpha to determine "base texture blending."{{important|Since '''at minimum''' {{src13}} this parameter does not actually do anything!}}|removed={{csgo}}}} | ||
<br> | <br> | ||
==={{csgo}} <tt>WorldVertexTransition</tt> Parameters=== | ==={{csgo}} <tt>WorldVertexTransition</tt> Parameters=== | ||
{{confirm|are these limited to {{csgo}}, or are they in some/all {{csgobranch}}–branch games?}} | {{confirm|are these limited to {{csgo}}, or are they in some/all {{csgobranch}}–branch games?}} | ||
{{MatParam|$detail2|texture|Detail texture for {{ent|WorldVertexTransition}}'s second layer. | {{MatParam|$detail2|texture|Detail texture for {{ent|WorldVertexTransition}}'s second layer. | ||
{{note|{{ent|LightmappedGeneric}} technically has support for these parameters and other <code>WorldVertexTransition</code> parameters, but they may not work as expected.}}|only={{csgo}}|shaders=WorldVertexTransition}} | {{note|{{ent|LightmappedGeneric}} technically has support for these parameters and other <code>WorldVertexTransition</code> parameters, but they may not work as expected.}} | ||
{{note|There is no <code>$detailtransform2</code>, the Shader will use {{ent|$basetexturetransform2}} instead! }} | |||
{{important|Requires both <code>$detail</code> and <code>$basetexture2</code> to be present!}} | |||
{{bug|Cannot be used with <code>$detailblendmode "9"</code>.}} | |||
|only={{csgo}}|shaders=WorldVertexTransition}} | |||
{{MatParam|$detailscale2|float|Detail scale for <tt>$detail2</tt>.|only={{csgo}}|shaders=WorldVertexTransition}} | {{MatParam|$detailscale2|float|Detail scale for <tt>$detail2</tt>.|only={{csgo}}|shaders=WorldVertexTransition}} | ||
{{MatParam|$detailblendfactor2|normal|Detail blend factor for <tt>$detail2</tt>.|only={{csgo}}|shaders=WorldVertexTransition}} | {{MatParam|$detailblendfactor2|normal|Detail blend factor for <tt>$detail2</tt>. {{Note|<code>$detailblendfactor</code> and <code>$detailblendfactor2</code> are blended together before combining with the basetexture.}}|only={{csgo}}|shaders=WorldVertexTransition}} | ||
{{MatParam|$detailframe2|int|The frame to start an animated <code>$detail2</code> texture on.|only={{csgo}}|shaders=WorldVertexTransition}} | {{MatParam|$detailframe2|int|The frame to start an animated <code>$detail2</code> texture on.|only={{csgo}}|shaders=WorldVertexTransition}} | ||
{{MatParam|$detailtint2|RGB matrix|Color tint for <tt>$detail2</tt>.|only={{csgo}}|shaders=WorldVertexTransition}} | {{MatParam|$detailtint2|RGB matrix|Color tint for <tt>$detail2</tt>.|only={{csgo}}|shaders=WorldVertexTransition}} |
Revision as of 09:42, 16 February 2023
Template:Shaderparam It specifies a texture which Source will use to add high-resolution detail to a material when it is viewed up close, by darkening or lightening the albedo appropriately, depending on the $detailblendmode. You can also use a full color (as opposed to grayscale) image and blend it using $detailblendmode 2. It is very effective for increasing the apparent resolution of a texture, and was used extensively in Half-Life 2: Episode Two.

$Detail
textures do not work in conjunction with some parameters : [todo tested in ?]- In
on LightmappedGeneric, Does not work with $seamless_scale.
- In
on VertexLitGeneric. Does not work with $selfillumfresnel, if $bumpmap is used.
- In
on LightmappedGeneric, Does not work with $lightwarptexture
- In
on VertexLitGeneric, Does not work with $desaturatewithbasealpha
- In
, Does not work with $blendmodulatetexture and $bumpmap
- Todo: Document issues from other branches of source.
Syntax
$detail <texture>
You will probably want to use at least $detailscale
(see below) as well.
Parameters and Effects


$detailscale
$detailblendfactor
$detailblendmode
- There are 12 different detail blend methods that can be used.
- The blend modes are implemented in
stdshaders/common_ps_fx.h
.
Mode | Effect | Description |
---|---|---|
0 | DecalModulate | This functions the same as the DecalModulate shader—colors below 128 darken the image, colors above lighten the image. |
1 | Additive | The color of the detail texture is added to the base texture. This is the same as $additive. |
2 | Translucent Detail | The detail texture is applied as a translucent overlay on top of the base texture. |
3 | Blend Factor Fade | The detail texture is applied as a translucent overlay, but ignoring its alpha channel. Instead, the blend factor is used to determine how much of the base texture shows through underneath. |
4 | Translucent Base | This effectively flips the normal layering of the two textures. The detail texture appears "below," with the base alpha channel controlling it as a translucent overlay. The detail alpha channel controls the overall material alpha—for translucency, masking, or other uses. |
5 | Unlit Additive | The color of the detail texture is added to the base texture identically to mode 1, but this color is unaffected by lighting and therefore appears to glow. |
6 | Unlit Additive Threshold Fade | This adds color unaffected by lighting like mode 5, but first modifies the color added in two modes, depending on if the blend factor is above or below 0.5. |
7 | Two-Pattern DecalModulate | Only the red and alpha channels of the detail texture are used. This operates like the DecalModulate shader or blend mode 0, but the base alpha channel fades between using the red (0) or alpha (255) detail channel as the modulation source. This effectively allows two detail materials, although both are greyscale. |
8 | Multiply | The color of the base channel is multiplied by that of the detail texture. |
9 | Base Mask via Detail Alpha | Only the detail alpha channel is used. It is multiplied with the base texture's alpha channel to produce the final alpha value. |
10 | Self-Shadowed Bumpmap | The detail texture is used as a (possibly additional) $ssbump bumpmap. The blend factor is ignored.![]() |
11 | SSBump Albedo | Unknown function, used internally. The comment says, "shader does the magic here - no user needs to specify mode 11." |

- In
LightmappedGeneric Modes 1-6 and 8 are not supported. 9 not with $bumpmap, $envmap, $selfillum.
- In
WorldVertexTransition Modes 1-6, 8-9 are not supported. 7 Does not work with $blendmodulatetexture.
- In
VertexLitGeneric Modes 0-9 are supported without $bumpmap, 0-7 with. However only with $phong, 5 & 6 usable. The Shader without $phong doesn't have the code to use 5 & 6.
- In
Lightmapped_4WayBlend Modes 1-6 are not supported.
- In
LightmappedGeneric Modes 2-9 are not supported.
- In
VertexLitGeneric Modes 0-9 are supported without $bumpmap, 0-6 with. However only with $phong, 5 & 6 usable. The Shader without $phong doesn't have the code to use 5 & 6.
- In
LightmappedGeneric and WorldVertexTransition Mode 6 is not supported. Additionally 7 does not work with $bumpmap2, $softedges and $blendmodulatetexture.
- In
Modes 1, 4, 6, 9, and 10 are not supported.






[todo tested in ?]
$detailframe
$detail_alpha_mask_base_texture
WorldVertexTransition Parameters
$detail2
$detailscale2
$detailblendfactor2
$detailframe2
$detailtint2

SolidEnergy Parameters




$detail
has very similar parameter names, but they are not the same! - There are 2 different detail blend methods that can be used.
Mode | Effect | Description |
---|---|---|
0 | DecalModulate | This functions the same as the DecalModulate shader—colors below 128 darken the image, colors above lighten the image. |
1 | Multiply | $basetexture is multiplied by $detail1, Alpha of the $basetexture controls the strength of the effect. Black parts have full multiplication, White parts have no multiplication. |
$detail1scale
$detail1blendfactor
$detail1frame


$detail2
parameter names, but they are not the same!- There are 2 different detail blend methods that can be used.
Mode | Effect | Description |
---|---|---|
0 | Additive | Adds $detail2 onto the $basetexture. ![]() |
1 | Multiply | $basetexture is multiplied by $detail2. ![]() |
$detail2scale
$detail2blendfactor
$detail2frame
Valve's Detail Textures
Valve's stock detail textures (available in OB only) are best used with the following pre-configured values:
$detail detail\noise_detail_01 // e.g. for brickwork, concrete... $detailscale 7.74 $detailblendfactor 0.8 $detailblendmode 0
$detail detail\metal_detail_01 $detailscale 4.283 $detailblendfactor .65 $detailblendmode 0
$detail detail\rock_detail_01 $detailscale 11 $detailblendfactor 1 $detailblendmode 0
$detail detail\plaster_detail_01 $detailscale 6.783 $detailblendfactor .8 $detailblendmode 0
The below parameters come from models\props_forest\LadderWood.vmt. It is the only Valve Stock texture VMT file to use this particular detail texture. Because the detail texture (detail\wood_detail_01) is a high resolution (1024×1024), the $detailscale
is lower than the others, with the exception of rock_detail_01.
$detail detail\wood_detail_01 $detailscale 2.563 $detailblendfactor .8 $detailblendmode 0
Additionally, there are 2 other stock detail textures. detail\detailash001a
and detail\detaildirt001a
. These files were used in the "leaked" version of Half-Life 2 and in
Half-Life 2: Episode One using the following parameters.
Concrete/concretefloor009a
in Episode One materials:
$detail detail/detaildirt001a $detailscale 0.27
Metal/metalfloor005a
in Episode One materials:
$detail detail/detailash001a $detailscale 0.50
See Also
Hiding large-scale tiling with detail textures - How to make texture repeating less noticeable using $detail