Template:MatParamDef: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(Fix, removed todo for no description)
(Added obsolete icon for deprecated material parameters)
Line 31: Line 31:


<hr>
<hr>
</noinclude>; {{#if: {{{deprecated|}}} | <del> }}<code>{{{1}}}</code> {{#if: {{{to|}}} | <span style="font-weight: normal;">to</span> <code>{{{to}}}</code> }} {{#if: {{{2|}}} | {{KV Type|{{{2}}}}} }}{{#if: {{{deprecated|}}} | </del> }}{{#if: {{{since|}}} | &nbsp;{{{{{since}}} add}} }}{{#if: {{{only|}}} | &nbsp;{{{{{only}}} only}} }}{{#if: {{{also|}}} | &nbsp;{{{{{also}}} also}} }}{{#if: {{{dx8|}}} | &nbsp;{{Dx8}} }}{{#if: {{{dx9|}}} | &nbsp;{{Dx9}} }}
</noinclude>; {{#if: {{{deprecated|}}} | <del> }}<code>{{{1}}}</code> {{#if: {{{to|}}} | <span style="font-weight: normal;">to</span> <code>{{{to}}}</code> }} {{#if: {{{2|}}} | {{KV Type|{{{2}}}}} }}{{#if: {{{deprecated|}}} | </del> }}{{#if: {{{since|}}} | &nbsp;{{{{{since}}} add}} }}{{#if: {{{only|}}} | &nbsp;{{{{{only}}} only}} }}{{#if: {{{also|}}} | &nbsp;{{{{{also}}} also}} }}{{#if: {{{dx8|}}} | &nbsp;{{Dx8}} }}{{#if: {{{dx9|}}} | &nbsp;{{Dx9}} }} {{#if: {{{deprecated|}}} | &nbsp;{{obs}} }}
: {{#if: {{{3|}}} | {{{3}}}}}
: {{#if: {{{deprecated|}}} | Deprecated.&nbsp; }} {{#if: {{{3|}}} | {{{3}}}}}

Revision as of 12:27, 26 June 2019

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

Basic usage

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

Note.pngNote: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
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
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
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
dx9 This material parameter requires DX9 or higher to function. {{MatParam|$dx9parameter|boolean|I require DX9 to work!|dx9=1}} $dx9parameter
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
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

See also


{{{1}}}