Template:Shader Documentation - Revision history

Justin113D: Fixed typo

2025-08-25T12:11:35Z

Fixed typo

← Older revision		Revision as of 12:11, 25 August 2025
Line 7:		Line 7:
	\|type=warn		\|type=warn
	\|content={{{overview bugs}}}		\|content={{{overview bugs}}}
	It is ~~adviced~~ to not used this shader.}}}}		It is advised to not used this shader.}}}}
	{{#if:{{{related shaders\|}}}\|		{{#if:{{{related shaders\|}}}\|
	=== Related shaders ===		=== Related shaders ===

Justin113D: Added bugs panels

2025-08-25T12:11:02Z

Added bugs panels

← Older revision		Revision as of 12:11, 25 August 2025
Line 4:		Line 4:
	{{#invoke:ShaderDoc\|create_sbo\|game={{{game}}}\|parameters={{{sbo\|}}}}}		{{#invoke:ShaderDoc\|create_sbo\|game={{{game}}}\|parameters={{{sbo\|}}}}}
	{{{overview}}}		{{{overview}}}
			{{#if:{{{overview bugs\|}}}\|{{notice
			\|type=warn
			\|content={{{overview bugs}}}
			It is adviced to not used this shader.}}}}
	{{#if:{{{related shaders\|}}}\|		{{#if:{{{related shaders\|}}}\|
	=== Related shaders ===		=== Related shaders ===
Line 18:		Line 22:
	=== Vertex Colors ===		=== Vertex Colors ===
	{{{vertex colors\|Shader does not use vertex colors}}}		{{{vertex colors\|Shader does not use vertex colors}}}
			{{#if:{{{bugs\|}}}\|
			=== Bugs ===
			{{notice
			\|type=warn
			\|content={{{bugs}}}}}}}
	<div style="clear: both"/>		<div style="clear: both"/>

Line 88:		Line 96:
	"type": "content",		"type": "content",
	"required": true		"required": true
			},
			"overview bug": {
			"label": "Overview bug",
			"description": "Overview bug content",
			"type": "content",
			"required": false
	},		},
	"related shaders": {		"related shaders": {
Line 110:		Line 124:
	"label": "Vertex color",		"label": "Vertex color",
	"description": "Vertex color behavior",		"description": "Vertex color behavior",
			"type": "content",
			"required": false
			},
			"bugs": {
			"label": "Bugs",
			"description": "Bugs in behavior",
	"type": "content",		"type": "content",
	"required": false		"required": false
Line 160:		Line 180:

	\| overview = A standard PBR shader with no special behavior.		\| overview = A standard PBR shader with no special behavior.

			\| overview bugs =

			BUGS!

	\| related shaders =		\| related shaders =
Line 176:		Line 200:
	* Color is multiplied into the <code>diffuse</code> texture color		* Color is multiplied into the <code>diffuse</code> texture color
	* Alpha is multiplied into the <code>diffuse</code> texture alpha		* Alpha is multiplied into the <code>diffuse</code> texture alpha

			\| bugs =
			BUGS!

	\| textures =		\| textures =

Justin113D: Added gallery

2025-08-22T20:42:12Z

Added gallery

← Older revision		Revision as of 20:42, 22 August 2025
Line 50:		Line 50:
	{{#invoke:ShaderDoc\|shader_table\|{{{parameters}}}}}		{{#invoke:ShaderDoc\|shader_table\|{{{parameters}}}}}
	{{!}}}\|This shader does not use any parameters.}}		{{!}}}\|This shader does not use any parameters.}}
			{{#if:{{{gallery\|}}}\|
			== Gallery ==
			{{#tag:gallery\|{{{gallery}}}\|perrow=4\|widths=400px\|heights=300px\|mode=nolines\|}}\|}}
	== Technical ==		== Technical ==
	{{{technical\|}}}		{{{technical\|}}}
Line 121:		Line 123:
	"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
			},
			"gallery": {
			"label": "Gallery contents",
			"description": "Picture gallery contents",
			"type": "string",
	"required": false		"required": false
	},		},
Line 181:		Line 189:
	,;		,;

			\| 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.		\| technical = lorem ipsum.

Justin113D: Renamed vertex color parameter to vertex colors

2025-08-18T17:41:07Z

Renamed vertex color parameter to vertex colors

← Older revision		Revision as of 17:41, 18 August 2025
Line 17:		Line 17:
	\|}}		\|}}
	=== Vertex Colors ===		=== Vertex Colors ===
	{{{vertex ~~color~~\|Shader does not use vertex colors}}}		{{{vertex colors\|Shader does not use vertex colors}}}

	<div style="clear: both"/>		<div style="clear: both"/>
Line 105:		Line 105:
	"required": false		"required": false
	},		},
	"vertex ~~color~~": {		"vertex colors": {
	"label": "Vertex color",		"label": "Vertex color",
	"description": "Vertex color behavior",		"description": "Vertex color behavior",
Line 165:		Line 165:
	Lorem ipsum.		Lorem ipsum.

	\| vertex ~~color~~ =		\| vertex colors =
	* Color is multiplied into the <code>diffuse</code> texture color		* Color is multiplied into the <code>diffuse</code> texture color
	* Alpha is multiplied into the <code>diffuse</code> texture alpha		* Alpha is multiplied into the <code>diffuse</code> texture alpha

Justin113D: Added multi tangent

2025-08-18T17:40:38Z

Added multi tangent

← Older revision		Revision as of 17:40, 18 August 2025
Line 12:		Line 12:
	== Behavior ==		== Behavior ==
	{{{behavior\|}}}		{{{behavior\|}}}
			{{#if:{{{multi tangent\|}}}\|
			=== Multi-tangent ===
			{{{multi tangent}}}
			\|}}
	=== Vertex Colors ===		=== Vertex Colors ===
	{{{vertex color\|Shader does not use vertex colors}}}		{{{vertex color\|Shader does not use vertex colors}}}
Line 93:		Line 96:
	"label": "Behavior",		"label": "Behavior",
	"description": "Behavior content",		"description": "Behavior content",
			"type": "content",
			"required": false
			},
			"multi tangent": {
			"label": "Multi tangent",
			"description": "Multi tangent behavior",
	"type": "content",		"type": "content",
	"required": false		"required": false
Line 152:		Line 161:

	\| behavior = Lorem ipsum.		\| behavior = Lorem ipsum.

			\| multi tangent =
			Lorem ipsum.

	\| vertex color =		\| vertex color =

Justin113D: Fixed newline after template

2025-08-18T10:28:01Z

Fixed newline after template

← Older revision		Revision as of 10:28, 18 August 2025
Line 55:		Line 55:
	!Shader Features		!Shader Features
	{{#invoke:ShaderDoc\|technical_features\|{{{features}}}}}		{{#invoke:ShaderDoc\|technical_features\|{{{features}}}}}
	{{!}}}\|}}</includeonly>		{{!}}}\|}}<nowiki/></includeonly>

	<noinclude>		<noinclude>

	<templatedata>		<templatedata>
	{		{
Line 181:		Line 179:
	is_use_gi_prt,		is_use_gi_prt,
	is_use_gi_sg,		is_use_gi_sg,
	is_use_gi		is_use_gi
	}}		}}
			== Other ==
			Outside template
	</noinclude>		</noinclude>

Justin113D: Added clear for the sbo

2025-08-17T21:21:19Z

Added clear for the sbo

← Older revision		Revision as of 21:21, 17 August 2025
Line 15:		Line 15:
	=== Vertex Colors ===		=== Vertex Colors ===
	{{{vertex color\|Shader does not use vertex colors}}}		{{{vertex color\|Shader does not use vertex colors}}}

			<div style="clear: both"/>

	== Material Inputs ==		== Material Inputs ==

Justin113D: Added shader behavior overview parameters

2025-08-17T21:20:26Z

Added shader behavior overview parameters

← Older revision		Revision as of 21:20, 17 August 2025
Line 2:		Line 2:
	[[{{{game}}} Shaders\|Return to shaders list]]		[[{{{game}}} Shaders\|Return to shaders list]]
	== Overview ==		== Overview ==
	{{~~SXSG Shader Behavior~~		{{#invoke:ShaderDoc\|create_sbo\|game={{{game}}}\|parameters={{{sbo\|}}}}}
	\| ~~model~~ = 2
	}}
	{{{overview}}}		{{{overview}}}
	{{#if:{{{related shaders\|}}}\|		{{#if:{{{related shaders\|}}}\|
Line 54:		Line 52:
	{{!}}-		{{!}}-
	!Shader Features		!Shader Features
	{{#invoke:ShaderDoc\|technical_features		{{#invoke:ShaderDoc\|technical_features\|{{{features}}}}}
	\|~~features=~~{{{features}}}
	}}
	{{!}}}\|}}</includeonly>		{{!}}}\|}}</includeonly>

	<noinclude>		<noinclude>

	<templatedata>		<templatedata>
	{		{
	"params": {		"params": {
	"game": {		"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": {		"behavior": {
	"label": "Behavior",		"label": "Behavior",
	"description": "Behavior content",		"description": "Behavior content",
	"type": "content",		"type": "content",
	"required": false		"required": false
	},		},
	"vertex color": {		"vertex color": {
	"label": "Vertex color",		"label": "Vertex color",
	"description": "Vertex color behavior",		"description": "Vertex color behavior",
	"type": "content",		"type": "content",
	"required": false		"required": false
	},		},
	"textures": {		"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": {		"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": {		"technical": {
	"label": "Technical",		"label": "Technical",
	"description": "Technical information",		"description": "Technical information",
	"type": "content",		"type": "content",
	"required": false		"required": false
	},		},
	"features": {		"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>		</templatedata>

	~~WIP~~

	== Example ==		== Example ==
Line 134:		Line 136:

	\| shader name = Common_dpn		\| 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.		\| overview = A standard PBR shader with no special behavior.

Justin113D: Table contents added

2025-08-17T18:04:56Z

Table contents added

← Older revision		Revision as of 18:04, 17 August 2025
Line 21:		Line 21:

	=== Textures ===		=== 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}}		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 ===		=== 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 ==		== Technical ==
Line 161:		Line 161:
	,[[Hedgehog Engine 2 - Physically Based Rendering (PBR)#Metallic\|Metallic]] factor		,[[Hedgehog Engine 2 - Physically Based Rendering (PBR)#Metallic\|Metallic]] factor
	,;		,;


	\| technical = lorem ipsum.		\| technical = lorem ipsum.

Justin113D: Added technical features

2025-08-17T15:41:44Z

Added technical features

← Older revision		Revision as of 15:41, 17 August 2025
Line 49:		Line 49:

	== Technical ==		== Technical ==
			{{{technical\|}}}
	{\| class="mw-collapsible mw-collapsed wikitable" width="300px"		{{#if:{{{features\|}}}\|
	\|-		{{{!}} class="mw-collapsible mw-collapsed wikitable" width="300px"
			{{!}}-
	!Shader Features		!Shader Features
	\|}		{{#invoke:ShaderDoc\|technical_features
			\|features={{{features}}}
	</includeonly>		}}
			{{!}}}\|}}</includeonly>
	<noinclude>		<noinclude>
	<templatedata>		<templatedata>

← Older revision		Revision as of 18:04, 17 August 2025
Line 21:		Line 21:

	=== Textures ===		=== 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}}		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 ===		=== 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 ==		== Technical ==
Line 161:		Line 161:
	,[[Hedgehog Engine 2 - Physically Based Rendering (PBR)#Metallic\|Metallic]] factor		,[[Hedgehog Engine 2 - Physically Based Rendering (PBR)#Metallic\|Metallic]] factor
	,;		,;


	\| technical = lorem ipsum.		\| technical = lorem ipsum.