Skip to content

Fix punctuation in pbrshader documentation #185

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
OrsellGit merged 1 commit into from
Apr 25, 2026
+27 −27
Merged

Fix punctuation in pbrshader documentation #185

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 27 additions & 27 deletions docs/material/pbr/pbrshader.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ This page contains information about the parameters of the PBR shader.

 Default: `shadertest/lightmappedtexture`

 Description: Blended texture for use with displacements
 Description: Blended texture for use with displacements.

----
### Appearance
Expand All @@ -32,57 +32,57 @@ This page contains information about the parameters of the PBR shader.

 Default: `[1 1 1]`

 Description: Adjusts the color of $basetexture
 Description: Adjusts the color of $basetexture.

#### `$color2` \<color\>

&ensp;Default: `[1 1 1]`

&ensp;Description: Adjusts the color of $basetexture2
&ensp;Description: Adjusts the color of $basetexture2.

#### `$frame` \<int\>

&ensp;Default: `0`

&ensp;Description: Sets what static frame to use if $basetexture is animated
&ensp;Description: Sets what static frame to use if $basetexture is animated.

#### `$frame2` \<int\>

&ensp;Default: `0`

&ensp;Description: Sets what static frame to use if $basetexture2 is animated
&ensp;Description: Sets what static frame to use if $basetexture2 is animated.

#### `$srgbtint` \<color\>

&ensp;Default: `[1 1 1]`

&ensp;Description: Tint value to be applied when running on new-style srgb parts
&ensp;Description: Tint value to be applied when running on new-style srgb parts.

#### `$hsv` \<color\>

&ensp;Default: `[1 1 1]`

&ensp;Description: HSV color to transform $basetexture texture with
&ensp;Description: HSV color to transform $basetexture texture with.

#### `$hsv_blend` \<bool\>

&ensp;Default: `0`

&ensp;Description: Blend untransformed color and HSV transformed color
&ensp;Description: Blend untransformed color and HSV transformed color.

----
### Flashlight
#### `$flashlighttexture` \<texture\>

&ensp;Default: `effects/flashlight001`

&ensp;Description: Flashlight spotlight shape texture
&ensp;Description: Flashlight spotlight shape texture.

#### `$flashlighttextureframe` \<int\>

&ensp;Default: `0`

&ensp;Description: Sets what static frame to use if $flashlighttexture is animated
&ensp;Description: Sets what static frame to use if $flashlighttexture is animated.

----
### Physically Based Rendering
Expand All @@ -96,7 +96,7 @@ This page contains information about the parameters of the PBR shader.

&ensp;Default: ``

&ensp;Description: Texture with metalness in R, roughness in G, ambient occlusion in B for $basetexture
&ensp;Description: Texture with metalness in R, roughness in G, ambient occlusion in B for $basetexture.

#### `$mraoframe` \<int\>

Expand All @@ -108,7 +108,7 @@ This page contains information about the parameters of the PBR shader.

&ensp;Default: ``

&ensp;Description: Texture with metalness in R, roughness in G, ambient occlusion in B for $basetexture2
&ensp;Description: Texture with metalness in R, roughness in G, ambient occlusion in B for $basetexture2.

#### `$mraoframe2` \<int\>

Expand All @@ -120,13 +120,13 @@ This page contains information about the parameters of the PBR shader.

&ensp;Default: `[1 1 1]`

&ensp;Description: Factors for metalness, roughness, and ambient occlusion for $mraotexture
&ensp;Description: Factors for metalness, roughness, and ambient occlusion for $mraotexture.

#### `$mraoscale2` \<color\>

&ensp;Default: `[1 1 1]`

&ensp;Description: Factors for metalness, roughness, and ambient occlusion for $mraotexture2
&ensp;Description: Factors for metalness, roughness, and ambient occlusion for $mraotexture2.

#### `$parallax` \<bool\>

Expand All @@ -150,15 +150,15 @@ This page contains information about the parameters of the PBR shader.

&ensp;Default: `0`

&ensp;Description: Blend tint by the alpha channel in MRAO texture. Similar to $blendtintbybasealpha for [VLG](https://developer.valvesoftware.com/wiki/VertexLitGeneric)
&ensp;Description: Blend tint by the alpha channel in MRAO texture. Similar to $blendtintbybasealpha for [VLG](https://developer.valvesoftware.com/wiki/VertexLitGeneric).

----
### Alpha
#### `$alpha` \<float\>

&ensp;Default: `1.0`

&ensp;Description: Scales the transparency of the whole image
&ensp;Description: Scales the transparency of the whole image.

#### `$alphatestreference` \<float\>

Expand All @@ -172,7 +172,7 @@ This page contains information about the parameters of the PBR shader.

&ensp;Default: ``

&ensp;Description: Emission texture
&ensp;Description: Emission texture.

#### `$emissionframe` \<int\>

Expand All @@ -184,7 +184,7 @@ This page contains information about the parameters of the PBR shader.

&ensp;Default: ``

&ensp;Description: Emission texture for $basetexture2
&ensp;Description: Emission texture for $basetexture2.

#### `$emissionframe2` \<int\>

Expand All @@ -196,13 +196,13 @@ This page contains information about the parameters of the PBR shader.

&ensp;Default: `[1 1 1]`

&ensp;Description: Color to multiply $emissiontexture with
&ensp;Description: Color to multiply $emissiontexture with.

#### `$emissionscale2` \<color\>

&ensp;Default: `[1 1 1]`

&ensp;Description: Color to multiply $emissiontexture2 with
&ensp;Description: Color to multiply $emissiontexture2 with.

----
### Reflection
Expand All @@ -224,13 +224,13 @@ This page contains information about the parameters of the PBR shader.

&ensp;Default: ``

&ensp;Description: Normalmap texture (deprecated, use $bumpmap)
&ensp;Description: Normalmap texture (deprecated, use $bumpmap).

#### `$bumpmap` \<texture\>

&ensp;Default: ``

&ensp;Description: Bumpmap texture for $basetexture
&ensp;Description: Bumpmap texture for $basetexture.

#### `$bumpframe` \<int\>

Expand All @@ -242,7 +242,7 @@ This page contains information about the parameters of the PBR shader.

&ensp;Default: ``

&ensp;Description: Bumpmap texture for $bsaetexture2
&ensp;Description: Bumpmap texture for $basetexture2.

#### `$bumpframe2` \<int\>

Expand All @@ -256,22 +256,22 @@ This page contains information about the parameters of the PBR shader.

&ensp;Default: `paint/splatnormal_default`

&ensp;Description: The paint splat normal map to use when paint is enabled on the surface
&ensp;Description: The paint splat normal map to use when paint is enabled on the surface.

#### `$paintsplatbubblelayout` \<texture\>

&ensp;Default: `paint/bubblelayout`

&ensp;Description: The layout texture which defines the distribution of bubbles in the paint
&ensp;Description: The layout texture which defines the distribution of bubbles in the paint.

#### `$paintsplatbubble` \<texture\>

&ensp;Default: `paint/bubble`

&ensp;Description: The normal mapped texture of a single bubble
&ensp;Description: The normal mapped texture of a single bubble.

#### `$paintenvmap` \<texture\>

&ensp;Default: `paint/paint_envmap_hdr`

&ensp;Description: Envmap that is consistent across all surfaces
&ensp;Description: Envmap that is consistent across all surfaces.