$detail: Difference between revisions

Revision as of 02:16, 16 February 2023

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.

Bug:Detail textures do not currently work in conjunction with $seamless_scale. Enabling them to work together would require a programmer to edit the used shader. [todo tested in ?]

Bug:Detail textures are not compatible with $blendmodulatetexture except in

. [todo tested in ?]

Syntax

$detail <texture>

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

Parameters and Effects

$detailtexturetransform

Bug:Does not currently function at all in

. [todo tested in ?]

$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: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."

Important: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!

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.

$detailtint $detailframe $detail_alpha_mask_base_texture

`WorldVertexTransition` Parameters

Confirm:are these limited to

, or are they in some/all

–branch games?

$detail2 $detailscale2 $detailblendfactor2 $detailframe2 $detailtint2

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

@@ Line 16: / Line 16: @@
 {{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|$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.
 :The blend modes are implemented in <code>stdshaders/common_ps_fx.h</code>.
+[[Image:Detail_blend_modes_l4d2.jpg||320px|thumb|right|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%).]]
+{| class="standard-table"
+! Mode
+! width="180px" | Effect
+! Description
+|-
+| 0
+| DecalModulate
+| This functions the same as the {{ent|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 {{ent|$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 {{ent|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) {{ent|$ssbump}} bumpmap. The blend factor is ignored.{{Note|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."
+|}
 {{Important|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!}}
-In {{csgo}} {{ent|LightmappedGeneric}} Modes 1-6 and 8 are not supported. 9 not with {{ent|$bumpmap}}, {{ent|$envmap}}, {{ent|$selfillum}}.
+* In {{csgo}} {{ent|LightmappedGeneric}} Modes 1-6 and 8 are not supported. 9 not with {{ent|$bumpmap}}, {{ent|$envmap}}, {{ent|$selfillum}}.
+* In {{csgo}} {{ent|WorldVertexTransition}} Modes 1-6, 8-9 are not supported. 7 Does not work with {{ent|$blendmodulatetexture}}.
-In {{csgo}} {{ent|WorldVertexTransition}} Modes 1-6, 8-9 are not supported. 7 Does not work with {{ent|$blendmodulatetexture}}.
+* In {{csgo}} {{ent|VertexLitGeneric}} Modes 0-9 are supported '''without''' {{ent|$bumpmap}}, 0-7 '''with'''. However only with {{ent|$phong}}, 5 & 6 usable. The Shader without {{ent|$phong}} doesn't have the code to use 5 & 6.
+* In {{csgo}} {{ent|Lightmapped_4WayBlend}} Modes 1-6 are not supported.
-In {{csgo}} {{ent|VertexLitGeneric}} Modes 0-9 are supported '''without''' {{ent|$bumpmap}}, 0-7 '''with'''. However only with {{ent|$phong}}, 5 & 6 usable. The Shader without {{ent|$phong}} doesn't have the code to use 5 & 6.
+* In {{src13}} {{tf2}} {{ent|LightmappedGeneric}} Modes 2-9 are not supported.
+* In {{src13}} {{tf2}} {{as}}{{ent|VertexLitGeneric}} Modes 0-9 are supported '''without''' {{ent|$bumpmap}}, 0-6 '''with'''. However only with {{ent|$phong}}, 5 & 6 usable. The Shader without {{ent|$phong}} doesn't have the code to use 5 & 6.
+* 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.
+{{MatParam|$detailtint|RGB matrix|Color tint of the detail texture.{{bug|Does not work with {{ent|$blendtintbybasealpha}}.}}
-In {{csgo}} {{ent|Lightmapped_4WayBlend}} Modes 1-6 are not supported.
-In {{src13}} {{tf2}} {{ent|LightmappedGeneric}} Modes 2-9 are not supported.
-In {{src13}} {{tf2}} {{as}}{{ent|VertexLitGeneric}} Modes 0-9 are supported '''without''' {{ent|$bumpmap}}, 0-6 '''with'''. However only with {{ent|$phong}}, 5 & 6 usable. The Shader without {{ent|$phong}} doesn't have the code to use 5 & 6.
-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 cause "Missing Shader Combo" errors, and are thus not supported.
-[[Image:Detail_blend_modes_l4d2.jpg||320px|thumb|right|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%).]]
-*0 {{=}} DecalModulate
-:This functions the same as the {{ent|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 {{ent|$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 {{ent|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) {{ent|$ssbump}} bumpmap. The blend factor is ignored.{{Note|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."
-*12+
-:Any other values will disable the detail effect.}}
-{{MatParam|$detailtint|RGB matrix|Color tint of the detail texture.{{bug|Does not work with {{ent|$blendtintbybasealpha}}.}}
 ::{{todo|Verify which games this is broken in (tested in L4D2, TF2, Portal 2 and CS:GO).}}}}
 {{MatParam|$detailframe|int|The frame to start an animated <code>$detail</code> texture on.|dx9=1}}

$detail: Difference between revisions

Revision as of 02:16, 16 February 2023

Contents

Syntax

Parameters and Effects

`WorldVertexTransition` Parameters

Valve's Detail Textures

See Also

Navigation menu

$detail: Difference between revisions

Revision as of 02:16, 16 February 2023

Syntax

Parameters and Effects

WorldVertexTransition Parameters

Valve's Detail Textures

See Also

Navigation menu

Search

`WorldVertexTransition` Parameters