View source for Zh/LUX

{{LanguageBar}}
{{Infotable
| state = 5
| ownwiki = https://github.com/ShiroDkxtro2/ACROHS-LUX_-Shaders-Project/wiki
| type = m0
| dev = [[User:ShiroDkxtro2|ShiroDkxtro2]]
| engine = 2
| base = {{src13|4}}
| platform = {{only|{{PC|4}}}}
| github = ShiroDkxtro2/ACROHS-LUX_-Shaders-Project
| discord = https://discord.gg/cGv8GGSkpc
}}

{{LUX|4}}是一个专门为{{src13sp|4}}和{{src13mp|4}}制作和开发的模组，其目的皆在为完全重写所有原版和{{Mapbase|4}}的着色器

==目标==
* '''大修\清理<code>materialsystem\stdshaders\</code>目录'''
: {{Warning|除了现有的着色器编译功能外，几乎所有的东西都被“扬了”。}}
: {{Notice|实现{{LUX|2}}的着色器需要将<code>stdshaders/</code>替换为{{LUX|2}}自己的，这“有效”的扬了所有原版着色器的修改版，LUX应该能够实现所有{{src13}}和{{Mapbase}}着色器原有的功能}}
::{{Note|SDK着色器会自动回退到对应的{{LUX|2}}版本，这样使用{{Mapbase|4}}的模组无需太多改动就可以使用LUX}}
* '''大幅减少所有着色器的编译时间'''
: {{Why|在{{src13sp}}{{src13mp}}{{as}}，V社的着色器需要'''非常长'''的时间进行编译。尤其是在使用原版编译器的情况下。这限制了着色器的修改}}
: {{Notice|即便使用高端CPU也至少需要半天'''或更久'''的时间进行编译。以{{LUX|2}}为例，在4核@4.1Hz环境下编译整个LUX_Lightmappedgeneric仅需要大约30秒}}
* '''着色器仅使用SM 3.0'''
: {{Why|ps20b及以下有太多限制。缺少可用的常量寄存器会导致极端分支和大量“组合”。使代码变成一坨难以阅读和理解的屎山。这会抑制模组制作者的积极性。}}
: {{Note|SM3.0于2004年发布，[https://cdn.cloudflare.steamstatic.com/apps/valve/2010/siggraph2010_vlachos_waterflow.pdf V社在2008年考虑到了ps2.0及以下的低端硬件]。详见幻灯片第8页}}
: {{Note|这意味着不支持SM3.0的低端硬件将无法使用新的着色器}}
: {{Notice|Linux和MacOS暂无官方支持。以上系统用户需要使用<code>togl</code>进行补丁才能使用SM3.0，或使用DXVK}}
* '''完全重写.h, .cpp, .fxc文件'''
* '''更多有关着色器、自身参数、如何工作以及任何可能的注意事项的文档'''
: {{Notice|你可能已经注意到了如{{Ent|$lightwarptexture}}、{{Ent|$detail}}、{{Ent|UnlitTwoTexture}}、{{Ent|$envmapmask}}得到了由[[User:ShiroDkxtro2|ShiroDkxtro2]]贡献的重大更新
: 他为{{tf2}}{{as}}{{src13}}{{csgo}}添加了新的注意事项和bug记录。这些文档是{{LUX|2}}开发的直接结果，尽管开发的重点集中在{{src13}}{{as}}上，因为他们是开源项目}}
: {{Note|目前缺少有关着色器如何在起源中工作的文档，这导致起源的图形学领域门槛很高，需要有大量的相关经验，阻碍了模组制作者们修改着色器和创作自己的}}
* '''实现{{src13}}没有的内容'''
: {{Seealso| <code>计划实现的功能</code>. 这个目标包含了例如[[Glowing_Textures#.24selfillum|$selfillumtexture]]的旧功能和例如[[$phong#Colors|$phongalbedoboost]]{{only|csgo}}的新功能}}
* '''修复大多数参数的Bug和警告'''
: {{Seealso| <code>原版着色器与LUX着色器对比</code>}}
* '''禁用特定功能的简单方法''' <!--原文为It automatically sets <code>// STATIC:</code>'s to predefined values depending on <code>#define</code>'s in an included header file，出于通俗目的进行修改-->
: {{Note|已制作一个自定义的预处理程序，可以通过禁用不需要的功能来使着色器编译的更快}}
* '''对Mapbase的兼容性'''
: {{Notice|要替换其他mod（如Source 2013社区版，以Mapbase为本体的mod）修改的原版着色器，应该和直接替换<code>stdshaders\</code>目录一样简单}}
: {{Note| 以上假定除修改的原版着色器外无其他的自定义着色器，但如果确实有，开发者应该能将它们添加回来，因为这是添加自定义着色器的先决条件}}

==计划实现的功能==
这是正在实施的新功能列表，或者将从较新的引擎分支移植/复刻的功能，例如{{as}}{{l4d2}}{{csgo}}
{{Note|该语境下的被移植“对象”通常指{{as|4}}{{Mapbase|4}}，但在多数情况下，其代码会出于简化或大修的目的而进行大量修改}}
{{Important|{{LUX|2}}'''不使用'''''任何''的泄露代码。像[[$phong#Colors|$phongalbedoboost]]{{only|csgo}}这样的功能不是什么难以实现的东西，它们可以在不使用泄露代码的情况下安全的复现}}
: {{Warning|对于更复杂的功能，与V社的实现方法相比可能存在视觉差异。}}

====出于{{Mapbase|4}}兼容性而需实现的功能====
* 来自{{as}}的[[$phong#Brightness|$phongdisablehalflambert]]+
* 所有“几何”用着色器的径向雾
* Spline-Ropes
* {{L|Parallax Corrected Cubemaps|视差修正反射贴图}}
: {{Note|就像{{Mapbase|4}}一样，视差反射需要自定义的地图编译器}}
: {{Important|{{LUX}}和{{Mapbase}}参数是一样的，所以Mapbase的地图编译器也可以使用}}
* {{Ent|VertexLitGeneric}}上同时使用{{Ent|$envmapmask|反射遮罩}}和{{Ent|$bumpmap|法线贴图}}的支持
* 控制器着色器"Postprocessing"的替代品
* 来自{{as}}的着色器"Engine_post"替代品
* {{Ent|$blendmodulatetexture}}的Hammer内预览修复
* 固体用{{Ent|$phong|alt=漫反射}}
* {{L|$treesway|树叶飘动}}
: {{Todo|这真的是移植自{{as}}的{{Mapbase}}功能吗}}

==== 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.}}
: {{Note| 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.
: {{Warning|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! }}
:: {{Todo|Investigate {{src07}} code, supposedly the Studiomdl code is there. Maybe it can be packed via Blendweights or alternatively the precision loss might be decreased.}}

==== Features ported/recreated/revived ====
* [[$phong#Brightness|$phongdisablehalflambert]] From {{as}}+ - Also needed for {{Mapbase}}
* [[$phong#Masking|$phongexponentfactor]] From {{src13mp}}{{tf2}}, with LUX also on {{src13sp}}
* [[$phong#Colors|$phongalbedoboost]] From {{csgo}} - Its just <code>BaseTexture * $PhongAlbedoBoost</code>... No leaked code!
* [[$phong#Masking|$basemapluminancephongmask]] From {{as}}+
: {{Note|LUX allows the use of Rec. 709 HDTV Luminance Weights. <code>float3(0.2126f, 0.7152f, 0.0722f)</code>.<br>
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
: {{Note| 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.}}
* 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.

==== Features that are being discarded ====
* {{Ent|$envmapsphere}} and related - These features have been removed since {{as}} and are obsolete.
: {{Note|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

==== 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}}

==== 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.}}

== LightMappedGeneric ==
=== Stock Shader's ===
{{Bug|[[$detail#Parameters and Effects|$detailblendmode]]{{src13}}{{tf2}} 2-9 Don't work.}}
{{Bug|[[$detail#Parameters and Effects|$detailblendmode]]{{as}} 6 Doesn't work.}}
{{Bug|[[$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>
{{Bug|{{Ent|$bumpmap}} + {{Ent|$envmapmask}} Doesn't work, except in {{csgo|4}}}}
{{Bug|{{Ent|$lightwarptexture}} + {{Ent|$detail}}{{tf2}}{{as}} Doesn't work}}
{{Bug|{{Ent|$basealphaenvmapmask}} + {{Ent|bumpmap}} Doesn't work}}
<br>
{{Note|[[Glowing_Textures#.24selfillum|$selfillummask]] Missing}}
{{Note|{{Ent|$selfillum_envmapmask_alpha}} Missing}}
{{Note|[[Glowing_Textures#.24selfillum|$selfillumfresnel]] Missing}}
{{Note|{{Ent|$blendtintbybasealpha}} Missing}}
{{Note|[[$detail#Parameters and Effects|$detailtexturetransform]] Missing}}
{{Note|{{Ent|$lightwarptexture}}{{csgo}} Missing}}
{{Note|{{Ent|$envmapfresnelminmaxexp}}{{only|{{l4d}}+}}}}
{{Note|{{Ent|$envmaplightscale}}{{only|{{as}}+}}}}
{{Notice|{{Ent|$basealphaenvmapmask}} requires inverted masks}}

=== LUX_LightMappedGeneric ===
* [[$detail#Parameters and Effects|$detailblendmode]] 1-9 works.
* [[$detail#Parameters and Effects|$detailblendmode]] 10-11 planned.
* {{Ent|$bumpmap}} + {{Ent|$envmapmask}} works, used to be {{only|{{csgo}}.}}
* {{Ent|$lightwarptexture}} + {{Ent|$detail}} works ( does not work in {{as}}{{tf2}} ).
* {{Ent|$basealphaenvmapmask}} + {{Ent|$bumpmap}} works.
* [[Glowing_Textures#.24selfillum|$selfillummask]] Exists now.
* {{Ent|$blendtintbybasealpha}} Exists now.
* {{Ent|$selfillum_envmapmask_alpha}} Exists now.
* [[$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.}}
::{{workaround|Materials that previously used have to be adjusted. Use {{Ent|$envmapmask}} or {{Ent|$normalmapalphaenvmapmask}} instead! }}

== VertexLitGeneric ==
=== Stock Shader's ===
==== Always ====
{{Ent|$envmaplightscale}}{{only|{{csgo}}}}.
==== Without $Bumpmap ====
{{Bug|[[$detail#Parameters and Effects|$detailblendmode]]{{src13}}{{tf2}}{{as}}{{csgo}} 10-11 Don't work.}}
{{Bug|[[Glowing_Textures#.24selfillum|$selfillumfresnel]] missing.}}
{{Bug|{{Ent|$lightwarptexture}} missing.}}
: {{Note|$lightwarptexture fores bumpmapping by binding a default one, unless one is manually specified.}}

==== '''With''' $Bumpmap ====
{{Bug|[[$detail#Parameters and Effects|$detailblendmode]]{{src13}}{{tf2}}{{as}}{{csgo}} 5-11 Don't work.}}
{{Bug|[[$detail#Parameters and Effects|$detailblendmode]]{{csgo}} 5-6 & 8-11 Don't work.}}
{{Note|{{Ent|$envmapmask}} missing. Except {{Mapbase}}.}}
{{Note|[[Glowing_Textures#.24selfillum|$selfillummask]] missing. {{confirm|Only in {{Mapbase}}?}}}}
{{Note|{{Ent|$selfillum_envmapmask_alpha}}{{Mapbase}} missing.}}
{{Bug|[[Glowing_Textures#.24selfillum|$selfillumfresnel]] disables {{Ent|$normalmapalphaenvmapmask}}. {{Todo|Also on other branches than {{as}}?}}}}

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

=== 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>
::{{Todo|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>
* {{Note|[[$phong#Masking|$invertphongmask]] Now only flips the mask used for phong. It will no longer touch the envmapmask ''at all''.}}
* {{Note|[[$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>
* {{Note|[[$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.<br>
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}}+}}
<br>
<br>
<br>
<br>

{{Todo|Add LUX_WorldVertexTransition and other LUX_ Shaders to this list of comparison and changes.}}
: {{Note| Probably better as their own pages to document all parameters.}}