VIS optimization

GoldSrc/Source

Source 2

edit

This article or section needs to be cleaned up to conform to a higher standard of quality because:

This article originally exclusively covered Source, but GoldSrc info has been added, as most of the same concepts apply. Nonetheless, much of the Source-only stuff is not properly marked as such, and the optimization features provided by ZHLT and the now-standard VHLT are not mentioned.

For help, see the VDC Editing Help and Wikipedia cleanup process. Also, remember to check for any notes left by the tagger at this article's talk page.

Without VIS, everything in a map is drawn all the time regardless of whether or not the player can see it, which would reduce the game performance (and framerate). Clearly the list of objects to be rendered must be trimmed, but how? It would take far longer to test whether each object or surface could actually be seen than it would to render them in the first place!

Game engines have to make a compromise; GoldSrc and Source both use the Binary Space Partition model, based on  John Carmack's implementation in Quake. This page explains how it works and how to manipulate it.

Leaves

Visleaves in a corridor.

The interior (i.e., not occupied by a world brush) space of a BSP map is split into visleaves. Visibility between these 3D volumes is calculated when the map is compiled, and embedded into the map file for use by the engine. Like brushes, leaves are always convex.

The image to the left shows how leaves might be created in u-turn corridors (gaps between them have been added for clarity). There is no line of sight between leaf 1 and 3, and therefore when the camera is in one the contents of the other are not drawn. Calculating this is as simple for the engine as glancing at the map's embedded visibility chart.

But there is a problem with leaf 2. The contents of all three leaves are drawn when the camera is within it, frustum culling aside, even if the left-hand wall completely fills its view. There are tools to overcome this that we'll look at shortly, but keep in mind that in a lot of cases fixing the problem will be more expensive than simply drawing the less-than-optimal scene.

Bear in mind at all times that displacements, point and brush entities (including detail brushes) don't affect leaves. Create nodraw world brush "foundations" if this is a problem: it's quite common for displacements to be created as detailed 'skin' on top of a world brush skeleton, for example.

Note:World brushes with $translucent textures do cut visleaves.

Warning:Leaves cannot be created if your map has a leak.

Tip:Leaves are split every 1024 units along the xy-plane regardless of brush geometry in order to break large areas down. Hammer's grid is highlighted to help you accommodate this.

Note:Leaves work vertically as well as horizontally. Treat skies as extensions of the streets and rooms beneath them.

Reducing VIS Compile Time

VVIS (or VIS/HLVIS in ) the tool that calculates visibility between leaves (whereas VBSP (or QBSP2/HLBSP creates them). It shouldn't take more than a few minutes to finish work on even the most complex maps, and if it does, chances are you need to do some of the following. Even if it doesn't, they're good practice!

• Use detail brushes appropriately.
• Keep world brushes on the grid as much as you can. Dimensions in the power of two are good.
• Use simple world brushes that have not been manipulated via other tools excessively, such as carve or vertex manipulation
• Place func_viscluster(in all games since ) in large areas with unbroken visibility. Leaves within it will be assumed able to see each other.
• Avoid creating large open areas that the player won't see or interact with in the first place, if it's reasonable to do so. Use a 3D Skybox to reduce sky size, and create a world brush skeleton beneath displacements.

Remember that VIS compile time and in-game performance are two very different things. It may well be worth bearing a long compile if shortening it compromises your result.

Inspecting Leaves

Since Source 2007, Hammer has a new function to view the current map's leaves in the 3D view: Map > Load Portal File. This displays leaf edges that touch other edges as thick blue lines. It's a fantastic learning tool, as if you compile your map without VIS or RAD (then reload its portal file to refresh the display), you can see your changes' effects very quickly.

Source 2006 users and earlier must rely on the glview application.

Tip:For even more clarity, use auto visgroups to remove objects from your map that don't block visibility—generally everything but "World Geometry," plus "Tool Brushes," "Water," and "Displacements."

For in-game inspections, there is a console variable called "mat_leafvis". mat_leafvis 3 will outline all the visleaves in the PVS, while mat_leafvis 1 will just outline the leaf that the camera is currently in. (This variable is a cheat.)

You can also inspect the geometry itself through using the mat_wireframe console variable. mat_wireframe 1 will display how polygons are drawn in the current PVS. (This variable is a cheat as well.)

Hints

Main article:  Hint brush

All leaves draw at the same time until we hint.

Unfortunately, leaves don't always work out so well as they did in our first example. Consider the alternative layout on the left (in practice things would be configured as per the first image, but put that aside for a moment): in this example the leaves can all see each other, leading to the whole area being drawn at once for no good reason. This is where Hints come in.

A hint is a brush face textured with the special tools\toolshint material, which slices any leaves it intersects in two (faces of the brush that should not split leaves must be textured with tools\toolsskip). In our example, we would place a hint where the purple line indicates, so that it slices leaves 1 and 3 to the same shape that they were in our first example.

It isn't possible to merge leaves together, so after hinting there will be three separate leaves on the right-hand side. Thankfully this isn't a huge problem.

Tip:It's a good idea to use hints to separate expensive and cheap areas of the same leaf, if doing so will reduce the amount of time that the expensive areas are drawn for.

Detail Brushes

As was mentioned above, leaves are molded around world brushes. But what if you don't want a brush to do that? If you have a brush that can be seen around at all times (e.g., a statue plinth, or a small free-standing wall), there’s no point in creating lots of extra leaves around it.

In these situations you want func_detail. It's an internal entity which makes the compilers ignore the brush when calculating visibility, without otherwise affecting its behaviour. It's not uncommon for large portions of a map's brushes to be detail.

Nodraw Surfaces

If a player cannot see a brush face without cheating or being a spectator, it's a good idea to apply the special toolsnodraw material (in ) or NULL texture (in ) to it. Nodraw removes the entire face when the map is compiled without affecting visibility, which reduces both rendering time and, since no lightmap needs to be calculated, map file size.

You do not need to apply Nodraw to faces that are touching the void (i.e., outside the map) or to brush faces touching other brush faces tied to the same entity (the world being one big entity of its own). See Brush#In-game.

Tip:(in ) VBSP combines all func_details into one at compile time, so faces of func_details that are flush with each other don't need to be nodrawn, either, unless the brush contains a transparent or translucent material.
(in ) HLCSG removes func_detail faces that share a detail level, or are flush with a lower detail level.

Areaportals (only in Source)

Main article:  Areaportal

Teal lines indicate good areaportal locations.

In the image to the left all of the leaves can see each other, and this time there is very little that hint brushes can achieve.

In this situation we should create Areaportals at the mouth of selected openings. These make the engine perform the per-object line of sight testing that Carmack created the BSP/visleaf system to avoid—but with that system behind it, and with the calculations restricted to when the camera looks through the areaportal, performance can be gained if one blocks enough objects from view.

The image has areaportal locations marked over each mouth, but placing all four would likely hinder performance more than help it. Your strategy depends on the relative cost of each area—in most situations, creating the large areaportal to the right and leaving the corridors alone would be best.

(It is possible to use hints to reduce visibility in this situation, but only with a ridiculous number of them at very precise angles, which impacts performance in its own way. If you can't see across a room for hint brushes, then you should be using an areaportal!)

Tip:Areaportals are also useful because they can be closed to completely and cheaply block visibility past them. It's a good idea to attach an areaportal to every window-less door in your map, so that they can automatically perform this function.

Note:Areaportals make no account for objects in front of them.

Warning:Areaportals can cause problems if placed incorrectly, so be sure to read about them carefully.

Occluders (only in Source)

Sometimes you want to block visibility in a way that visleaves simply don't allow: consider a destructible free-standing wall behind which are standing several expensive character models. You don't want to draw the models if they aren't being seen, but without any connected world brushes to work with except the ground you can't do it by separating leaves.

An Occluder is the tool for the job. It's a brush that hides models (not brushes, alas) behind it when enabled, in a similar manner to an areaportal hiding things that aren't behind it. For obvious reasons, it should be entirely contained inside an opaque object.

It is possible, however, to convert some brushes into models with something like Propper. That way, it's possible to hide more models with an occluder. This should be done on detail brushes, which aren't used for cutting visleaves.

Draw Distance

If you are dealing with a large open area without any cover at all then there isn't a lot you can do but remove detail or employ fog to disguise a low draw distance. Configure draw distance with Far z_clip plane (farz).

Draw distances can also be applied selectively to props, even prop_static, with the Start Fade Dist/Pixelsand End Fade Dist/Pixelskeyvalues. As the names suggest, these values can represent either distance in units or pixels on-screen as per theScreen Space FadeKV.

Tip:In fact, all entities with a model can be faded, as well as overlays. These keyvalues are !FGD for most of these entities, however.

If you enter fade distances on props, it’s a good general rule to have the difference between the two numbers (start and end) be 200. It looks pretty good, and the larger that number is, the longer the model incurs an increased cost to render. Fading models do not go through the fast path and incur additional sorting cost.

func_lod is a special brush entity that can fade out. You can't use any brushes tied to it as any other entity, however!

Sample Maps

• sourcesdk_content\hl2\mapsrc\
  • sdk_func_detail.vmf
  • sdk_hints.vmf
  • sdk_occluders.vmf

See also

• Skybox Optimization