This article's documentation is for anything that uses the Source engine. Click here for more information.

$detail: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
mNo edit summary
Line 21: Line 21:


== Parameters and Effects ==
== Parameters and Effects ==
{{MatParam|$detailtexturetransform|matrix|Rotates, scales, etc. the detail texture. {{VMT UVtransform}}|dx9=1}}
{{MatParam|$detailtexturetransform|matrix|dx9=1|Rotates, scales, etc. the detail texture. {{VMT UVtransform}}
{{Bug|This parameter does not exist for {{ent|LightmappedGeneric}}, {{ent|WorldVertexTransition}} and {{only|{{csgo}}}} {{ent|Lightmapped_4WayBlend}}.}}
{{Bug|This parameter does not exist for {{ent|LightmappedGeneric}}, {{ent|WorldVertexTransition}} and {{only|{{csgo}}}} {{ent|Lightmapped_4WayBlend}}.}}
{{Bug|Does not work with {{ent|$treesway}}.}}
{{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.}}
{{MatParam|$detailblendmode|int|How to combine the detail material with the albedo.}}
{{MatParam|$detailblendmode|int|How to combine the detail material with the albedo.}}
:There are 12 different detail blend methods that can be used.
:There are 12 different detail blend methods that can be used.
Line 92: Line 96:
* In {{as}}{{ent|LightmappedGeneric}} and {{ent|WorldVertexTransition}} Mode 6 is not supported. Additionally 7 does not work with {{ent|$bumpmap2}}, {{ent|$softedges}} and {{ent|$blendmodulatetexture}}.
* In {{as}}{{ent|LightmappedGeneric}} and {{ent|WorldVertexTransition}} Mode 6 is not supported. Additionally 7 does not work with {{ent|$bumpmap2}}, {{ent|$softedges}} and {{ent|$blendmodulatetexture}}.
* In {{l4d2}} Modes 1, 4, 6, 9, and 10 are not supported.
* In {{l4d2}} Modes 1, 4, 6, 9, and 10 are not supported.
<br>
 
{{MatParam|$detailtint|RGB matrix|Color tint of the detail texture.}}
{{MatParam|$detailtint|RGB matrix|Color tint of the detail texture.
{{Bug|In {{src13}} {{tf2}} {{as}} {{csgo}} On {{ent|VertexLitGeneric}}. Does not work with {{ent|$bumpmap}} or {{ent|$phong}}}}
{{Bug
| In {{src13}} {{tf2}} {{as}} {{csgo}} On {{ent|VertexLitGeneric}}. Does not work with {{ent|$bumpmap}} or {{ent|$phong}}}}
{{Bug|Does not work with {{ent|$blendtintbybasealpha}}<br>
{{Bug|Does not work with {{ent|$blendtintbybasealpha}}<br>
{{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."{{important|Since '''at minimum''' {{src13}} this parameter does not actually do anything!}}|removed={{csgo}}}}
{{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.
Line 113: Line 121:
{{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}}
<br>
<br>
==={{csgo}}{{portal2}} <tt>SolidEnergy</tt> Parameters===
=== {{csgo}}{{portal2}} <tt>SolidEnergy</tt> Parameters ===
{{Todo|Confirm if all of this information is actually true for {{portal2}}}}
{{Todo|Confirm if all of this information is actually true for {{portal2}}}}
{{confirm|Is {{ent|SolidEnergy}} available in {{csgobranch}}–branch games?}}
{{Confirm|Is {{ent|SolidEnergy}} available in {{csgobranch}}–branch games?}}
{{Note|$detail1tint and $detail2tint do not exist on this Shader, they are missing in this list intentionally!}}
{{Note|$detail1tint and $detail2tint do not exist on this Shader, they are missing in this list intentionally!}}
{{important|<code>$detail</code> has very similar parameter names, but they are not the same! }}
{{Important|<code>$detail</code> has very similar parameter names, but they are not the same! }}
 
{{MatParam|$detail1|texture|Detail texture for {{ent|SolidEnergy}}'s second layer.|only={{csgo}}{{portal2}}|shaders=SolidEnergy}}
{{MatParam|$detail1|texture|Detail texture for {{ent|SolidEnergy}}'s second layer.|only={{csgo}}{{portal2}}|shaders=SolidEnergy}}
{{MatParam|$detail1blendmode|int|How to combine the detail material with the albedo.|only={{csgo}}{{portal2}}|shaders=SolidEnergy}}
{{MatParam|$detail1blendmode|int|How to combine the detail material with the albedo.|only={{csgo}}{{portal2}}|shaders=SolidEnergy}}
Line 136: Line 145:
{{MatParam|$detail1scale|float|Detail scale for <tt>$detail2</tt>. {{Note| Does not appear to do anything.}}|only={{csgo}}{{portal2}}|shaders=SolidEnergy}}
{{MatParam|$detail1scale|float|Detail scale for <tt>$detail2</tt>. {{Note| Does not appear to do anything.}}|only={{csgo}}{{portal2}}|shaders=SolidEnergy}}
{{MatParam|$detail1blendfactor|float|Detail blend factor for <tt>$detail2</tt>. {{Note| Does not appear to do anything.}}|only={{csgo}}{{portal2}}|shaders=SolidEnergy}}
{{MatParam|$detail1blendfactor|float|Detail blend factor for <tt>$detail2</tt>. {{Note| Does not appear to do anything.}}|only={{csgo}}{{portal2}}|shaders=SolidEnergy}}
{{MatParam|$detail1frame|int|The frame to start an animated <code>$detail1</code> texture on.|only={{csgo}}{{portal2}}|shaders=SolidEnergy}}
{{MatParam|$detail1frame|int|only={{csgo}}{{portal2}}|shaders=SolidEnergy|The frame to start an animated <code>$detail1</code> texture on.


{{important|{{csgo}}s {{ent|WorldVertexTransition}} Shader has very similar <code>$detail2</code> parameter names, but they are not the same!}}
{{important|{{csgo}}s {{ent|WorldVertexTransition}} Shader has very similar <code>$detail2</code> parameter names, but they are not the same!}}}}
{{MatParam|$detail2|texture|Detail texture for {{ent|SolidEnergy}}'s third layer.|only={{csgo}}{{portal2}}|shaders=SolidEnergy}}
{{MatParam|$detail2|texture|Detail texture for {{ent|SolidEnergy}}'s third layer.|only={{csgo}}{{portal2}}|shaders=SolidEnergy}}
{{MatParam|$detail2blendmode|int|How to combine the detail material with the albedo.|only={{csgo}}{{portal2}}|shaders=SolidEnergy}}
{{MatParam|$detail2blendmode|int|How to combine the detail material with the albedo.|only={{csgo}}{{portal2}}|shaders=SolidEnergy}}

Revision as of 09:45, 16 March 2023

English (en)Français (fr)中文 (zh)Translate (Translate)
A detail texture (noise_detail_01), and its effect when applied to a material (left).

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 Half-Life 2: Episode Two.

Icon-Bug.pngBug:$Detail textures do not work in conjunction with some parameters :  [todo tested in ?]
Note.pngNote: In Counter-Strike: Global Offensive, LightmappedGeneric does not appear to even have $lightwarptexture as a parameter... So it 'cannot not' work.
Todo:  Document issues from other branches of source.
Todo:  Things that don't work in Alien Swarm, usually don't work in Left 4 Dead either. And vice versa. But it'd be better if someone could confirm this.
Note.pngNote: Previously it was stated that $blendmodulatetexture would only work with $detail in Counter-Strike: Global Offensive. however. This does appear to work, in at least Source 2013Team Fortress 2Alien Swarm and Counter-Strike: Global Offensive.

Syntax

$detail <texture>

You will probably want to use at least $detailscale (see below) as well.

Parameters and Effects

$detailtexturetransform

$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.
Blend modes in L4D2, factor .8 (Left to right modes 0 to 11, base texture only and detail only. Top row detail opacity 100%, bottom 50%).
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.
Note.pngNote:You can use this to get a standard bumpmap and a self-shadowing bumpmap on the same material. However, this is expensive and should be used very sparingly.
11 SSBump Albedo Unknown function, used internally. The comment says, "shader does the magic here - no user needs to specify mode 11."
Icon-Important.pngImportant:Below is listed, what blendmodes, work in which games, on what shaders. Using a non-supported Blendmode can/will result in "Missing Shader Combo" errors flooding the Console. The Material will not Render!

$detailtint

$detailframe $detail_alpha_mask_base_texture

Counter-Strike: Global Offensive WorldVertexTransition Parameters

Confirm:are these limited to Counter-Strike: Global Offensive, or are they in some/all CS:GO engine branch–branch games?

$detail2 $detailscale2 $detailblendfactor2 $detailframe2 $detailtint2

Counter-Strike: Global OffensivePortal 2 SolidEnergy Parameters

Todo: Confirm if all of this information is actually true for Portal 2
Confirm:Is SolidEnergy available in CS:GO engine branch–branch games?
Note.pngNote:$detail1tint and $detail2tint do not exist on this Shader, they are missing in this list intentionally!
Icon-Important.pngImportant:$detail has very similar parameter names, but they are not the same!

$detail1 $detail1blendmode

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 $detail2blendmode

There are 2 different detail blend methods that can be used.
Mode Effect Description
0 Additive Adds $detail2 onto the $basetexture.
Note.pngNote:When using a $detail1, $detail2 will first be multiplied by $detail2!
1 Multiply $basetexture is multiplied by $detail2.
Note.pngNote:There is no way to control the strength of the effect.

$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 Half-Life 2 and in Half-Life 2: Episode One 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