Rendering-related Engine Configuration

Classes
struct	VuRenderConfig
	Render configuration data structure. More...

Enumerations
enum	VuRenderConfigError : int32_t {   VU_ENGINE_CREATION_ERROR_RENDER_CONFIG_UNSUPPORTED_BACKEND = 0x300,   VU_ENGINE_CREATION_ERROR_RENDER_CONFIG_FAILED_TO_SET_VIDEO_BG_VIEWPORT = 0x301 }
	Rendering configuration error code type for errors occurring when creating a Vuforia Engine instance. More...
enum	VuRenderVBBackendType : int32_t {   VU_RENDER_VB_BACKEND_DEFAULT = 0x1,   VU_RENDER_VB_BACKEND_HEADLESS = 0x2,   VU_RENDER_VB_BACKEND_GLES3 = 0x4,   VU_RENDER_VB_BACKEND_DX11 = 0x5,   VU_RENDER_VB_BACKEND_METAL = 0x6 }
	Render video background backend configuration. More...
enum	VuVideoBackgroundViewportMode : int32_t {   VU_VIDEOBG_VIEWPORT_MODE_SCALE_TO_FILL = 0x1,   VU_VIDEOBG_VIEWPORT_MODE_SCALE_TO_FIT = 0x2,   VU_VIDEOBG_VIEWPORT_MODE_NATIVE_VIDEO = 0x3 }
	Supported video background viewport modes. More...

Functions
VuRenderConfig	vuRenderConfigDefault ()
	Default render configuration. More...
VuResult	vuEngineConfigSetAddRenderConfig (VuEngineConfigSet *configSet, const VuRenderConfig *config)
	Add a render configuration to the engine config.

Detailed Description

Enumeration Type Documentation

VuRenderConfigError

enum VuRenderConfigError : int32_t

Rendering configuration error code type for errors occurring when creating a Vuforia Engine instance.

Note

The error code is reported via the errorCode parameter of the vuEngineCreate() function if an error related to the rendering configuration occurs while initializing the new Engine instance.

Enumerator
VU_ENGINE_CREATION_ERROR_RENDER_CONFIG_UNSUPPORTED_BACKEND	Unsupported render backend.
VU_ENGINE_CREATION_ERROR_RENDER_CONFIG_FAILED_TO_SET_VIDEO_BG_VIEWPORT	Failed to set video background viewport.

VuRenderVBBackendType

enum VuRenderVBBackendType : int32_t

Render video background backend configuration.

Enumerator
VU_RENDER_VB_BACKEND_DEFAULT	Select default rendering backend for each platform. Currently: Android: OpenGL ES 3.x iOS: Metal UWP: DirectX 11 This is the default video background configuration.
VU_RENDER_VB_BACKEND_HEADLESS	Deactivate usage of video background rendering support. Note: if this is set you won't be able to turn it back later.
VU_RENDER_VB_BACKEND_GLES3	OpenGL ES 3.x.
VU_RENDER_VB_BACKEND_DX11	DirectX 11.
VU_RENDER_VB_BACKEND_METAL	Metal.

VuVideoBackgroundViewportMode

enum VuVideoBackgroundViewportMode : int32_t

Supported video background viewport modes.

Enumerator
VU_VIDEOBG_VIEWPORT_MODE_SCALE_TO_FILL	Fill mode with aspect ratio (can crop or stretch the view). This is the default.
VU_VIDEOBG_VIEWPORT_MODE_SCALE_TO_FIT	Letter box mode with aspect ratio (will add black band around the image)
VU_VIDEOBG_VIEWPORT_MODE_NATIVE_VIDEO	Use native video mode, don't apply any aspect ratio compensation.

Function Documentation

vuRenderConfigDefault()

VuRenderConfig vuRenderConfigDefault

(

)

Default render configuration.

Note

Use this function to initialize the VuRenderConfig data structure with default values.