Bit Masking

Bit masking is a flexible mechanism used to access only the specific bits in a set of data. It can be applied to the following systems:

• Rendering into viewport
• Shadowing
• Reflections rendering
• Collisions
• Intersections
• Decals
• Fields
• Sound sources
• Physicals
• Pathfinding

To specify the mask, click the corresponding mask button (Viewport, Shadow, Intersection, etc.) and enable required bits of a 32-bit mask. Enabling a bit means setting the value of 1 (when disabled, the value is 0). The resulting mask is displayed as hexadecimal characters on the top of the context menu window. The name of selected bit or bits is displayed on the mask button.

To collapse the context menu, click the mask button once again.

Bit mask with the first bit turned on

Set All turns on all the bits in the mask Clear All turns off all the bits in the mask

Default names of bits can be changed. The name entered in a field is assigned to a selected bit in all masks of this type. For example, if you assign a name to the first bit of the Viewport Mask of a surface, the same name is displayed for the first bit of the Camera Viewport Mask. Bit masks names are assigned locally and stored in the <Project Name>/data/default.bitmasks file, which is created when you open your project in UnigineEditor for the first time.

Masks are compared bitwise using binary operator and. As a result, the first bit of the first mask is compared to the first bit of the second mask, the second bit — to the second one, and so on.

For example, the following viewport masks have 4 matching bits, so they match:

The camera viewport mask with the first 6 bits enabled	The object's viewport mask with the second, third, fourth, and fifth bits enabled

Each mask has a hexadecimal representation, which is displayed in the input field of the context menu. You can copy the hexadecimal value of one mask and paste it in the input field of another mask to enable the same bits of the mask.

See a part of our video tutorial on bit masking dedicated to a more detailed and visualized explanation of the bit masking concept.

Objects (along with decals and lights) can be selectively rendered into viewport. To that end, the camera viewport mask (set in the Camera Settings window opened via the Camera panel), should match the following masks:

• Object surface viewport mask (Parameters window -> Node tab -> Surfaces section -> Rendering field)
• Object material viewport mask to render the object's material (Parameters window -> Node tab -> Surface Material section -> Common tab -> Options field)

Usage Example#

Suppose, we have two objects with the same material. To make one of them to be rendered into viewport and the other one — not to be rendered, we should change the viewport mask of the second object.

In the surface viewport masks of both objects, the same bit Viewport Mask 0 is enabled (00000001)	For the first object, all bits of the surface viewport mask are disabled (the mask is set to 00000000)

See the demonstration of how to set rendering into viewport and one more usage example in our video tutorial on bit masking.

The reflection mask controls rendering of the environment probe reflections and planar dynamic reflections into the viewport of the reflection camera.

The reflection mask can be set:

• For environment probes (Parameters window -> Node tab -> Baking Settings section -> Reflection Viewport Mask button). The mask is used only in combination with dynamic reflections enabled for the environment probe.
• For planar reflections (Parameters window -> Node tab -> Surface Material section -> Parameters tab -> Planar Reflection section -> Viewport Mask button).

For the dynamic reflection to be rendered, the reflection viewport mask of the reflecting material (Parameters window -> Node tab -> Surface Material section -> Parameters tab -> Planar Reflection section -> Viewport Mask button) must have at least one matching bit with each of the following masks:

• Reflection viewport mask of the camera (Camera Settings window -> Masks field)
• Viewport mask of the object (Parameters window -> Node tab -> Surfaces section -> Rendering field)
• Viewport mask of the object's material (Parameters window -> Node tab -> Surface Material section -> Common tab -> Options field)

See also the fragments of our video tutorial on bit masking demonstrating the use of bit masks with baked reflections and dynamic reflections.

Usage Example#

Suppose, you have a reflecting surface and two objects reflected in this surface.

• To render an object without a reflection, either its viewport mask or its material's viewport mask should have no matching bits with the planar reflection's viewport mask or the camera's reflection viewport mask.
• To render a reflection without an object, the object's viewport mask or its material's viewport mask should have no matching bits with the camera's viewport mask.

In the example below, masks are given in the binary representation. For convenience, let's assume that objects and their materials have identical viewport masks. For masks to match, they should share 1 in the appropriate bit position. You can convert these masks to the hexadecimal number representation and set the obtained values via UnigineEditor.

An object without the reflection	A reflection without the object
Mask Value Camera viewport mask 0111 Camera reflection viewport mask 1100 Viewport mask of the first object 0001 Viewport mask of the second object 0110 Planar reflection viewport mask of the reflecting surface material 1110	Mask Value Camera viewport mask 0111 Camera reflection viewport mask 1100 Viewport mask of the first object 1000 Viewport mask of the second object 0110 Planar reflection viewport mask of the reflecting surface material 1110

In the first example, the object's viewport mask doesn't match the camera's reflection viewport mask. However, it matches the camera's viewport mask, so the object is rendered.

In the second example, the object's viewport mask doesn't match the camera's viewport mask. However, it matches the camera's reflection viewport mask and the planar reflection's viewport mask, so the reflection is rendered.

The shadow mask controls rendering of a shadow cast by an object lit by a light source.

For a shadow to be rendered, the shadow mask of the light source that illuminates the object must match the following masks (one bit at least):

• Object surface shadow mask (Parameters window -> Node tab -> Surfaces section -> Rendering field)
• Object material shadow mask (Parameters window -> Node tab -> Surface Material section -> Common tab -> Options field)

Usage Example#

The example below demonstrates the difference. On the left, the shadow masks of the surface and its material have all bits enabled, thus they have one bit matching the shadow mask of the light source, and the shadow is rendered. On the right, the shadow masks of the surface and its material don't match the shadow mask of the light source, so the shadow isn't rendered.

Shadow mask of the surface and its material	Shadow mask of the surface and its material
Shadow mask of the light source	Shadow mask of the light source

See one more usage example in our video tutorial on bit masking.

A material mask is a 24-bit mask that specifies objects onto which the decal can be projected. An object or one of its surfaces can receive the decal only if the object's material mask corresponds to the material mask of the decal.

The material mask can be specified for a selected material on the Parameters tab of the material editor:

See how the decal projection area can be restricted using the Material Mask in our video tutorial on bit masking.

The intersection mask specifies objects (including objects, nodes, shapes, collision objects, and obstacles) for which intersections will or won't be found. An intersection is found only if the object's intersection mask matches the intersection mask passed as a function argument, otherwise it is ignored.

The mask for the object can be specified via UnigineEditor or API.

The intersection mask can be used to clarify the object search or increase performance by limiting the number of objects that can participate in intersections.

Our video tutorial on bit masking features two use cases of the intersection mask: excluding objects from intersection detection and cutting out grass.

The collision mask allows you to filter particular shapes and bodies for physical interaction: only objects with the matching collision mask will collide. If masks do not match, shapes and bodies simply ignore each other by going through.

For example, we have four bodies that should collide in the following way:

	Body A	Body B	Body C	Body D
Body A
Body B
Body C
Body D

For that, each colliding body should share 1 in the appropriate bit position:

See how the collision mask works in our video tutorial on bit masking.

An analogue of the collision mask but working vice versa. It is used to prevent collisions of the shape with other shapes. For shapes with matching collision masks not to collide, at least one bit of their exclusion mask should match. 0 enables collisions with all shapes with matching collision masks. This mask is independent of the collision mask.

See how the exclusion mask works in our video tutorial on bit masking.

A bit mask that filters objects interacting with physical nodes: force, wind, and water. This mask is set according to the same principle as the collision mask. For example, a body with a mismatching mask placed in the physical water will not float.

An example of the physical mask working with physical effects is shown in our video tutorial on bit masking.

Masks can be set via both UnigineEditor and API.

To see and hear how sound-related masks are used, watch our video tutorial on bit masking.

Source Mask#

Reverberation Mask#

Occlusion Mask#

The navigation mask is used to specify navigation areas that participate or don't participate in pathfinding. The navigation mask should match the navigation mask of the route that is calculated within the navigation area; otherwise, the area does not participate in pathfinding.

The navigation mask for the navigation areas can be specified via:

• UnigineEditor in the Navigation Sector/Navigation Mesh section of the Parameters window
• Unigine API

Using the navigation mask, you can limit the number of navigation areas, inside which the specific route can be calculated. For example, you can use the mask to calculate 2 non-intersecting routes inside the intersecting navigation areas.

A usage example of the navigation mask is provided in our video tutorial on bit masking.

The obstacle mask is used to specify obstacles inside navigation areas that are or aren't bypassed during pathfinding. The obstacle mask of an obstacle should match the obstacle mask of the route that is calculated; otherwise, the obstacle is not taken into account.

Similar to the navigation mask, the obstacle mask can be specified via:

• UnigineEditor in the Obstacle Box/Sphere/Capsule section of the Parameters window
• Unigine API

A usage example of the obstacle mask is provided in our video tutorial on bit masking.

The field mask specifies an area of the field to be applied to grass, water, or clouds. The field mask of a field node should match the grass, water, or cloud layer field mask.

The field mask can be set via UnigineEditor or API.

A usage example of the field mask is provided in our video tutorial on bit masking.