$lightmap

$lightmap is a material shader parameter for the VertexLitGeneric shader available in Source 2013 Multiplayer, Team Fortress 2 branch, and Garry's Mod.

It defines a lightmap to be used to light the MDL model's material, instead of the per-vertex lighting used by prop_static or point-based vertex lighting used by other models.

This parameter does not usually need to be added manually, as VRAD will generate model lightmaps automatically if generatelightmaps is enabled for the prop_static and -StaticPropLighting is enabled in VRAD. Nonetheless, it can still be added manually, such as for using a lightmap on a prop_dynamic, or if a prop_static has multiple materials (as VRAD can only generate lightmaps for the first material and skin).

Tip:

• VRAD has a -dumppropmaps option, which will create external TGA versions of the generated static prop lightmaps which can be converted to VTF and manually defined as a $lightmap.
  Important:In , $lightmap is automatically overridden by the engine, regardless of if a PPL lightmap is present.
  Bug:The resulting TGAs are written with the wrong color space; convert the resulting PPL files instead. This command can be useful for indicating which model and at what location each prop is, which the PPL filenames lack. This issue is fixed in
  Tip:To pair static props in a map with their dumped lightmaps, use r_staticpropinfo 2 to show static prop IDs on screen.
• For already-compiled maps, the lightmaps are stored as PPL files. These can be converted to VTF using Ficool2's proptexelvtf.exe (direct download).
• If $lightmap is used to manually define lightmaps for a prop_static, disable vertex lighting for the prop (disablevertexlighting) to prevent VRAD from wasting time calculating lighting for the prop and generating a VHV file that will ultimately go unused and waste space.

Code:The VertexLitGeneric shader code for lightmapped props from can be backported to , but the lightmaps will need to be explicitly defined in the VMT, rather than generated as PPL files by VRAD.

VMT syntax

$lightmap <texture>

models/lightmapped/example.vmt

vmt

VertexLitGeneric { $basetexture "models/lightmapped/example_base" $lightmap "models/lightmapped/example_lightmap" }

Limitations and caveats

Warning:Models use the same UVs for lightmaps as $basetexture, and the model's lightmap is affected by $basetexturetransform; as such, lightmapping on models with overlapping or tiling UVs may not appear as intended!
VRAD cannot create lightmaps for UVs outside of the 0-1 UV space.
Additionally, shadows may appear on UV seams; this is more noticeable on lower-resolution lightmaps.

Bug*:Lightmaps for models with multiple materials do not compile properly in VRAD! A lightmap will only be compiled for the first material on the model, that is a combined version of all the UV's used by all materials.

Workaround:Define a pre-baked $lightmap in the VMT of the VertexLitGeneric material (can be obtained using -dumppropmaps in VRAD).

Warning:Model lightmaps generated with VRAD are compiled as RGB888 (24-bit SDR) PPL files which can result in noticeable color banding when brightly lit in HDR mode.

Workaround:

• Define a pre-baked RGBA16161616f $lightmap in the VMT of the VertexLitGeneric material. A custom-coded compiler would be required to this accurately (and could also create RGBA16161616f PPL files instead, which will work with vanilla shaders).
  • Garry's Mod's VRAD now bakes RGBA16161616f PPL files in addition to the traditional 24-bit SDR RGB888 PPL files.^[1] VRAD bakes and packs both PPLs in maps (during the -hdr and -ldr stages respectively) and will swap between them depending on the client's currently selected HDR mode. -dumppropmaps has also been updated to output PFM files in addition to the traditional TGAs, both being dumped to a new folder located at steamapps\common\GarrysMod\garrysmod\sp_lightmaps.
• Increase lightmap resolution (results may vary).
• Move light source further away from the lit surface.

Warning:Models using $bumpmap cannot receive lightmaps, they will fall back to vertex-lighting based upon the models' origin or $illumposition.

Code:There is an in-engine check that confirms whether or not the $bumpmap parameter is defined for a material, a custom shader cannot simply use both as there are a dozen technicalities that have to be overcome.

Technical Expand

If $bumpmap, $normalmap, or $phong is defined, the engine will not send the lightmap data to the shader. For $bumpmap, a workaround for this is to use a differently named parameter. ($NormalTexture) to get the normal map and undefining $bumpmap. However no static lighting data can be received by the shader, if the $bumpmap parameter is not set to anything. This refers to lights that are not named and are not inherently dynamic. This may be prefered as the static light information is already prebaked in the lightmap, however it means you cannot receive direction information from the lights. No light direction means no bumped lighting from the lightmap. Aka no specular highlights. A fix for this would be modifying VRAD to spit out a lightmap that is *2 the size on the U axis and then storing an average light direction there or doing some other smart technique to 'memorize' light directions. This in-engine check also exists for $phong, however getting around the issue is more tricky. The default value of the integer parameter will be 0 even if not set in the vmt. Thus making $phong always be defined in a way. Workaround:This can be sidestepped by modifying VRAD to bake the normal map data directly into the lightmap via a %NormalMap texture, akin to Q3Map2's q3map_normalImage. The lightmap will need to be as high resolution as the normal map, but this is made up for by the normal map never entering VRAM (in fact, it won't even need to be shipped with the map!).

See also

• $detailblendmode 8 - Can be used on the UnlitGeneric shader to simulate lightmaps in all Source engine branches.
• Modulate - A shader that can be used to fake lightmaps or vertex coloring in all Source engine branches. It can bypass some of the limitations of $lightmap, but requires additional setup to look convincing.

References

CollapseReferences
1. These features were implemented following garrysmod-requests issue #2464