View source for $specmap texture

{{LanguageBar}}
{{cleanup|grammar}} {{This is a|shader parameter|name=$specmap_texture|game=Black Mesa}} 
[[File:NewSpecular=.jpg|thumb|right|New specular shader, example in <code>bs_c3m0d</code>. You can see how the floor reflects the red light source, the same for the floodlight.]] 
This shader is used for surfaces to give PBR style shiny speculars. Works with [[VertexLitGeneric]] and [[LightmappedGeneric]]. This shader work ''only'' with deferred rendering lighting entities which support and use <code>SpecularMultiplier</code> parametr (in the game code or as kayvalue), the entities is: [[NewLight_Point]], [[NewLight_Spot]], [[npc_zombie_hev]] (flashlight), [[prop_barrel_cactus]], [[prop_barrel_cactus_semilarge]], [[prop_barrel_interloper]], [[prop_barrel_interloper_small]], [[env_cascade_light]], [[bmortar]], [[npc_plantlight]], [[npc_plantlight_stalker]], [[player]] (flashlight).
{{ModernConfirm|Is this full list of entities ?}}
{{warning| This is pretty expensive shader for video cards, in large quantities may not cause optimization problems, but it will heat up your video card very much. Use wisely.}}
{{bug|Doesn't work with [[VertexLitGeneric]] if [[$phong]] is enabled.}}
{{back | Black Mesa Level Creation}}

== Parameters and Effects ==
{{MatParam|$specmap_texture|texture|Defines a [[specularmap]] texture that will use specular.
{{expand|title=An example.|
<br>
<gallery mode=packed heights=710px>
File:Bs_fy_basement_floor01_spec=.jpg|An example of [[specularmap]] from {{bmsbs|4}}.
</gallery>
}}
}}
{{MatParam|$specularcolor|RGB matrix|Controls the color and saturation of the specularity. If all three values are the same - the color obtained from deferred rendering light source will be used.
{{expand|title=Examples.|
<br>
<gallery mode=packed heights=410px>
File:1 1 1=.jpg|$specularcolor - 1 1 1.
File:1 0 0=.jpg|$specularcolor - 1 0 0.
File:1 0 1=.jpg|$specularcolor - 1 0 1.
</gallery>
}}
}}
{{MatParam|$specmap_mode|int|Defines style and behaviour for speculars, there are 3 available values - 0, 1 and 2.
{{expand|title=Examples.|
<br>
<gallery mode=packed heights=410px>
File:mode 0=.jpg|$specmap_mode - 0. Seems to ignore $specmap_texture.
File:mode 1=.jpg|$specmap_mode - 1. Seems to use $specmap_texture as glossiness map.
File:mode 2=.jpg|$specmap_mode - 2. Seems to use $specmap_texture as tint map.
</gallery>
}}
}}
{{MatParam|$speculargloss|float|Defines gloss scale. Works differently depending on <code>$specmap_mode</code> value.
{{expand|title=Examples of $specmap_mode - 0.|
<br>
<gallery mode=packed heights=610px>
File:mode 0 10=.jpg|$specmap_mode - 0. $speculargloss - 10
File:mode 0 100=.jpg|$specmap_mode - 0. $speculargloss - 100
File:mode 0 500=.jpg|$specmap_mode - 0. $speculargloss - 500
</gallery>
}}
{{expand|title=Examples of $specmap_mode - 1.|
<br>
<gallery mode=packed heights=610px>
File:mode 1 10=.jpg|$specmap_mode - 1. $speculargloss - 10
File:mode 1 100=.jpg|$specmap_mode - 1. $speculargloss - 100
File:mode 1 500=.jpg|$specmap_mode - 1. $speculargloss - 500
</gallery>
}}
{{expand|title=Examples of $specmap_mode - 2.|
<br>
<gallery mode=packed heights=610px>
File:mode 2 10=.jpg|$specmap_mode - 2. $speculargloss - 10
File:Mode_2=.jpg|$specmap_mode - 2. $speculargloss - 100
File:mode 2 500=.jpg|$specmap_mode - 2. $speculargloss - 500
</gallery>
}}
}}
{{MatParam|$normalmapalphaenvmapmask|bool|Use the alpha channel of the {{code|$bumpmap}} or {{code|$normalmap}} as a specular mask. {{code|$specmap_texture}} will be used as an additional mask or glossiness mask if {{code|$specmap_mode}} is set. This allows a blendable specular mask on {{code|LightmappedGeneric}}.
{{todo|Check to see if parameters such as {{code|$envmapmask}} or {{code|$basealphaenvmapmask}} and others affect newlight specular.}}
}}

==Bugs/Limitations==
====World geometry doesn't work with [[env_cascade_light]]====
Unlike models - speculars doesn't work with [[env_cascade_light]] for world geometry.
<gallery mode=nolines heights=256px widths=384px>
File: WGDWECL=.jpg|{{nbsp}}
</gallery>

====Fullbright glitch with <code>$specmap_mode</code>====
If values are used in $specmap_mode that were not thought out for use - surface will get fullbright and you'll get message in the console:
{{CodeBlock|<nowiki>*************************************************
Shader 'shaders\fxc\gbbrush_ps30.vcs' - Couldn't load combo 184025856 of shader (dyn=384)
static combos: BASETEXTURE2=0 BUMPMAP=1 BUMPMAP2=0 CUBEMAP=0 ENVMAPMASK=0 BASEALPHAENVMAPMASK=0 SELFILLUM=0 NORMALMAPALPHAENVMAPMASK=0 WARPLIGHTING=0 FANCY_BLENDING=0 SEAMLESS=0 DETAIL_BLEND_MODE=0 MOSS=0 NEW_SPECMAP=0 SHADER_SPECIAL_MODE=0 
*************************************************
*************************************************
Shader 'shaders\fxc\gbbrush_gbuffer_ps30.vcs' - Couldn't load combo 48 of shader (dyn=4)
static combos: ALPHACLIP=0 NEW_SPECMAP=0 
*************************************************
</nowiki>}}
<gallery mode=nolines heights=256px widths=384px>
File: HAHAHAHAHAHAHAHAAH=.jpg|{{nbsp}}
</gallery>

== See also ==
* [[$phong]] (for diffuse reflection)
* {{ent|newLight_Point}}
* {{ent|newLight_Spot}}
* {{ent|NewLights_settings}}
* {{ent|env_cascade_light}}
* {{ent|light_environment}}
* [[Advanced Lighting]]
* [[Effect flags]] (dynamic light effects)
* [https://chetanjags.wordpress.com/2023/07/18/blackmesa-xenengine-part-4-lighting-shadows/ BlackMesa XenEngine: Part 4 – Lighting & Shadows] (page from Black Mesa developer about new lights)
* [https://chetanjags.wordpress.com/2023/07/11/blackmesa-xenengine-part2-how-a-frame-is-rendered/ BlackMesa XenEngine: Part2 – How a Frame is Rendered] (page from Black Mesa developer about how a frame rendered, include Godrays.)
* [https://chetanjags.wordpress.com/2022/06/01/blackmesa-xenengine-part1-a-heavily-modified-source-engine/ BlackMesa XenEngine: Part1 – Heavily Modified Source Engine] (page from Black Mesa developer about Black Mesa engine, better known as [[XenEngine]])