All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Loading...
Searching...
No Matches
VuRenderConfig Struct Reference

Public Attributes

VuRenderVBBackendType vbRenderBackend
 Choice of video background rendering backend type.
 
VuVideoBackgroundViewportMode vbViewportMode
 Configure the video background viewport mode.
 

Detailed Description

Render configuration data structure.

Member Data Documentation

◆ vbRenderBackend

VuRenderVBBackendType vbRenderBackend

Choice of video background rendering backend type.

Note
Selecting a video background render backend can only be done at Engine creation time. To select a different backend type you need to destroy the Engine instance again and create a new instance with the desired backend type.
Default value is VU_RENDER_VB_BACKEND_DEFAULT which represents a different concrete render backend type depending on the underlying platform. See VuRenderVBBackendType for the supported backend types and their default values per platform.

◆ vbViewportMode

Configure the video background viewport mode.

Note
The video background viewport mode can be changed after Engine creation by calling vuRenderControllerSetVideoBackgroundViewportMode.
The render view configuration is also used in the calculation of the viewport if no custom viewport has been set. See vuRenderControllerGetVideoBackgroundViewport for details.
This setting will only be applied if Engine can setup default render view information on Engine creation, otherwise Engine will continue to use the default value. You can use vuRenderControllerGetRenderViewConfig after Engine creation to determine if a default render view configuration was set. To ensure cross-platform that your desired VuVideoBackgroundViewportMode is applied use vuRenderControllerSetVideoBackgroundViewportMode after Engine creation. See vuRenderControllerSetRenderViewConfig for more details.
Warning
The behaviour of the default render view configuration will change in an upcoming release. See vuRenderControllerSetRenderViewConfig for details.
Note
Default value is VU_VIDEOBG_VIEWPORT_MODE_SCALE_TO_FILL