Template:Shader Documentation: Difference between revisions

Latest revision as of 17:41, 18 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
Shader behavior overview	`sbo`	Parameters for the shader behavior overview	String	optional
Overview	`overview`	Overview content	Content	required
Related shaders	`related shaders`	List of related shaders	String	optional
Behavior	`behavior`	Behavior content	Content	optional
Multi tangent	`multi tangent`	Multi tangent behavior	Content	optional
Vertex color	`vertex colors`	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

Example

Return to shaders list

Overview

Shader Behavior Overview

Shader model:

[2] Standard (PBR)
Uses:

Noise dithering

Does not support:

A standard PBR shader with no special behavior.

Related shaders

Behavior

Lorem ipsum.

Multi-tangent

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 Features
`is_compute_instancing`
`is_use_tex_srt_anim`
`enable_deferred_rendering`
`enable_alpha_threshold`
`is_use_gi_prt`
`is_use_gi_sg`
`is_use_gi`

Other

Outside template

@@ Line 2: / Line 2: @@
 [[{{{game}}} Shaders|Return to shaders list]]
 == Overview ==
-{{SXSG Shader Behavior
+{{#invoke:ShaderDoc|create_sbo|game={{{game}}}|parameters={{{sbo|}}}}}
-| model = 2
-}}
 {{{overview}}}
 {{#if:{{{related shaders|}}}|
@@ Line 14: / Line 12: @@
 == Behavior ==
 {{{behavior|}}}
+{{#if:{{{multi tangent|}}}|
+=== Multi-tangent ===
+{{{multi tangent}}}
+|}}
+=== Vertex Colors ===
+{{{vertex colors|Shader does not use vertex colors}}}
-=== Vertex Colors ===
+<div style="clear: both"/>
-{{{vertex color|Shader does not use vertex colors}}}
 == Material Inputs ==
@@ Line 54: / Line 57: @@
 {{!}}-
 !Shader Features
-{{#invoke:ShaderDoc|technical_features
+{{#invoke:ShaderDoc|technical_features|{{{features}}}}}
-|features={{{features}}}
+{{!}}}|}}<nowiki/></includeonly>
-}}
-{{!}}}|}}</includeonly>
 <noinclude>
 <templatedata>
 {
-	"params": {
+    "params": {
          "game": {
-			"label": "Game",
+            "label": "Game",
-			"description": "Which game this shader belongs to",
+            "description": "Which game this shader belongs to",
-			"type": "string",
+            "type": "string",
-			"required": true
+            "required": true
-		},
+        },
-		"shader name": {
+        "shader name": {
-			"label": "Shader name",
+            "label": "Shader name",
-			"description": "The name of the shader",
+            "description": "The name of the shader",
-			"type": "string",
+            "type": "string",
-			"required": true
+            "required": true
-		},
+        },
-		"overview": {
+        "sbo": {
-			"label": "Overview",
+            "label": "Shader behavior overview",
-			"description": "Overview content",
+            "description": "Parameters for the shader behavior overview",
-			"type": "content",
+            "type": "string",
-			"required": true
+            "required": false
-		},
+        },
-		"related shaders": {
+        "overview": {
-			"label": "Related shaders",
+            "label": "Overview",
-			"description": "List of related shaders",
+            "description": "Overview content",
-			"type": "string",
+            "type": "content",
-			"required": false
+            "required": true
-		},
+        },
+        "related shaders": {
+            "label": "Related shaders",
+            "description": "List of related shaders",
+            "type": "string",
+            "required": false
+        },
          "behavior": {
-			"label": "Behavior",
+            "label": "Behavior",
-			"description": "Behavior content",
+            "description": "Behavior content",
-			"type": "content",
+            "type": "content",
-			"required": false
+            "required": false
-		},
+        },
-         "vertex color": {
+        "multi tangent": {
-			"label": "Vertex color",
+            "label": "Multi tangent",
-			"description": "Vertex color behavior",
+            "description": "Multi tangent behavior",
-			"type": "content",
+            "type": "content",
-			"required": false
+            "required": false
-		},
+        },
+         "vertex colors": {
+            "label": "Vertex color",
+            "description": "Vertex color behavior",
+            "type": "content",
+            "required": false
+        },
          "textures": {
-			"label": "Textures",
+            "label": "Textures",
-			"description": "Texture table contents; Fields seperated by commas, column spans specified by underscores and rows seperated by semicolons",
+            "description": "Texture table contents; Fields seperated by commas, column spans specified by underscores and rows seperated by semicolons",
-			"type": "content",
+            "type": "content",
-			"required": false
+            "required": false
-		},
+        },
          "parameters": {
-			"label": "Parameters",
+            "label": "Parameters",
-			"description": "Parameter table contents; Fields seperated by commas, column spans specified by underscores and rows seperated by semicolons",
+            "description": "Parameter table contents; Fields seperated by commas, column spans specified by underscores and rows seperated by semicolons",
-			"type": "content",
+            "type": "content",
-			"required": false
+            "required": false
-		},
+        },
          "technical": {
-			"label": "Technical",
+            "label": "Technical",
-			"description": "Technical information",
+            "description": "Technical information",
-			"type": "content",
+            "type": "content",
-			"required": false
+            "required": false
-		},
+        },
          "features": {
-			"label": "Shader features (technical)",
+            "label": "Shader features (technical)",
-			"description": "List of technical features that the shader has been compiled with",
+            "description": "List of technical features that the shader has been compiled with",
-			"type": "content",
+            "type": "content",
-			"required": false
+            "required": false
-		}
+        }
-	}
+    }
 }
 </templatedata>
-WIP
 == Example ==
@@ Line 134: / Line 145: @@
 | shader name = Common_dpn
+| sbo = model=2,
+no_opaque_layer,
+no_punch_through_layer,
+noise_dithering
 | overview = A standard PBR shader with no special behavior.
@@ Line 146: / Line 162: @@
 | behavior = Lorem ipsum.
-| vertex color =
+| multi tangent =
+Lorem ipsum.
+| vertex colors =
 * Color is multiplied into the <code>diffuse</code> texture color
 * Alpha is multiplied into the <code>diffuse</code> texture alpha
@@ Line 172: / Line 191: @@
 is_use_gi_prt,
 is_use_gi_sg,
 is_use_gi
 }}
+== Other ==
+Outside template
 </noinclude>