Hint brush

From Valve Developer Community
Revision as of 16:25, 26 November 2011 by Phreque (talk | contribs) (Why and when to split visleaves)
Jump to: navigation, search

Hint planes are used to split visleaves during compile time and, as such, are a way of optimizing the results of the Vis map compile stage.

They are commonly referred to as hint brushes since they are placed in a map in the same way as a normal world brush. The hint plane is defined by the side of the brush that is covered with the tools/toolshint texture. Multiple hint planes can be defined by texturing multiple sides of the brush, or by using multiple brushes. The other sides of the brush that are not acting as hint planes must be covered with the tools/toolsskip texture; these faces will be ignored by the compiler.

Hints are automatically tied to their own auto visgroup, so you can easily hide them.

Why and when to split visleaves

Note.png Note: Learning how visleaves work may aid the understanding of this article.

Sometimes, certain leaf shapes are preferred over others simply because that shape makes those leaves see fewer other leaves. Whenever a leaf is not seen, the contents of the leaf is not drawn, speeding up rendering.

The following illustrates the importance of visleaf cutting, and, at the same time, provides examples on where hints are useful.

The first example is almost the same as the SDK example map. This is a side view of a single room with players and pipes separated by a wall:

Side view of the sdk_hints.vmf sample map, showing the player starts on the left, and models on the right, separated by a wall.

When a player is at either of the two player_starts the engine must consider whether the brushes (pipes) to the right of the wall should be drawn. That occurs because vbsp.exe did not do what would be the most efficient way of dividing our level into leaves:

With no hints, vbsp makes leaves that extend all the way to the ceiling.

Because the leafs are very tall and go all the way to the ceiling, the leaf on the left (with the players) can directly "see" the leaf on the right with the pipes. So the leaf and the contents (the pipes) will be drawn. Quite a shame, because those pipes cannot be seen from the player's perspective (they are behind the wall in the center). We can use hints to steer the process of leaf-making.

Creating a single horizontal hint creates multiple leaves, and the two leaves on either side of the wall cannot see each other.

The white line is a side of a brush with the tools/toolshint texture. It forces vbsp to divide our map into three leaves. In this case, there can be no longer be a straight line drawn from the leaf the players are in to the leaf the pipes are in. That is the essence of hinting.

Skyboxes are sometimes a bit high, causing a player to see a lot of stuff in the city because the leaf he is in can see over the houses (like in the above example). That also is a good situation where one can use hints to stop the visibility.

Corner hints

Without hints, either corner of this hallway will be rendered when standing in the opposite corner.

Here is a top view of a typical corner. There are two players (the green boxes) and the cylinders at each end represent a lot of stuff to be drawn for the engine. The goal with hinting in this case is avoid rendering objects when unnecessary, e.g. when a player is around the corner from the objects.

One may think vbsp will make sure each player won't see the objects belonging to the other player. This is wrong. It will divide this space into two leaves, either cutting the leaves along the brown or pink line (depending on which brush face vbsp cuts first).

Either way, the two corner leaves have a direct line-of-sight to each other, so the contents of each corner will always render when standing in the opposite corner.

Adding an angled hint brush creates corner leaves that can't see each other.

This situation can be greatly improved by simply by placing a hint at the corner, dividing our level into three leaves, (making a total of three instead of two) but making sure one player's stuff doesn't get rendered from the other player's point of view.

There is no direct line-of-sight between the red and brown leaves so unnecessary rendering is avoided. However, if one of the players moves into the green leaf, he will see both his and the other player's stuff rendered. You cannot stop that using hints. The only way to stop this would be by changing the level layout or by using other methods, like the ones described in Controlling Geometry Visibility and Compile Times.

More examples

Various ways to use hints.

Here a few examples of when and how to use hints. In all cases the goal is to hide the green players from each other. The upper three work as they should. The left one illustrates that it doesn't even matter if its one hint-brush spanning the corner, as long as its angle is > 180° the two players will not "see" each other's leaves because no straight line can be drawn between their leaves. The bottom-left example shows you that can happen when the angle is less than 180°. One can easily draw a straight line from leaf to leaf, resulting in non-functional hints.

When the corner in the hallway is 180°, as in the middle top picture, two hints will suffice. In fact, they can even be closer to the players, but that would decrease their effectiveness (more stuff will be drawn "around the corner". ) In the example in the middle bottom, the hints have been lowered and vbsp is forced to cut up the top visleaf because visleaves can't be concave. No matter how vbsp cuts up this corner, the hints will always work less effectively and create extra leaves (more work for vvis). In the example, the left player can see leaves 1 and 2 (same surfaces as above), but the right player will see all three numbered leaves (which is more than the top example.).

The two right pictures show you you should keep things as simple as possible. If one hint will suffice, like in the top example, that is preferred. And, obviously, hints should not be used if not needed, as in the bottom picture. As shown, vbsp cannot create leaves that enable both players to see each other, so there's no need to use hints here to hide the players from each other (hints can be used, of course, to hide parts of the hallways). In the same example, the middle wall should never be a detail brush. Details geometry do not create visleafs and are not taken into consideration by vvis. It will think both players will see each other and that's not what we want. vbsp may even make it so both players here are in the same leaf.

In summary, since hints have no direct rendering cost during the playing of a map, when used wisely they are a primary way to speed up your map and control your visibility.

Hints used to simplify

Lastly, hints can be used to simplify a map. Sometimes, vbsp cuts up a level into more leaves than necessary. This increases compile time. Hints can be used to counteract this. For instance, hints can be placed in doorways to prevent the doorways from cutting up the rooms they connect. Or, if you get an error that a certain visleaf is cornering too many other visleaves, hints can used to cut that leaf into multiple leaves that corner a smaller amount of leaves.

Note.png Note: Visleafs will always be divided every 1024 units (at each red or blue line in the 2D views)

See also


  • sourcesdk_content\hl2\mapsrc\sdk_hints.vmf - sample map included in the Source SDK.