From Valve Developer Community
Revision as of 01:36, 29 August 2020 by Deprecated (talk | contribs) (Undo revision 236834 by Luke18033: These features are exclusive to CS:GO. "since CS:GO" implies Insurgency and DOI support, which is false; P2CE should use the also template like other third-party mods do)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
Specular reflections at full intensity.
For the set of material parameters used to mask specular reflections via textures, see $envmapmask.

$envmap is a material shader parameter available in all Source games. It creates specular reflections, which are seen on smooth surfaces. It does this by defining an "environment map" (specifically a cubemap) to draw as a reflection; normally that of the nearest env_cubemap entity. The reflection is not dynamic.

Note:$envmap actually works in the latest Source engine version (v24) of <Half-Life: Source> Half-Life: Source if it uses an env_cubemap. The issue actually comes from the buildcubemaps command, since if the cubemaps are built in another game and then the BSP is added into HL:S, they will work fine. Is not clear if in older versions there were more issues but due such problems, Valve used static reflective images for every reflective texture in the game.

The other form of reflection supported by Source is the diffuse Phong type.


$envmap env_cubemap

"env_cubemap" is normally used, as it tells VBSP to swap in the name of the nearest env_cubemap when the map compiles. However it is also possible to use a static cubemap image that has been manually created.

Note:If $envmap is used without specifying $basetexture, the specular reflections will be force drawn regardless of anything.
Note:Most Cubemap textures will have no reflectivity when used as overlays or decals. It is unclear why this is so[Clarify].

Creating a custom static cubemap texture

Creating a custom cubemap texture might be required for some circumstances and is used occasionally in some Valve models.

In VTFEdit

For this to work you will need to have the 6 sides of the cubemap saved as individual textures in the correct orientation for it to appear correctly in the Source Engine. So some faces might need to be rotated either clockwise or counter clockwise. Each face will need to be mirrored horizontally before orientation.

Note:Pre-<Alien Swarm> Alien Swarm games require 7 faces for the cubemap to work. The seventh in this case is a round texture, used as a sphere map for the $envmapsphere parameter.

To the right hand side of this page you will find two guide images to aid in properly rotating each side of your environment render.
Save one or both of those guides on your computer and then import your environment render onto it or recreate it in a smaller scale, then rotate your sides as instructed by the images.
Save every side as a separate image file, their names should be the number found on that specific square. This will ensure that the environment texture will be built correctly, as the numbers also represent the import order in VTFEdit.

Orientation guide for T-assembled environments. Click to enlarge
Orientation guide for render results. Click to enlarge

Once you have all the image sides ready you can just import them all into VTFEdit and select "Environment Map". Texture format is up to you, generally DXT5 will do.

Cubemap tut1 cra0.jpg

Then just save it all as a .vtf file and use it in your VMT like so:

"$Envmap" "effects/my_cubemap"

"effects" is the usual folder for environments/cubemaps You may put yours anywhere you like


VTEX will automatically mirror and orient your faces, you need only to provide correctly named textures. Name each file something like envmap001a*.tga, where * is put BK, FT, LF, RT, UP, or DN. If you took a cubemap screenshot in-game, this step will already by done, but to make them work properly with Vtex.exe you must use HDRShop (but before you need to change textures format to BMP, because HDRShop can only work with that kind of format) and then covert them to PFM files format.

To do: What axis does each direction relate to?

Cubemap axis reference 1.jpg

Create a text file the same name as your textures (e.g. envmap001a.txt). If building for HDR write in the following, otherwise leave it blank:

pfm 1
pfmscale 1
nocompress 1

Put these files into materialsrc and then just drag-n-drop .txt file into vtex.exe and you should end up with a working cubemap! HDR envmaps will be named like envmap001a.hdr.vtf, and only need to exist to work.

Parameters and Effects

$envmapmask <texture>
See $envmapmask. A texture file that determines per-texel reflection intensity.
$envmaptint <RGB matrix>
Controls the intensity of the reflection's red, green and blue color channels. Any positive number can be used. Default is "[1 1 1]", which means 100% intensity.
Note:You must use quotemarks, as there are space characters within the value.
Tip:This command is often used to dim the brightness of a specular reflection without the overhead of an $envmapmask.
$envmapcontrast <normal>
Controls the contrast of the reflection. 0 is natural contrast, while 1 is the full squaring of the color (i.e. color*color).
Note:Will not work when Phong is enabled.
Tip:Use higher contrasts to diminish relatively darker areas and increase "hot spots".
$envmapsaturation <normal>
Controls the colour saturation of the reflection. 0 is greyscale, while 1 is natural saturation.
Note:Will not work when Phong is enabled on models.
Bug: <Counter-Strike: Source> Works only on models.
$envmapframe <integer>
The frame to start an animated cubemap on.
$envmapmode <integer>  <Obsolete>
Deprecated.  Depreciated MATERIAL_VAR_ENVMAPMODE = (1 << 25), // OBSOLETE
$basetexturenoenvmap and $basetexture2noenvmap <boolean>  (removed in <Counter-Strike: Global Offensive>)  (DX9+)
Used for materials with two albedos, to make one or the other matte. See also $basetexture and $basetexture2.
Note:Superseded in <Counter-Strike: Global Offensive> by $envmapmask2.
Shaders: WorldVertexTransition
$envmapoptional <choices>  (removed in <Left 4 Dead>)
Sets the oldest DirectX version that should draw the reflection. Choose from:
  • 80 (DirectX 8)
  • 81 (DirectX 8.1)
  • 90 (DirectX 9)
  • 95 (DirectX 9 with Shader Model 3)
$envmapsphere <boolean>  (removed in <Alien Swarm>)  <Obsolete>
Deprecated.  Determines whether the material's envmap should be a spheremap (deprecated) instead of a cubemap. Set this to 1 to use a spheremap.
$noenvmapmip <boolean> (only in <Counter-Strike: Global Offensive>)
Only use the top-level mipmap of the cubemap.
Shaders: LightmappedGeneric
$fresnelreflection <float> (in all games since <Source><Source>)
Adds a Fresnel effect to the reflection. 0 is none, while 1 applies the full effect, similar to Water. The effect becomes multiplied with values higher than 1.
Shaders: LightmappedGeneric, Lightmapped_4WayBlend, WorldVertexTransition
$envmapfresnel <float> (in all games since <Source><Source>)  (DX9+)
The same as $fresnelreflection, but for VertexLitGeneric.
Shaders: VertexLitGeneric
$envmapfresnelminmaxexp <vector> (in all games since <Left 4 Dead 2>)
Sets the ranges for the Fresnel effect for VertexLitGeneric. By default "[0 1 2]", making surfaces facing the viewer less reflective than surfaces facing sideways.
Note:The fresnel values here are NOT the same as those for $phongfresnelranges.Instead, the first value is the minimum amount of fresnel, the second value is the maximum, and the final value is exponent.
Bug: Cannot be used with $bumpmap. $phongfresnelranges must be used instead.
Shaders: VertexLitGeneric
$envmaplightscale <float> (in all games since <Alien Swarm>)
How much the surface's lightmap tints the specular reflection. A value between 0 (off) and 1 (no reflection with completely black lightmap) determines how much the reflection is tinted; values above 1 are permitted but seem to actually start inverting the effect.
Shaders: LightmappedGeneric, Lightmapped_4WayBlend (<Counter-Strike: Global Offensive>), VertexLitGeneric (<Counter-Strike: Global Offensive>), WorldVertexTransition (<Counter-Strike: Global Offensive>)
$envmaplightscaleminmax <vector2> (only in <Counter-Strike: Global Offensive>)
Thresholds for the lightmap reflection tinting effect. Setting the minimum value higher increases the minimum light amount at which the reflection gets nerfed to nothing.
Shaders: LightmappedGeneric, Lightmapped_4WayBlend, VertexLitGeneric, WorldVertexTransition
$envmapanisotropy <boolean> (only in <Counter-Strike: Global Offensive>)
Enables warping of the reflection, "pushing" the top downward.
Shaders: LightmappedGeneric, Lightmapped_4WayBlend, WorldVertexTransition
$envmapanisotropyscale <normal> (only in <Counter-Strike: Global Offensive>)
The amount the reflection should be warped by.
Shaders: LightmappedGeneric, Lightmapped_4WayBlend, WorldVertexTransition

Console commands

Generates cubemaps for use in materials. If this isn't run, objects will reflect the skybox (OB) or have an invalid reflection, white in Ep1 and pink checkerboards in MP.
To do: Use currently unknown
mat_fastspecular <boolean>
Quickly disable or enable specular rendering without reloading materials. This does not affect performance, only appearance. mat_specular must be used for proper performance testing.
Bug: Doesn't work in some games.
mat_specular <boolean>
Disable or enable specular reflections, unloading or loading the specular materials from memory. Default 1.
r_showenvcubemap <boolean>
Debug command to display cubemaps on all dynamic objects at full intensity. It was used to create the image at the start of this article.

See Also