Viz Artist User Guide

Version 5.1 | Published October 31, 2023 ©

Background Loading

The background loading of Geometries, Materials and Images, without disturbing the rendering and video output, is supported in Viz Engine Classic Renderer with the limitations listed below. Background Loading can either be an automatic or a manual operation. When background loading Geometries, the render method (See the Render Options page in the Configuring Viz section of the Viz Engine Administrator Guide) must be set to VBO (Vertex Buffer Objects).

This section contains the following topics:

Automatic Background Loading

When set to perform automatic background loading, Viz Engine automatically uses background loading whenever an image, and/or an object, is loaded. There are some limitations to this behavior, which are detailed in Background Loading Limitations.

Automatic Background Loading Configuration

In the Viz Config file, the option Background_Loading_Level is available to set up automatic background loading.

Available values for Background_Loading_Level are:

Value

Description

BGL_INACTIVE

Disables automatic background loading.

BGL_IMAGES

Enables automatic background loading for images.

BGL_OBJECTS_AND_IMAGES

Enables automatic background loading for images, geometries and materials.

Manual Background Loading

Manual background loading can be done on an on demand basis. To do this, commands are available to use Container objects:

Command

Description

GEOM SETBGL

Loads (and sets) a geometry in the background. The usage of the command is exactly the same as the existing GEOM SET command.

IMAGE SETBGL

Loads (and sets) an image in the background. The usage of the command is exactly the same as the existing IMAGE SET command.

MATERIAL SETBGL

Loads (and sets) a material in the background. The usage of the command is exactly the same as the existing MATERIAL SET command.

Manual Background Loading Configuration

To use manual background loading, the Background_Loading_Level configuration flag in the configuration file must be set to BGL_INACTIVE.

Background Loading Limitations

This section details the limitations of background loading.

Scenes

Background loading of whole Viz Artist Scenes is not supported.

Compressed and Uncompressed Images

Only compressed images (DXT) are supported for background loading. Their mipmap-levels have been pre-generated and stored in the Graphic Hub, which is required for background loading to work properly. The generation of mipmap levels on-demand (as required for uncompressed images) can interrupt the renderer. This primarily depends on the size of the uncompressed images. The larger the image, the more impact on the renderer during background loading.

Objects

Only native geometry and imported third-party geometry objects containing vertex-data, materials and textures are supported targets for background loading. Containers hosting any sort of other plug-in may fail to load in the background. Containers hosting Function plug-ins are NOT loaded in the background, but rather fall back to a normal foreground loading. Containers hosting RTT shaders interrupts the renderer if the particular RTT shader is used for the first time (shader is being compiled), but no longer interrupts the renderer when loading the same shader in the background again.

Function Plug-ins

If a geometry, which is to be loaded in the background, contains one or more Function Plug-ins, the console shows a warning and the geometry is not loaded in the background but in the foreground instead, this can interrupt the renderer.

Image Combining

If a geometry uses the second image (image2) in a texture, this might have an impact on the performance of the renderer. Mostly if one of the images are too large and/or uncompressed.

Black/Transparent Flashing Image Textures

When setting an image with background loading, for technical reasons, the renderer gets the handle to a black (or transparent) texture until the first mipmap level of the image is loaded. This can result in a short flash of black (or transparent) texture while background loading textures on a visible object. To fully prepare textures of invisible objects and avoid texture flashes if there is enough preparation time, activate Preload Textures in the Memory Management Configuration.

Textures Not Visible on SDI Output with Background Loading Enabled

When Viz Trio prepares and takes a scene, it momentarily stops the Viz Engine renderer. If background loading is enabled, this can result in unexpected behavior, such as textures becoming visible only in the preview and not the video output. To avoid this issue when background loading and controlling the engine with UPDATE commands, such as sent by Trio, Viz Engine by default ignores the command RENDERER *UPDATE SET 0. This can be changed by locating the following configuration option in the Viz Configuration file, in the section RENDERER_OPTIONS, and changing the value from 0 to 1:

RendererUpdatesForBackgroundloading = 1

This fixes potential background loading texture issues on the second channel of dual channel setups as well.

Toggle Plug-in

The toggle plug-in can not handle background loading of geometries or scenes.