View source for Cubemaps

{{otherlang2
|fr=Cubemaps:fr
}}
[[Image:Env_cubemap.png|left]][[Image:Specular.jpg|thumb|350px|right|Specular reflections.]]
Many reflective [[material]]s must be combined with external data so that the [[Source]] engine can correctly generate their appearance. This data is stored as a ''cubemap'', a texture which represents a three-dimensional rendering of an area. The Source engine uses [[env_cubemap|env_cubemap]] entities as sampling points for generating these textures, and saves the cubemaps inside each map's .bsp file. While processing specular and environment-mapped materials, it utilizes them to more accurately generate environments. In other words, a cubemap creates the textures that a reflective surface will be reflecting.

{{note|[[Portal 2]] and [[Team Fortress 2]] have issues with building cubemaps. Their bugs are listed [[#Bugs|here]] }}

==Placement==
Declaring areas for cubemaps to cover is simple, just place an [[env_cubemap|env_cubemap]] point entity inside the space of a map. When the map is compiled with [[vbsp|VBSP]], world geometry surfaces automatically associate themselves with the nearest [[env_cubemap|env_cubemap]] and will use the cubemap generated from it. Entities associate themselves with the [[env_cubemap|env_cubemap]] closest to their origin (alternatively, a cubemap can be applied to specific brush faces in the cubemap's properties); moving entities will dynamically change which cubemap they use. It is important to choose [[env_cubemap|env_cubemap]] positions properly for both aesthetic and performance issues.

Cubemaps are used in a few specific ways, and should be placed accordingly. Some cubemaps are used for reflections on static world geometry. Others are used with player entities, including [[NPC|NPCs]]. And the rest are used for any non-player reflective entities. The optimal placement of [[env_cubemap|env_cubemap]] entities corresponds with each of these uses, to ensure the maximal benefit, ''visually and in performance.'' Here are a few simple heuristics to follow:

*If a cubemap is intended for NPCs or the player, the [[env_cubemap|env_cubemap]] should be placed at head-height (as a rule of thumb, 64 hammer units) above the ground. This way, the cubemap will most accurately represent the world from the perspective of a standing creature.
*If a cubemap is intended for static world geometry, the [[env_cubemap|env_cubemap]] should be a fair distance (as a rule of thumb, 16 hammer units) away from all brush surfaces.
*A different cubemap should be taken in each area of distinct of visual contrast. A hallway with bright yellow light will need its own [[env_cubemap|env_cubemap]], especially if it is next to a room with low blue light. Without two [[env_cubemap|env_cubemap]] entities, reflections and specular highlights will seem incorrect on entities and world geometry in one of the areas.

==Building Cubemaps==
Once a map has been compiled and lit by [[Vbsp|VBSP]] and [[Vrad|VRAD]] (respectively), the cubemaps can be built. After the map is finished loading; use the <code>buildcubemaps</code> [[Developer_Console|console]] command to begin building the cubemaps for the level. Here you’ll be able to see each facet of the cubemap (six per cubemap) render and this can take seconds or minutes to complete depending on your system configuration. Once finished, the map or the game must be restarted for the cubemaps to properly be applied to all surfaces.

{{note|Set <code>mat_specular</code> to 0 before running <code>buildcubemaps</code> or it will result in improper reflections!}} 

{{note|Built cubemaps are saved in the bsp file the game loaded, which will be in the maps folder, not the location where the bsp file was built.}}

{{note|If you intend to change the name of your bsp and build its cubemaps, you must buildcubemaps before renaming and packing the bsp.}}

===HDR===

If the map has been compiled with the [[HDR|HDR]] lighting option enabled in [[Vrad|VRAD]], cubemaps '''must''' be built in both HDR '''and''' LDR (non-HDR) modes. Building cubemaps in only one mode will mean that cubemaps will not be present the other mode. For information on how to build cubemaps under HDR, see [[HDR Lighting Basics]].

Cubemaps should be built for LDR and HDR maps. Presuming you are already in HDR mode and have your map loaded fresh from compilation (VRAD must have the '<code>-both</code>' parameter enabled). Go to the console and execute the following commands:

 buildcubemaps
 mat_hdr_level 0 ''(to go to LDR)''
 restart ''(to reload map)''
 buildcubemaps
 mat_hdr_level 2 ''(to go back to HDR)''
 restart ''(to reload map)''

{{note|This does not apply to CS:GO as HDR cannot be turned off.}}

===Team Fortress 2 / Source 2012+ games ===
[[Team Fortress 2]] does not have a default cubemap applied to reflective surfaces. (There are also similar problems with some installations of [[Portal 2]], except cubemaps will simply not appear.) Everything shiny will shine with a pink and black checkered texture. If you were to build cubemaps now and one of your cubemap is able to see a large shiny surface; the cubemap will register that in its 6 images. That means some objects might shine as if there was something shining next to it with the pink and black texture. To solve this, you need to build the cubemaps with specular turned off. To build cubemaps for your TF2 map, load it up via "Create Server". Then, go to the console and execute the following commands:

Building Cubemaps for LDR '''or''' HDR only:
 mat_specular 0
 buildcubemaps
 mat_specular 1
 disconnect
 sv_cheats 1
 mat_reloadallmaterials
 sv_cheats 0

Building cubemaps for HDR requires you to repeat these steps after loading your map while HDR is enabled.

{{note|If the game crashes when you try to build cubemaps, this probably means your game resolution is set too low. Before you try to build cubemaps you must ensure your game width and height are over 512 pixels. This means that the minimal standard resolution to build is 800X600. The video resolution can be changed from the Video tab, found under the game Options menu.}}

{{note|If the map bsp file is renamed after the cubemaps have been built the cubemaps will no longer work and default to the sky cubemap. You must rebuild cubemaps again each time a map is renamed. However, the no-longer-working cubemaps are not removed, so this can lead to bloated files. If you plan to release a map so that others can download it, it is best to try to avoid any map-renaming after you compile it, to avoid problems.}}

{{note|For multiplayer maps in some games, you may need to enable cheats (<code>sv_cheats 1</code>) before running the <code>buildcubemaps</code> command.}}

===Cubemaps after SteamPipe Update===
Due to the SteamPipe update, a recognised problem might be building the cubemaps with no effective results. According to a [http://www.facepunch.com/showthread.php?t=1293081 thread], this problem can be fixed by following those steps:
<code>
# Place env_cubemap entities in valid locations in your map, and compile. Important: Name has to shorter than 30 characters (including the .bsp extension), or the .bsp won't be writeable! Also, don't change the map name after compilling, or the cubemaps won't work!
# Use your favorite .bsp pakfile editor (For example, VIDE or Pakrat. Usage of these tools isn't included in this tutorial.), and load your .bsp. 
# Delete all files that are a "Texture" or "Texture (HDR) type. (Not "Material" files, only the .vtf's!)
# Save the edited .bsp. 
# Copy your map back to your game's maps folder.
# Open console and type: "map -mapname-". (In my case, "ttt_mars_colony_cubemap".) 
# Once you're ingame, open the console again and type this: "mat_specular 0" and "buildcubemaps". 
# Wait until the cubemaps are built, and then re-enable specular mapping with "mat_specular 1" and reload your materials with "mat_reloadallmaterials".

{{note|If you want to pack custom content with your map, do it after building cubemaps.}} 
</code>

===Source Filmmaker===

Building Cubemaps in Source Filmmaker is currently broken and will only render a single face of a single cubemap. To build cubemaps for Source Filmmaker maps correctly, copy the map file and assets used by the map (textures, models, etc) to [[Alien Swarm]]. As the engine branch version is very similar there is no need to recompile separate maps or models, copying the files should suffice. Load up your map in Alien Swarm and input the "buildcubemaps" command into the console. After the faces are rendered, your map will now contain cubemaps and can be copied back over to Source Filmmaker. This will only work with the newer map branch version as maps from [[TF2]] or [[Garry's Mod]] will crash the game upon loading.

===Portal 2===
When you want to build cubemaps for a map lying in "Portal 2/portal2/maps" (Hammer copies the maps to there by default) Portal 2 will crash because it expect that the map can be found under "portal2_dlc2/maps". So if you want to fix the crash, just copy your map into "Portal 2/portal2_dlc2/maps" (or the maps folder of your custom mod) reload it and build cubemaps again. It should work now.

== Testing ==
Cubemaps are best tested by using the <code>[[impulse]] 81</code> console command. To do this; type in <code>[[impulse]]</code> 81 in the Console. Then, type <code>[[give]]</code> weapon_cubemap. 

{{note| You can bind these 2 commands to separate keys so don't have to type this in every time.}} 

This replaces the current weapon model with the "[[weapon_cubemap|cubemap weapon]]"; a set of spheres, each with different reflective surfaces. By moving around the level it is possible to see what cubemap is being applied at that position in space at any given time, as well as if that cubemap accurately describes the area’s lighting and color. 

{{note|The [[weapon_cubemap|cubemap weapon]] can be copied from ''Steam\SteamApps\common\Half-Life 2\hl2\models\shadertest\envballs.mdl'' to a desired mod which doesn't have it.}}

{{note|If you run a recompiled copy of the same map without restarting the game, the cubemaps from the previous version will still be cached, making it appear as if cubemaps do not need to be rebuilt. These cubemaps are ''not'' in the map, however, as running the map again on another computer or after restarting the game will reveal. Every new compile wipes out all packed content, including cubemaps.}}

== Performance ==
The <code>[[env_cubemap|env_cubemap]]</code> entity allows the user to define how large the target cubemap’s texture resolution is. While a larger texture resolution will provide more accurate and “sharp” results when sampled, it also incurs a cost in texture memory. Most cubemaps should only use the default setting in the <code>[[env_cubemap|env_cubemap]]</code> entity for their texture resolution (32x32 pixels for each surface). This is generally acceptable in normal conditions. Some exceptions may be necessary for areas of high reflectivity or detail, such as set-pieces for acting.

Because surfaces must approximate their surroundings via cubemaps, using too many cubemaps in a small area can cause noticeable visual discontinuities when moving around. For areas of high reflectivity, it is generally more correct to place one cubemap in the center of the surface and no more. This avoids seams or popping as the view changes.

To determine the cost of cubemaps in any one area, first look at the World Rendering category using the <code>[[showbudget|+showbudget]]</code> console command. If this category is registering an unusually high cost, it may be due to using too many cubemaps in an area. A simple solution to check for this scenario is to use Hammer to Hide all the cubemaps in the map, and then compile and run the map again. If the performance is noticeably better, cubemap density or resolution may need to be reduced.
Eventually this can also be checked by turning off cubemaps, by using <code>mat_specular 0</code> to disable it, however this needs confirmation.

==Bugs==
{{note| For some games (L4D{{L4d}}/L4D2{{L4d2}}) a complete '''game restart''' is required after building the cubemaps in order to enable them.}}

{{bug|In [[Team Fortress 2]] there is no default cubemap, so all reflective surfaces will show the [[missing content]] texture, which resembles a pink and black checkerboard. To fix this you will need to build cubemaps manually.}}

{{bug|Building cubemaps in Portal 2 will crash the game if the map you are running is in the default ''common/portal 2/portal2/maps'' folder. This crash happens when the map is being reloaded, after the cubemaps have been saved to the file. To prevent the crash, set the 'Place compiled maps' option in the [[Hammer_Build_Programs|Build Programs]] tab of Hammer options to 'common/portal 2/portal2_dlc2/maps', then recompile the map before compiling the cubemaps.}}

== See Also ==

* [[$envmap]]

[[Category:Level Design]]