Template:MatParam

From Valve Developer Community
Jump to: navigation, search

This template is used to generate material shader parameter definitions on material shader pages.

Basic usage

{{MatParam|<name>|<variable type>|<description>}}

Note:Don't forget to use Template:= to escape any "=" characters in the text.

Named parameters

Parameter Description Example Preview
deprecated This material parameter is deprecated and should no longer be used. {{MatParam|I'm deprecated|bool|Really, don't use me anymore!|deprecated=1}}
I'm deprecated <boolean>  <Obsolete>
Deprecated.  Really, don't use me anymore!
since This material parameter is available since this game. Uses the template {{<game> add}}. {{MatParam|$likealienswarm|bool|I'm available in Portal 2, too!|since=AS}}
$likealienswarm <boolean> (New with Alien Swarm)
I'm available in Portal 2, too!
also This material parameter is also available in this game. Uses the template {{<game> also}}. {{MatParam|$likealienswarm|bool|I'm also available in Garry's Mod!|since=AS|also=GMOD}}
$likealienswarm <boolean> (New with Alien Swarm) (Also in Garry's Mod)
I'm also available in Garry's Mod!
only This material parameter is available only in this game. Uses the template {{<game> only}}. {{MatParam|$lovealienswarm|bool|I'm only available in Alien Swarm!|only=AS}}
$lovealienswarm <integer> (Only in Alien Swarm)
I'm only available in Alien Swarm!
dx9 This material parameter requires DX9 or higher to function. {{MatParam|$dx9parameter|boolean|I require DX9 to work!|dx9=1}}
$dx9parameter <boolean> (DX9+)
I require DX9 to work!
dx8 This material parameter is for DX8, and should not be used for DX9. {{MatParam|$dx8parameter|boolean|I'm a material parameter for DX8!|dx8=1}}
$dx8parameter <boolean> (DX8)
I'm a material parameter for DX8!
to Use this to define a set of material parameters with very similar names. {{MatParam|$basetexture1|to=$basetexture4|texture|There are many of us...}}
$basetexture1 to $basetexture4 <texture>
There are many of us...
and Use this to define two material parameters with very similar names. {{MatParam|$bumpmap|and=$bumpmap2|texture|Two bump maps.}}
$bumpmap and $bumpmap2 <texture>
This shader supports two bump maps.

See also


{{{1}}}