View source for LUX

{{Language subpage}}
{{LUX|4}} is a [[Modification|mod]] specifically made and developed for use in {{src13sp|4}} and {{src13mp|4}}.<br>
The Project is to entirely rewrite all existing "'''SDK_'''" Shaders, that come with the SDK and all those available in {{mapbase|2}}.

== Goals ==
* '''Overhauled/Cleaned <code>materialsystem\stdshaders\</code> Folder'''
: {{ModernWarning|Pretty much everything except existing shader-compile functionality is pretty much "nuked".}}
: {{ModernNote|SDK_ Shaders will fall back to LUX_ Shaders, that way {{LUX|2}} can easily be used on {{mapbase|4}} mods without much work.}}
: {{Notice| Implementing {{LUX|2}} Shaders would entail replacing the existing <code>stdshaders\</code> with the one from {{LUX|2}}. Effectively 'nuking' SDK_ Shaders. {{LUX|2}} Shaders should be able to do everything SDK_ Shaders in {{src13}} and {{mapbase}} can do.}}
<br>
* '''Drastically decreased compile-times for all Shaders'''
: {{Why|Valves Shaders take '''forever''' to compile {{src13sp}}{{src13mp}}{{as}}. Especially using the stock Shader-Compiler. This disincentives modding the Shaders.}}
: {{Notice|Even on a good CPU it can take half a day, '''or more'''. As an example for {{LUX|2}}. Compiling the entirety of LUX_LightMappedGeneric takes around 30 seconds on 4 cores @4.1GHz }}
<br> 
* '''SM3.0 Shaders Only'''
: {{Why|ps20b and below is too limiting. The lack of available constant registers causes extreme branching and a lot of 'combos'. Making the code terrible to read and complicated. This disincentives Modders.}}
: {{Notice|Linux is not officially supported. MacOS is also not officially supported. Users of said system will have to either patch <code>togl</code> to work with SM3.0 or use DxVK. }}
: {{ModernNote|
:* SM3.0 released in 2004, and [https://cdn.cloudflare.steamstatic.com/apps/valve/2010/siggraph2010_vlachos_waterflow.pdf Valve considered ps2.0b low end hardware in ~2008]. See slide '''8'''
:* This means that older hardware not capable of SM3.0 will not be able to use the new Shaders.}}
<br> 
* '''Totally rewritten .h, .cpp, .fxc files'''
<br> 
* '''More Documentation for Shaders, their parameters, how they work and any possible caveats'''
: {{Notice|You might have noticed Articles like {{Ent|$lightwarptexture}}, {{Ent|$detail}}, {{Ent|UnlitTwoTexture}} and {{Ent|$envmapmask}} getting major updates from [[User:ShiroDkxtro2|ShiroDkxtro2]],
: where new information about Caveats and bugs were added for {{tf2}}{{as}}{{src13}}{{csgo}}. This was a direct result of {{LUX|2}} development, although the focus was mainly on {{src13}}{{as}} as their code is publicly available. }}
: {{ModernNote|The current lack of documentation, on how Shaders work in Source, disincentives Modders from learning how to mod Shaders or make their own. The barrier of entry is v. high as a lot of very specific knowledge is required too.}}
<br> 
* '''Implementing features that aren't available in {{src13}}'''
: {{Seealso|[[LUX#Planned Features|Planned Features]]. This includes old features such as [[Glowing_Textures#.24selfillum|$selfillumtexture]] and newer features like [[$phong#Colors|$phongalbedoboost]]{{csgo|only}}.}}
<br> 
* '''Fixing most Parameter "bugs:" and other caveats'''
: {{Seealso|[[LUX#Stock Shaders VS LUX|Stock Shaders VS LUX]]}}
<br>
* '''Easy way of disabling features'''
: {{Important|A custom Pre-Processor program has been made. It automatically sets <code>// STATIC:</code>'s to predefined values depending on <code>#define</code>'s in an included header file.}}
: {{ModernNote|Mods that don't require specific features (lightwarptexture/distancealpha/phong/envmaps/etc), can easily disable them. This will speed up Shader-compilation. Most parameters have been <code>#ifdef</code>'d in the c++ code!}}
<br> 
* '''Mapbase compatibility'''
: {{Notice|Replacing SDK_ Shaders in SDK mods, SDK2013CE or Mapbase mods should be as simple as replacing the <code>stdshaders\</code> Folder.}}
: {{ModernNote|It is assumed that no custom Shaders apart from SDK_ ones were added. If they do were added however, developers should be capable of adding them back, as that is the prerequisite for adding custom Shaders.}}
<br>
== Planned Features ==
This is a list of new features that are being implemented, or features that will be ported/recreated from newer branches such as {{as}}{{l4d2}}{{csgo}}
{{ModernNote|Ported in this case usually means {{as}}{{mapbase}}, however in most of these cases, the code for this will be heavily adapted to simplify or overhaul it.}}
{{Important|{{LUX|2}} does '''not''' use ''any'' leaked code. Features like [[$phong#Colors|$phongalbedoboost]]{{only|csgo}} are not rocket-science. They can safely be recreated without the use of leaked code.}}
: {{ModernWarning|For features that are more complicated, there might be visual disparity when compared to official implementations.}}
<br>
==== Features required for {{mapbase|2}} compatibility ====
* [[$phong#Brightness|$phongdisablehalflambert]] from {{as}}+
* Radial Fog for all "Geometry" Shaders
* Spline-Ropes
* Parallax Corrected Cubemaps ( PCC )
: {{ModernNote|Just like {{mapbase|2}}, this requires custom compilers to work.}}
: {{Important|The parameters are the same for {{LUX|2}} and {{mapbase}}. This means that Mapbase compilers can be used for this to work.}}
* {{Ent|$envmapmask}} + {{Ent|$bumpmap}} on {{Ent|VertexLitGeneric}}
* Replacement for the "Postprocessing" Controller Shader
* Replacement for the "Engine_post" Shader from {{as}}
* Hammer {{Ent|$blendmodulatetexture}} previewing fix.
* Brush {{Ent|$phong}}
* Treesway
: {{ModernTodo|Is the {{mapbase}} implementation ported from {{as}}?}}
<br>
==== New Features ====
* In {{src13mp}} Models utilizing Model Lightmapping can use {{Ent|$bumpmap}}. Additionally all Model shaders will be able to utilize this feature. Except they have {{Ent|$phong}}.
: {{Important|The Lightmap does not do bumped-lighting using the bumpmap. Only named-lights/projected textures will be able to do so.}}
: {{ModernNote| Lightmapped models will not be able to receive {{Ent|$phong}}. This is not planned at the moment but should be possible for named-lights/projected textures!}} 
* In {{src13mp}} Models can utilize Lightmap UV's.
: {{ModernWarning|The way this is currently implemented requires a custom written tool, two smd's ( one with lightmap uv ) and also has a lot of precision loss for the Lightmap UV's. Additionally this requires a custom compiler! }}
::{{ModernTodo|Investigate {{src07}} code, supposedly the Studiomdl code is there. Maybe it can be packed via Blendweights or alternatively the precision loss might be decreased.}}
<br>
==== Features ported/recreated/revived ====
* [[$phong#Brightness|$phongdisablehalflambert]] From {{as}}+ - Also needed for {{mapbase}}
* [[$phong#Masking|$phongexponentfactor]] From {{src13mp}}{{tf2}}, with {{LUX|2}} also on {{src13sp}}
* [[$phong#Colors|$phongalbedoboost]] From {{csgo}} - Its just <code>BaseTexture * $PhongAlbedoBoost</code>... No leaked code!
* [[$phong#Masking|$basemapluminancephongmask]] From {{as}}+
: {{ModernNote|
:* {{LUX|2}} allows the use of Rec. 709 HDTV Luminance Weights. <code>float3(0.2126f, 0.7152f, 0.0722f)</code>.
:* Previously SDK_ Shaders would use the NTSC Analog Television standard of <code>float3(0.2990f, 0.5870f, 0.1140f)</code>}}
* [[Glowing_Textures#.24selfillum|$selfillumtexture]] Deprecated since {{src07}} - This used to be obsolete
: {{ModernNote| Yes, there is a use for this! [[$detail#Parameters and Effects|$detailblendmode]] 5 is commonly used for glowing textures. This parameter allows for not wasting your $detail. Additionally no $emissiveblend is required.}}
: {{seealso|PBR Shaders in the community commonly have a $emissiontexture parameter that does EXACTLY what [[Glowing_Textures#.24selfillum|$selfillumtexture]] does in {{LUX|2}}.}}
* Water Shader with {{Ent|$flowmap}} Support - From {{as}}
* {{Ent|$envmaplightscale}} From {{as}} for brushes{{as}}+ AND models {{only|{{csgo}}}}+
: {{Important|
:* On brushes this will use the Lightmap
:* On models '''with''' {{Ent|$bumpmap}}, this will use bumped lighting.
:* On models without {{Ent|$bumpmap}}, this will use Vertex Lighting.
:* In {{src13mp}} Models utilizing Model Lightmapping, will use the Lightmap. Regardless of whether or not {{Ent|$bumpmap}} is used.}}
<br>
==== Features that are being discarded ====
* {{Ent|$envmapsphere}} and related - These features have been removed since {{as}} and are obsolete.
:{{ModernNote|This is very easy to re-implement. The 7th face of a Cubemap is still being built in {{src13}} and therefore this feature is still operational given that the code has been implemented!}}
* [[$bumpmap#Additional_Parameters|$bumpmask]] and related
<br>
==== Features that '''won't''' be ported/recreated/revived ====
* $basealphaenvmapmaskminmaxexp from {{as}} - This parameter is not yet documented on the VDC, it is also unclear what exactly it does...
* $EnvMapLightScaleMinMax from {{csgo}}
<br>
==== Not functional - FOR NOW ====
* {{Ent|$emissiveblend}} - Non-Existant. Planned for later.
* {{Ent|$distancealpha}} - Non-Functional. Planned for later.
* {{Ent|$ssbump}} - Non-Functional. Planned for later.
* [[$detail#Parameters and Effects|$detailblendmode]] <code>10 & 11</code>.  - Non-Functional. Planned for later.
<br>

= Stock Shaders VS LUX =
{{Todo|Move This to their own pages or something like that.}}
<br>
== LightMappedGeneric ==
{| cellspacing="0"
|- valign="top"
| style="width:50%; padding-right:2em" |
=== Stock Shaders ===
{{ModernBug|
[[$detail#Parameters and Effects|$detailblendmode]]{{src13}}{{tf2}} 2-9 Don't work.<br>
[[$detail#Parameters and Effects|$detailblendmode]]{{as}} 6 Doesn't work.<br>
[[$detail#Parameters and Effects|$detailblendmode]]{{csgo}} 1-6, 8 Don't work. 9 Does not work with {{Ent|$bumpmap}}, {{Ent|$envmap}} or {{Ent|$selfillum}}<br>
{{Ent|$bumpmap}} + {{Ent|$envmapmask}} Doesn't work, except in {{csgo|4}}<br>
{{Ent|$lightwarptexture}} + {{Ent|$detail}}{{tf2}}{{as}} Doesn't work.<br>
{{Ent|$basealphaenvmapmask}} + {{Ent|bumpmap}} Doesn't work}}

{{ModernNote|
[[Glowing_Textures#.24selfillum|$selfillummask]] Missing<br>
{{Ent|$selfillum_envmapmask_alpha}} Missing<br>
[[Glowing_Textures#.24selfillum|$selfillumfresnel]] Missing<br>
{{Ent|$blendtintbybasealpha}} Missing<br>
[[$detail#Parameters and Effects|$detailtexturetransform]] Missing<br>
{{Ent|$lightwarptexture}}{{csgo}} Missing<br>
{{Ent|$envmapfresnelminmaxexp}}{{only|{{l4d}}+}}<br>
{{Ent|$envmaplightscale}}{{only|{{as}}+}}}}

{{Notice|{{Ent|$basealphaenvmapmask}} requires inverted masks}}

| style="width:50%"|

=== {{LUX}}LUX_LightMappedGeneric ===
{{ModernNote|
[[$detail#Parameters and Effects|$detailblendmode]] 1-9 works.<br>
[[$detail#Parameters and Effects|$detailblendmode]] 10-11 planned.<br>
{{Ent|$bumpmap}} + {{Ent|$envmapmask}} works, used to be {{only|{{csgo}}.}}<br>
{{Ent|$lightwarptexture}} + {{Ent|$detail}} works ( does not work in {{as}}{{tf2}} ).<br>
{{Ent|$basealphaenvmapmask}} + {{Ent|$bumpmap}} works.<br>
[[Glowing_Textures#.24selfillum|$selfillummask]] Exists now.<br>
{{Ent|$blendtintbybasealpha}} Exists now.<br>
{{Ent|$selfillum_envmapmask_alpha}} Exists now.<br>
{{Ent|$envmaplightscale}} Exists now.<br>
[[$detail#Parameters and Effects|$detailtexturetransform]] Exists now.}}

{{Notice|Caveat - Has higher priority than [[Glowing_Textures#.24selfillum|$selfillum]]/[[Glowing_Textures#.24selfillum|$selfillummask]].}}
:{{Notice|Caveat - [[Glowing_Textures#.24selfillum|$selfillumtexture]] has higher priority than both.}}

{{Important|{{Ent|$basealphaenvmapmask}} does no longer require a flipped mask.}}
:{{ModernWorkaround|Materials that previously used have to be adjusted. Use {{Ent|$envmapmask}} or {{Ent|$normalmapalphaenvmapmask}} instead!}}
|}

== VertexLitGeneric ==
{| cellspacing="0"
|- valign="top"
| style="width:50%; padding-right:2em" |
=== Stock Shaders ===
==== Always ====
{{Ent|$envmaplightscale}}{{only|{{csgo}}}}.

==== Without $Bumpmap ====
{{ModernBug|[[$detail#Parameters and Effects|$detailblendmode]]{{src13}}{{tf2}}{{as}}{{csgo}} 10-11 Don't work.<br>
[[Glowing_Textures#.24selfillum|$selfillumfresnel]] missing.<br>
{{Ent|$lightwarptexture}} missing.}}
{{ModernNote|$lightwarptexture fores bumpmapping by binding a default one, unless one is manually specified.}}


==== '''With''' $Bumpmap ====
{{ModernBug|
[[$detail#Parameters and Effects|$detailblendmode]]{{src13}}{{tf2}}{{as}}{{csgo}} 5-11 Don't work.<br>
[[$detail#Parameters and Effects|$detailblendmode]]{{csgo}} 5-6 & 8-11 Don't work.}}
{{ModernNote|
{{Ent|$envmapmask}} missing. Except {{mapbase}}.<br>
[[Glowing_Textures#.24selfillum|$selfillummask]] missing. {{ModernConfirm|Only in {{mapbase}}?}}
{{Ent|$selfillum_envmapmask_alpha}}{{mapbase}} missing.<br>
[[Glowing_Textures#.24selfillum|$selfillumfresnel]] disables {{Ent|$normalmapalphaenvmapmask}}. {{ModernTodo|Also on other branches than {{as}}?}}}}


==== With $Phong ====
{{ModernBug|[[$detail#Parameters and Effects|$detailblendmode]]{{src13}}{{tf2}}{{as}}{{csgo}} 8-11 Don't work.
[[$phong#Masking|$invertphongmask]]{{as}}{{src13}} In the shadercode, only flips the mask used for {{Ent|$envmap}}. {{ModernConfirm|Also on newer branches?}}
[[$phong#Colors|$phongalbedotint]] cannot be used without [[$phong#Masking|$phongexponenttexture]].<br>
{{Ent|$phongwarptexture}}{{l4d2}} does not work.<br>
[[$phong#Colors|$phongalbedoboost]]{{only|{{csgo}}}} + {{Ent|$detail}} does not work.<br>
[[$phong#Colors|$phongtint]] disables [[$phong#Colors|$phongalbedotint]].<br>
{{Ent|$envmap}} always masked by something.<br>
{{Only in {{l4d}}+ {{Ent|$envmap}} masked by {{Ent|$basetexture}} luminance when {{Ent|$normalmapalphaenvmapmask}} and [[$phong#Masking|$basemapluminancephongmask]] is used.<br>
{{Ent|$envmap}} masked by {{Ent|$basetexture}} alpha when {{Ent|$normalmapalphaenvmapmask}} and [[$phong#Masking|$basemapalphaphongmask]] is used.<br>
[[$phong#Masking|$basemapalphaphongmask]] makes {{Ent|$phong}} ignore the {{Ent|$bumpmap}}.<br>
[[Glowing_Textures#.24selfillum|$selfillumfresnel]] + {{Ent|$normalmapalphaenvmapmask}} will cause the {{Ent|$envmap}} to be multiplied by <code>0.0f</code> regardless of whether [[$phong#Masking|$invertphongmask]] is used.<br>
[[Glowing_Textures#.24selfillum|$selfillumfresnel]] will cause {{Ent|$envmap}} to be masked using the {{Ent|$basetexture}} alpha channel.}}}}

{{ModernNote|[[$phong#Brightness|$phongdisablehalflambert]] only in {{as}}+<br>
[[$phong#Masking|$phongexponentfactor]] only in {{tf2}}{{src13mp}}<br>
[[$phong#Masking|$basemapluminancephongmask]] only in {{l4d}}+<br>
[[$phong#Colors|$phongalbedoboost]] only in {{csgo}}+}}

| width="50%" |

=== {{LUX}}LUX_VertexLitGeneric ===
==== Without $Bumpmap ====
* [[$detail#Parameters and Effects|$detailblendmode]] 10-11 planned. If possible.<br>
* [[Glowing_Textures#.24selfillum|$selfillumfresnel]] Exists now.<br>
* {{Ent|$lightwarptexture}} Exists now.<br>
::{{ModernTodo|Make a parameter that allows its usage. Right now default behavior is replicated and a default bumpmap is bound.}}


==== '''With''' $Bumpmap ====
* [[$detail#Parameters and Effects|$detailblendmode]] 5-9 work.<br>
* [[$detail#Parameters and Effects|$detailblendmode]] 10-11 planned. If possible.<br>
* {{Ent|$envmapmask}} Exists now.<br>
* [[Glowing_Textures#.24selfillum|$selfillummask]] Exists now.<br>
* {{Ent|$selfillum_envmapmask_alpha}} Exists now.<br>
* [[Glowing_Textures#.24selfillum|$selfillumfresnel]] + {{Ent|$normalmapalphaenvmapmask}} Works now.<br>


==== With $Phong ====
* [[$detail#Parameters and Effects|$detailblendmode]] 8-9 work now.<br>
* [[$detail#Parameters and Effects|$detailblendmode]] 10-11 planned. If possible.<br>

{{ModernNote|[[$phong#Masking|$invertphongmask]] Now only flips the mask used for phong. It will no longer touch the envmapmask ''at all''.<br>
[[$phong#Colors|$phongalbedotint]] can now be used without [[$phong#Masking|$phongexponenttexture]].}}
:{{Notice|Will use entirety of {{Ent|$basetexture}}, without being masked.}}

* [[$phong#Colors|$phongwarptexture]] works. ( does not work in {{l4d2}} ).<br>
* [[$phong#Colors|$phongalbedoboost]] Exists now. Used to be {{only|{{csgo}}.}}
* [[$phong#Colors|$phongalbedoboost]] + {{Ent|$detail}} Works. Does not work in {{csgo|4}}.<br>

{{ModernNote|[[$phong#Colors|$phongtint]] does no longer disable [[$phong#Colors|$phongalbedotint]]. It will do <code>($baseTexture * Mask) * $PhongTint</code>}}
:{{Notice|When no [[$phong#Masking|$phongexponenttexture]] is specified, Mask will be 1.0f!}}

* {{Ent|$envmap}} Can now be not-masked by using a new parameter (<code>$phongenvmapnomask</code>)
: {{Important|By default the original masking for the $envmap will be replicated as to not have disparity. However it can now be overriden using two new parameters. <code>$phongforcebasealphaenvmapmask</code> and <code>$phongforcenormalmapalphaenvmapmask</code>}}

* [[$phong#Masking|$basemapalphaphongmask]] '''no longer''' makes {{Ent|$phong}} ignore the {{Ent|$bumpmap}}.
:{{Notice|This will make materials that previously used this intentionally, look different.}}
* [[Glowing_Textures#.24selfillum|$selfillumfresnel]] + {{Ent|$normalmapalphaenvmapmask}} will no longer multiply the {{Ent|$envmap}} by <code>0.0f</code>
* [[$phong#Brightness|$phongdisablehalflambert]] Exists now. ( Used to be {{only|{{as}}+}}
* [[$phong#Masking|$phongexponentfactor]] Exists now for {{src13sp}}. ( Used to be {{only|{{tf2}}{{src13mp}}}}
* [[$phong#Masking|$basemapluminancephongmask]] Exists now. ( Used to be {{only|{{l4d}}+}}
* [[$phong#Colors|$phongalbedoboost]] Exists now. ( Used to be {{only|{{csgo}}+}}
|}

== History ==
{{LUX|2}} started developement on the 20.01.2023 DMY, but it was planned and thought ~14.01.2023 when the lead-developer [[User:ShiroDkxtro2|ShiroDkxtro2]] was in a hospital stay.<br>
Even before 2023, the idea of rewritting Valve's Shaders was in mind. Various people asked [[User:ShiroDkxtro2|ShiroDkxtro2]] if certain modifications could be implemented for default shaders, such as CSM.<br>
These requests would usually result in a simple "no.", modifying the default shaders was not considered feasible for various reasons, most of which are indirectly mentioned in [[LUX#Goals|LUX's Goals]].<br>
The Inception was supposed to be a means to make the existing Shaders more modable, with new features in mind and laid out so that implementing new things would be easier.<br>

== Credits ==
* {{LUX|2}} uses [https://github.com/SCell555/ShaderCompile SCell555's ShaderCompiler]<br>
However, it is only used to compile the Shaders. Include files ( .inc ) are intended to be made using [https://strawberryperl.com/ Perl].

* {{LUX|2}} copies various code from [https://github.com/thexa4/source-pbr thexa4's PBR header]<br>

* Tottery ( Also known as TotteryNine )
TotteryNine was crucial to [[User:ShiroDkxtro2|ShiroDkxtro2]] for learning the basics and more complicated aspects of making and compiling Shaders.

* Sitkinator
Aiding with the initial logo and adding a screen-reflection effect to it.

* Mr.Kleiner
For writing various tools. Including a VTF Flagging tool for Cubemaps inside a .bsp file, a tool for packing lightmap uv's into .smd files

* roman_memes
Various logical checks and ideas. Also helped with prototyping new features and finding siggraph or other papers regarding modern and oldschool graphical implementations.

* Alivebyte!
For doing modifications to the ShaderCompiler, which so far have not been implemented into the repo.

* [[User:Ficool2|Ficool2]]
For enlightening us about the Constant Register Hack.<br>
Which allows for the use of more than 32 float constant registers on sm3.0<br>
This Project would be near impossible without it.

* ChatGPT
Help with programming and undocumented graphical features of the Source Engine.
It knows things and can make new things to a degree. Various code used in {{LUX|2}} has been partically written by the AI.

* {{mapbase|2}}
Since one of the goals of this project is to be compatible with it, various code from it has been adapted.
This means that all Shader-related things should also be inhereted with the credits of {{LUX|2}}. You can find Mapbase's credits [https://github.com/mapbase-source/source-sdk-2013/wiki/Mapbase-Credits HERE].

* [https://github.com/Joshua-Ashton/Source-PlusPlus/ Source++] code might be included with {{LUX|2}}.
One example would be the NvidiaPCF5x5Gaussian Shadow Filter
{{ModernNote|What else from S++ is used in {{LUX|2}}?}}
[[User:ShiroDkxtro2|ShiroDkxtro2]] would also like to thank Joshua Ashton personally for his various open-source work related to the source engine.

== See also ==
* {{LUX|2}} [https://discord.gg/cGv8GGSkpc Discord] Server
:Development can be followed here, Bug-Reports & suggestions made.
:It is also intended as a general place for discussing {{src13|2}} related Shader-Modding.

* {{LUX|2}} [https://github.com/ShiroDkxtro2/ACROHS-LUX_-Shaders-Project GitHub] page

{{Todo|Make a new category for LUX_ Shaders and document them and their parameters there, instead of here. Preferably after they were released on the GitHub.}}