View source for Zh/VertexLitGeneric

{{wip}}{{translating}}
{{LanguageBar}}{{this is a|vertex shader|name=VertexLitGeneric}} It is the shader most commonly used to render {{L|models}}, and supports a variety of effects. Do not use this on world geometry, else you may encounter lighting bugs.

== Supported Parameters ==

=== Basics ===
{{MatParam|$basetexture|texture|{{L|$basetexture}} defines {{L|diffuse}} texture.}}
{{MatParam|$detail|texture|{{L|$detail|Detail}} texturing.}}
{{MatParam|$decaltexture|texture|Use a 2nd UV channel for high-resolution decal support.|only={{csgo}}}}

=== Adjustment ===
{{MatParam|$color2|RGB matrix|{{L|$color#Models|Color tinting}}.}}
{{MatParam|$basetexturetransform|matrix|{{L|$basetexture#.24basetexturetransform|Transform}} {{L|$basetexture}}'s alignment, scale, rotation and position.}}
{{MatParam|$allowdiffusemodulation|bool|Prevents the model's material from being tinted by {{L|$color2}} or <code>rendercolor.</code>|since={{l4d}}}}
{{MatParam|$seperatedetailuvs|bool|{{todo|''Confirm use of texcoord1 for {{L|$detail|detail}} texture''}}|since={{src07}}}}
{{MatParam|$desaturatewithbasealpha|float|Use the base alpha to desaturate the base texture. Set to non-zero to enable, value gets multiplied into the alpha channel before desaturating.|since={{as}}}}
{{MatParam|$notint|bool|Prevents the model's material from being tinted by {{L|$color2}} or <code>rendercolor.</code>|only={{csgo}}|also={{P2CE}}}}

=== Transparency ===
'''VertexLitGeneric''' support a few different methods for transparency, each for different purposes
{{MatParam|$alpha|bool|{{L|$alpha}} {{L|Cheap|Cheaply}} scales the opacity of an entire material.{{confirm|Does this work in any engine branch? It does not in {{src13mp}}.}}}}
{{MatParam|$alphatest|bool|{{L|$alphatest}} is a {{L|Cheap}} transparency using a binary opacity mask.}}
{{MatParam|$nocull|bool|{{L|$nocull}} disables backface culling optimization.}}
{{MatParam|$translucent|bool|{{L|$translucent}} is a {{L|Expensive|expensive}} translucency using a full {{L|Alpha}} mask, for very fine gradients.<br/>{{note|Add material sorting issues}}}}
{{MatParam|$additive|bool|{{L|$additive}} alike {{L|$translucent}} perform full {{L|Alpha}} mask, however it add colors instead of performing a multiplication. This renders in a always brighter material.}}
{{MatParam|$distancealpha|bool|{{L|$distancealpha}} is a vector-like edge filtering.|since={{src07}}}}

=== Lighting ===
{{MatParam|$bumpmap|texture| {{L|Bump_map|Normal map}}.}}
{{MatParam|$lightwarptexture|texture|1 dimension Per-texel color modification via a {{L|$lightwarptexture|warp texture}}.|since={{src06}}}}
{{MatParam|$halflambert|bool|Use {{L|$halflambert|Half-lambertian}} shading.}}
{{MatParam|$selfillum|bool|Determines whether the surface is {{L|Glowing_Textures#.24selfillum|self-illuminated}} independent of environment lighting.}}
{{MatParam|$emissiveblendenabled|bool|{{L|Glowing_Textures#.24emissiveblend|Advanced flowing self-illumination}}, used on the {{L|Vortigaunt|Vortigaunts}} in {{Game link|Half-Life 2: Episode Two}}.|since={{src07}}}}
{{MatParam|$lightmap|texture|Pre-baked {{L|lightmap}}; subject to {{L|$lightmap#Limitations_and_caveats|limitations}}.|only={{src13mp}}|also={{gmod}}}}

=== Reflection ===
{{MatParam|$envmap|texture|{{L|$envmap|Specular reflections}}.}}
{{MatParam|$phong|bool|{{L|$phong|Diffuse reflections}}.|since={{src06}}}}
{{MatParam|$rimlight|bool|Constant {{L|$rimlight|rimlight}} based on {{L|phong}} and the ambient lighting.|since={{src07}}}}

=== Effect ===
{{MatParam|$compress|texture|{{L|Wrinkle_maps#Materials_and_textures|Wrinklemaps}} for character faces.|since={{src07}}}}
{{MatParam|$stretch|texture|{{L|Wrinkle_maps#Materials_and_textures|Wrinklemaps}} for character faces.|since={{src07}}}}
{{MatParam|$flesh|bool|The {{L|$flesh|flesh}} effect used for Alyx in Half-Life 2: Episode Two.|since={{src07}}}}
{{MatParam|$treeSway|bool|Vertex manipulation to give the effect of {{L|$treeSway|trees swaying}} in the wind.|since={{l4d}}|also={{tf2}}{{mapbase}}{{gmod}}{{bms}}}}

=== Technical Workarounds ===
{{MatParam|$flashlightnolambert|bool|Tell {{L|env_projectedtexture|projected textures}} such as the flashlight to ignore the surface normal of the model. Useful for models with {{ent|$nocull}} such as foilage. Otherwise, lighting the face with a flashlight from behind will not affect it. ''Default 0''.|since={{src07}}}}
{{MatParam|$lowqualityflashlightshadows|bool|Force low quality flashlight/projected texture shadows for faster performance.|since={{portal2}}}}
{{MatParam|$allowfencerenderstatehack|bool|Fence render hack for cascade shadow maps, allows shadow maps to work properly with fences.|since={{csgo}}}}
{{MatParam|$disablecsmlookup|bool|Disable cascade shadow map lookup/filtering, useful on dense foilage.|since={{csgo}}}}
{{MatParam|$noshadowpass|bool|Allows turning off the shadow pass of this material.|only={{lw}}}}
{{MatParam|$nodeferredlight|bool|No deferred light input.|only={{lw}}}}
{{MatParam|$modelglobalnormal|bool|Use global light direction as normal for all model vertices.|only={{lw}}}}

===Cloak===

<code>VertexLitGeneric</code> natively supports the Spy cloak effect from {{Game link|Team Fortress 2}}. Combine it with a sine wave {{L|Material Proxies|proxy}} for the full effect.

{{MatParam|$cloakpassenabled|bool|Enables cloaking effects. {{warning|Enabling this on static props causes a heavy performance penalty, even if the cloak effect itself isn't being used!}}}}
{{MatParam|$cloakfactor|normal|0.00 {{=}} fully visible,<br/>
1.00 {{=}} fully invisible.}}
{{MatParam|$cloakcolortint|RGB matrix|Colors the refraction effect. ''Default " [ 1 1 1 ] "''.}}
{{MatParam|$refractamount|float|How strong the refraction effect should be when the material is partially cloaked. ''Default 2''.}}

== Caveats ==

=== Mapbase ===
VertexLitGeneric materials in {{L|Mapbase}} should have the shader '''<code>SDK_VertexLitGeneric</code>'''.

== See also ==
* {{L|Materials_for_models#Compiling_your.VMT_:_Valve_Material_Type|Materials for models}}
*{{ent|EyeRefract}}, the shader for modeled eyes.
*{{ent|Teeth}}, the shader for modeled teeth.