Template:Shader Documentation: Difference between revisions

Revision as of 18:04, 17 August 2025

No description.

Template parameters[Edit template data]
Parameter		Description	Type	Status
Game	`game`	Which game this shader belongs to	String	required
Shader name	`shader name`	The name of the shader	String	required
Overview	`overview`	Overview content	Content	required
Related shaders	`related shaders`	List of related shaders	String	optional
Behavior	`behavior`	Behavior content	Content	optional
Vertex color	`vertex color`	Vertex color behavior	Content	optional
Textures	`textures`	Texture table contents; Fields seperated by commas, column spans specified by underscores and rows seperated by semicolons	Content	optional
Parameters	`parameters`	Parameter table contents; Fields seperated by commas, column spans specified by underscores and rows seperated by semicolons	Content	optional
Technical	`technical`	Technical information	Content	optional
Shader features (technical)	`features`	List of technical features that the shader has been compiled with	Content	optional

WIP

Example

Return to shaders list

Overview

Shader Behavior Overview

Shader model:

[2] Standard (PBR)

A standard PBR shader with no special behavior.

Related shaders

Behavior

Lorem ipsum.

Vertex Colors

Color is multiplied into the diffuse texture color
Alpha is multiplied into the diffuse texture alpha

Material Inputs

Textures


Name	Index	UV Index	Kind	Red	Green	Blue	Alpha
`diffuse`	0	0	Albedo	Albedo color			Transparency
`test`	1	2	N/A	N/A	N/A	N/A	N/A

Parameters


Name	X	Y	Z	W
`diffuse`	Albedo color			N/A
`PBRFactor`	Specular factor	Smoothness factor	Metallic factor	N/A

Technical

lorem ipsum.

Shader FeaturesString Module Error: Features not specified

@@ Line 21: / Line 21: @@
 === Textures ===
+{{#if:{{{textures|}}}|
-{| class="wikitable" width="100%"
+{{{!}} class="wikitable" width="100%"
-|+
+{{!}}+
-!width=1%|{{#tip-text: Name|Name of the material texture slot}}
+!width=1%{{!}}{{#tip-text: Name|Name of the material texture slot}}
-!width=1%|{{#tip-text: Index|Index of the texture slot name, starting from 0; This is important when a shader has the same slot name multiple times, in which case their order determines how each slot is used}}
+!width=1%{{!}}{{#tip-text: Index|Index of the texture slot name, starting from 0; This is important when a shader has the same slot name multiple times, in which case their order determines how each slot is used}}
-!width=1%|{{#tip-text: UV Index|Which UV map the slot uses, which is either an index from 0 to 3 or "any", in which case the UV map can be selected in the material.
+!width=1%{{!}}{{#tip-text: UV Index|Which UV map the slot uses, which is either an index from 0 to 3 or "any", in which case the UV map can be selected in the material.
 If a model does not have a UV Map for the specified index, then the game will fall back to UV Index 0}}
-!width=1%|{{#tip-text: Kind|General usage format of the texture slot. More precise documentation is found on the right}}
+!width=1%{{!}}{{#tip-text: Kind|General usage format of the texture slot. More precise documentation is found on the right}}
-!width=24%| {{#tip-text: Red|How the red component of the texture gets used}}
+!width=24%{{!}} {{#tip-text: Red|How the red component of the texture gets used}}
-!width=24%| {{#tip-text: Green|How the green component of the texture gets used}}
+!width=24%{{!}} {{#tip-text: Green|How the green component of the texture gets used}}
-!width=24%| {{#tip-text: Blue|How the blue component of the texture gets used}}
+!width=24%{{!}} {{#tip-text: Blue|How the blue component of the texture gets used}}
-!width=24%| {{#tip-text: Alpha|How the alpha component of the texture gets used}}
+!width=24%{{!}} {{#tip-text: Alpha|How the alpha component of the texture gets used}}
-|-
+{{#invoke:ShaderDoc|shader_table|{{{textures}}}}}
-|}
+{{!}}}|This shader does not use any textures.}}
 === Parameters ===
+{{#if:{{{parameters|}}}|
-{| class="wikitable" width="100%"
+{{{!}} class="wikitable" width="100%"
-|+
+{{!}}+
-!width=1%|{{#tip-text: Name|Name of the parameter}}
+!width=1%{{!}}{{#tip-text: Name|Name of the parameter}}
-!width=25%|{{#tip-text: X|The first component of the parameter}}
+!width=25%{{!}}{{#tip-text: X|The first component of the parameter}}
-!width=25%|{{#tip-text: Y|The second component of the parameter}}
+!width=25%{{!}}{{#tip-text: Y|The second component of the parameter}}
-!width=25%|{{#tip-text: Z|The third component of the parameter}}
+!width=25%{{!}}{{#tip-text: Z|The third component of the parameter}}
-!width=25%|{{#tip-text: W|The fourth component of the parameter}}
+!width=25%{{!}}{{#tip-text: W|The fourth component of the parameter}}
-|-
+{{#invoke:ShaderDoc|shader_table|{{{parameters}}}}}
-|}
+{{!}}}|This shader does not use any parameters.}}
 == Technical ==
@@ Line 161: / Line 161: @@
 ,[[Hedgehog Engine 2 - Physically Based Rendering (PBR)#Metallic|Metallic]] factor
 ,;
 | technical = lorem ipsum.