Template:MatParamDef: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (shader(s))
(Added {{{described}}})
 
(21 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Lang}}
{{Doc}}
{{Doc}}
<includeonly><onlyinclude><div style="display:grid; margin-bottom:16px"><div style="background:linear-gradient(90deg, #2a2a2a 60%, #262626); border:1px dotted rgba(255,255,255,.2); border-radius:4px; border-left:4px solid rgba(255,255,255,.2); padding:2px 9px; margin-top:2px">


<div style="display:flex; flex-wrap:wrap; {{#if:{{{text|}}}{{{3|}}}|background:linear-gradient(90deg, #2a2a2a 60%, #262626); border-bottom:1px dotted rgba(255,255,255,.2);|}} position:sticky; z-index:10; padding:{{#if:{{{text|}}}{{{3|}}}|2px 0 4px 0|2px 0}}; top:0">
<includeonly>
 
<onlyinclude><div id="{{{1|}}}" style="display:grid; margin-bottom:16px"><!--
--><div style="display:flex; flex-wrap:wrap; box-shadow:0 2px 0 rgb(0 0 0 / 10%); background-image:linear-gradient(90deg, rgb(49 49 49) 60%, rgb(45 45 45)); border:thick double rgb(255 255 255 / 3%); border-radius:.3em .3em 0 0; position:sticky; padding:.5em 1em; top:0; z-index:10">
<div><!--
<div><!--
--><kbd><!--
--><kbd><!--
--><span style="color:#{{#if:{{{deprecated|}}}|DD6A6A|86CF5B}}">{{Trim|[[{{{1|}}}]]}}</span><!--
-->{{ {{#if:{{{nolink|}}}|Strong|Lx}} |{{{1}}}}}<!--
-->{{#if:{{{to|}}}|&nbsp;to <span style="color:#{{#if:{{{deprecated|}}}|DD6A6A|86CF5B}}">[[{{{to}}}]]</span>}}<!--
-->{{#if:{{{to|}}}|&nbsp;to {{ {{#if:{{{nolink|}}}|Strong|Lx}} |{{{to}}}}}}}<!--
-->{{#if:{{{and|}}}|&nbsp;and <span style="color:#{{#if:{{{deprecated|}}}|DD6A6A|86CF5B}}">[[{{{and}}}]]</span>}}<!--
-->{{#if:{{{and|}}}|&nbsp;and {{ {{#if:{{{nolink|}}}|Strong|Lx}} |{{{and}}}}}}}<!--
--></kbd><!--
--></kbd><!--
-->&nbsp;{{VT|{{{2|}}}}}<!--
-->&nbsp;{{VT|{{{2|}}}}}<!--
Line 19: Line 20:
-->{{#if:{{{removed|}}} | &nbsp;{{removed|{{{removed|}}}}} }}
-->{{#if:{{{removed|}}} | &nbsp;{{removed|{{{removed|}}}}} }}
</div><!--
</div><!--
-->{{#if:{{{value|}}} | <span style="display:flex; background:#202020; border-radius:2px; font-size:0.9em; padding:0 4px; margin-left:auto">'''Default Value:'''&nbsp;{{{value|}}}</span> }}<!--
-->{{#if:{{{value|}}} | &ensp;<span style="display:flex; background:#202020; border-radius:2px; font-size:0.9em; padding:0 4px">'''Default Value:'''&nbsp;{{{value|}}}</span> }}<!--
-->{{#if:{{{shaders|}}} | <span style="display:flex; background:#202020; border-radius:2px; font-size:0.9em; padding:0 4px; margin-left:auto">'''Shader(s):'''&nbsp;{{{shaders|}}}</span> }}
-->{{#if:{{{shaders|}}} | &ensp;<span style="display:flex; background:#202020; border-radius:2px; font-size:0.9em; padding:0 4px">'''Shader(s):'''&nbsp;{{{shaders|}}}</span> }}
</div>
</div>
<div style="background-color:rgb(40 40 40); border:thick double rgb(255 255 255 / 3%); border-top:0; border-radius:0 0 .3em .3em; padding:.5em 1em">{{#switch:{{{described|}}}
| true = This [[material]] [[shader]] parameter is described on [[{{{1}}}|its own page]].
| #default = {{#if:{{{text|}}}{{{3|}}}|{{{text|{{{3}}}}}}|{{todo|This [[material]] [[shader]] parameter has not been described.}}}}
}}</div></div></onlyinclude>


<div style="margin:4px 0">{{{text|{{{3|}}}}}}</div>
</includeonly>
 
</div></div></onlyinclude></includeonly>

Latest revision as of 08:59, 27 August 2025

English (en)Deutsch (de)Esperanto (eo)Español (es)Français (fr)Suomi (fi)Hrvatski (hr)Magyar (hu)Italiano (it)日本語 (ja)한국어 (ko)Nederlands (nl)Polski (pl)Português (pt)Português do Brasil (pt-br)Русский (ru)Slovenčina (sk)Svenska (sv)Türkçe (tr)Українська (uk)Tiếng Việt (vi)中文 (zh)中文（臺灣） (zh-tw)
Curly brackets white.pngTemplate Documentation [view] [edit]
Icon-translate.png Available doc translations
Page history
…

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

Usage

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

Examples and Parameters

Warning.pngWarning:The code in the example will not work correctly due to the use of <kbd> in the template. Please refer to the $bumpmap page code to see the current code.
Parameter Description Example Preview
{{{text}}}
or
{{{3}}} 		Description of the parameter.

If specified, then you will not encounter the problem of a broken description if there are equal signs in it.

You can also use {{=}}, but this may overload the page.

If not specified, it is replaced with TODO. 

{{MatParamDef
| $stupidequalsign | bool | text = Wow, I've been fixed! Look at this {{Emoji|point_right}} 2 + 2 = 5
}}
Wow, I've been fixed! Look at this {{Emoji|point_right}} 2 + 2 = 5
{{{described}}} Replaces the text with a link to the specified material parameter. 
{{MatParamDef
| $describedcutie | texture | described = true
}}
This material shader parameter is described on its own page.
{{{deprecated}}} This material parameter is deprecated and should no longer be used. 
{{MatParamDef
| I'm deprecated | bool | deprecated = 1
| Really, don't use me anymore!
}}
Really, don't use me anymore!
{{{since}}} This material parameter is available since this game. Uses the template {{Since}}. 
{{MatParamDef
| $likealienswarm | bool | since = {{as}}
| I'm available in Portal 2, too!
}}
$likealienswarm <boolean> (in all games since Alien Swarm)
I'm available in Portal 2, too!
{{{also}}} This material parameter is also available in this game. Uses the template {{Also}}. 
{{MatParamDef
| $likealienswarm | bool | since = {{as}} | also = {{GMOD}}
| I'm also available in Garry's Mod!
}}
$likealienswarm <boolean> (in all games since Alien Swarm) (also in Garry's Mod)
I'm also available in Garry's Mod!
{{{only}}} This material parameter is available only in this/these game(s). Uses the template {{Only}}. 
{{MatParamDef
| $lovealienswarm | integer | only = {{as}}
| I'm only available in Alien Swarm!
}}
$lovealienswarm <integer> (only in Alien Swarm)
I'm only available in Alien Swarm!
{{{removed}}} This material parameter was removed in this game. Uses the template {{Removed}}. 
{{MatParamDef
| $dxparameter | int | removed = {{l4d}}
| I was removed in Left 4 Dead!
}}
$dxparameter <integer> (removed since Left 4 Dead)
I was removed in Left 4 Dead!
{{{dx9}}} This material parameter requires DX9 or higher to function. 
{{MatParamDef
| $dx9parameter | bool | dx9 = 1
| I require DX9 to work!
}}
$dx9parameter <boolean> (DX9 SM2)
I require DX9 to work!
{{{dx8}}} This material parameter is for DX8, and should not be used for DX9. 
{{MatParamDef
| $dx8parameter | bool | dx8 = 1
| I'm a material parameter for DX8!
}}
I'm a material parameter for DX8!
{{{to}}} Use this to define a set of material parameters with very similar names. 
{{MatParamDef
| $basetexture1 | to = $basetexture4 | texture
| There are many of us...
}}
There are many of us...
{{{and}}} Use this to define two material parameters with very similar names. 
{{MatParamDef
| $bumpmap | and = $bumpmap2 | texture
| This shader supports two bump maps.
}}
This shader supports two bump maps.
{{{shaders}}} Lists the shaders for a specific material parameter. Uses the template {{Shaders}}. 
{{MatParamDef
| $shaderspecificparameter | float | shaders = VertexLitGeneric, UnlitGeneric
| I only work with specific shaders!
}}
 Shader(s): VertexLitGeneric, UnlitGeneric
I only work with specific shaders!
{{{value}}} Default value of the parameter. 
{{MatParamDef
| $defaultvalue | integer | value = 1
| Why do I have such a small value? :(
}}
 Default Value: 1
Why do I have such a small value? :(

See also

The above documentation is transcluded from Template:MatParamDef/doc. (Edit | Page history)
Editors can experiment in this template's sandbox (edit) and testcases (create) pages.


Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Template:MatParamDef&oldid=487751"