Template:Shader Documentation: Difference between revisions

Latest revision as of 12:11, 25 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
Overview bug	`overview bug`	Overview bug content	Content	optional
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
Bugs	`bugs`	Bugs in 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
Gallery contents	`gallery`	Picture gallery contents	String	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.

Warning

BUGS! It is advised to not used this shader.

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

Bugs

Warning

BUGS!

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

Gallery

How Detail_dpnn is used for cliffs in Rail Canyon to blend in detail normals when the camera is closer to the surface

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 4: / Line 4: @@
 {{#invoke:ShaderDoc|create_sbo|game={{{game}}}|parameters={{{sbo|}}}}}
 {{{overview}}}
+{{#if:{{{overview bugs|}}}|{{notice
+|type=warn
+|content={{{overview bugs}}}
+It is advised to not used this shader.}}}}
 {{#if:{{{related shaders|}}}|
 === Related shaders ===
@@ Line 18: / Line 22: @@
 === Vertex Colors ===
 {{{vertex colors|Shader does not use vertex colors}}}
+{{#if:{{{bugs|}}}|
+=== Bugs ===
+{{notice
+|type=warn
+|content={{{bugs}}}}}}}
 <div style="clear: both"/>
@@ Line 50: / Line 58: @@
 {{#invoke:ShaderDoc|shader_table|{{{parameters}}}}}
 {{!}}}|This shader does not use any parameters.}}
+{{#if:{{{gallery|}}}|
+== Gallery ==
+{{#tag:gallery|{{{gallery}}}|perrow=4|widths=400px|heights=300px|mode=nolines|}}|}}
 == Technical ==
 {{{technical|}}}
@@ Line 86: / Line 96: @@
              "type": "content",
              "required": true
+        },
+        "overview bug": {
+            "label": "Overview bug",
+            "description": "Overview bug content",
+            "type": "content",
+            "required": false
          },
          "related shaders": {
@@ Line 108: / Line 124: @@
              "label": "Vertex color",
              "description": "Vertex color behavior",
+            "type": "content",
+            "required": false
+        },
+        "bugs": {
+            "label": "Bugs",
+            "description": "Bugs in behavior",
              "type": "content",
              "required": false
@@ Line 121: / Line 143: @@
              "description": "Parameter table contents; Fields seperated by commas, column spans specified by underscores and rows seperated by semicolons",
              "type": "content",
+            "required": false
+        },
+        "gallery": {
+            "label": "Gallery contents",
+            "description": "Picture gallery contents",
+            "type": "string",
              "required": false
          },
@@ Line 152: / Line 180: @@
 | overview = A standard PBR shader with no special behavior.
+| overview bugs =
+BUGS!
 | related shaders =
@@ Line 168: / Line 200: @@
 * Color is multiplied into the <code>diffuse</code> texture color
 * Alpha is multiplied into the <code>diffuse</code> texture alpha
+| bugs =
+BUGS!
 | textures =
@@ Line 181: / Line 216: @@
 ,;
+| gallery = File:ShadowGenerations Detail dpnn example.jpg{{!}}How <code>Detail_dpnn</code> is used for cliffs in Rail Canyon to blend in detail normals when the camera is closer to the surface
 | technical = lorem ipsum.