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

$rimlight

From Valve Developer Community
(Redirected from $rimmask)
Jump to: navigation, search
English (en)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 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