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

$rimlight: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(Added note - Bumpmap is required for this to work)
No edit summary
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
{{LanguageBar}}
{{LanguageBar}}


[[File:Heavy_rim.jpg|thumb|200px|Example of rim lighting in use on the TF2 Heavy.]]


[[File:Heavy_rim.jpg|thumb|200px|Example of rim lighting in use on the TF2 Heavy.]]
{{This is a|shader parameter|name=$rimlight|shader=VertexLitGeneric|since=Source 2007}} It adds a constant rim light to the model that appears to come indirectly from the environment. The color of the rim light is directly influenced by [[ambient light]] and behave closer to [[$phong#Brightness|$phongfresnelranges]] [[vector|Z component]].
{{This is a|shader parameter|name=$rimlight|shader=VertexLitGeneric|since=Source 2007}} It adds a constant rim light to the model that appears to come indirectly from the environment. The color of the rim light is directly influenced by [[ambient light]] and behave closer to [[$phong#Brightness|$phongfresnelranges]] [[vector|Z component]].
{{note|Requires {{ent|$phong}} to be set to 1.}}
{{note|Requires {{ent|$phong}} to be set to 1.}}
Line 29: Line 29:


== Additional Parameters ==
== Additional Parameters ==
{{MatParam|$rimlightexponent|int|Exponent for phong component of rim lighting. The rim exponent defines the "tightness" of the highlight. A higher exponent results in a smaller, tighter highlight while a lower exponent results in a broader flatter one. {{bug|Appears to have no effect in HLMV.}}}}
{{MatParamDef|$rimlightexponent|int|Exponent for phong component of rim lighting. The rim exponent defines the "tightness" of the highlight. A higher exponent results in a smaller, tighter highlight while a lower exponent results in a broader flatter one. {{bug|Appears to have no effect in HLMV.}}}}
{{MatParam|$rimlightboost|float|Additive boost for ambient cube component of rim lighting.}}
{{MatParamDef|$rimlightboost|float|Additive boost for ambient cube component of rim lighting.}}
{{MatParam|$rimmask|bool|Uses the alpha channel of the <code>$phongexponenttexture</code> to mask rimlighting.}}
{{MatParamDef|$rimmask|bool|Uses the alpha channel of the <code>$phongexponenttexture</code> to mask rimlighting.}}
{{MatParam|$phongtint|RGB matrix|By default the rim light is white, This will tint both, phong and rim lighting. See [[$phong#Colors|Phong]] for more.}}
{{MatParamDef|$phongtint|RGB matrix|By default the rim light is white, This will tint both, phong and rim lighting. See [[$phong#Colors|Phong]] for more.}}


== See also ==
== See also ==

Latest revision as of 11:42, 23 August 2025

English (en)中文 (zh)Translate (Translate)
Example of rim lighting in use on the TF2 Heavy.

$rimlight is a material shader parameter for the VertexLitGeneric shader available in all Source Source games since Source 2007 Source 2007. It adds a constant rim light to the model that appears to come indirectly from the environment. The color of the rim light is directly influenced by ambient light and behave closer to $phongfresnelranges Z component.

Note.pngNote:Requires $phong to be set to 1.
Note.pngNote:A $bumpmap is required for rimlighting to work, as $phong requires one.
Todo: Explain similarities and differences of Phong Fresnel ranges.
Warning.pngWarning:Left 4 Dead seriesLeft 4 Dead series Features no visible effect. however, you can increase $phongfresnelranges Z vector to archive a closer effect.

VMT syntax

$rimlight <bool>
 VertexLitGeneric
{
	$phong			1

	$bumpmap		<texture>
	$phongexponent		5		
	$phongexponenttexture	<texture>	
	$phongboost		1.0
	$phongfresnelranges	"[0 0.5 1]"

	$rimlight               1
	$rimlightexponent       2
	$rimlightboost          .2			
}

Additional Parameters

Exponent for phong component of rim lighting. The rim exponent defines the "tightness" of the highlight. A higher exponent results in a smaller, tighter highlight while a lower exponent results in a broader flatter one.
Icon-Bug.pngBug:Appears to have no effect in HLMV.  [todo tested in ?]
Additive boost for ambient cube component of rim lighting.
Uses the alpha channel of the $phongexponenttexture to mask rimlighting.
By default the rim light is white, This will tint both, phong and rim lighting. See Phong for more.

See also