Render Controller

Classes
struct	VuRenderViewConfig
	configure the current view More...
struct	VuVideoBackgroundViewInfo
	Video background view information. More...
struct	VuRenderVideoBackgroundData
	Video background texture input. More...

Typedefs
typedef struct VuRenderViewConfig	VuRenderViewConfig
	configure the current view
typedef struct VuVideoBackgroundViewInfo	VuVideoBackgroundViewInfo
	Video background view information.
typedef struct VuRenderVideoBackgroundData	VuRenderVideoBackgroundData
	Video background texture input.

Functions
VuResult	vuEngineGetRenderController (const VuEngine *engine, VuController **controller)
	Retrieve Render Controller to get access to rendering-specific functionality in Engine.
VuResult	vuRenderControllerSetRenderViewConfig (VuController *controller, const VuRenderViewConfig *renderViewConfig)
	Set the current render view configuration. More...
VuResult	vuRenderControllerGetRenderViewConfig (const VuController *controller, VuRenderViewConfig *renderViewConfig)
	Get the current render view configuration. More...
VuResult	vuRenderControllerGetVideoBackgroundViewport (const VuController *controller, VuVector4I *vbViewport)
	Get the video background viewport (its location/size on screen) More...
VuResult	vuRenderControllerSetVideoBackgroundViewport (VuController *controller, const VuVector4I *vbViewport)
	Configure the video background viewport (its location/size on screen) More...
VuResult	vuRenderControllerSetVideoBackgroundViewportMode (VuController *controller, VuVideoBackgroundViewportMode vbMode)
	Configure the video background viewport mode. More...
VuResult	vuRenderControllerGetVideoBackgroundViewInfo (const VuController *controller, VuVideoBackgroundViewInfo *viewInfo)
	Get video background view information for rendering view background. More...
VuResult	vuRenderControllerUpdateVideoBackgroundTexture (VuController *controller, const VuState *state, const VuRenderVideoBackgroundData *renderVBData)
	Update the texture data to use for rendering the video background.
VuResult	vuRenderControllerSetProjectionMatrixNearFar (VuController *controller, float nearPlane, float farPlane)
	Set the values for the near and far plane used by Engine for calculating the projection matrix. More...
VuResult	vuRenderControllerGetProjectionMatrixNearFar (const VuController *controller, float *nearPlane, float *farPlane)
	Get the values of the near and far planes currently used by Engine for calculating the projection matrix. More...

Detailed Description

This controller allows you to control the rendering functionalities of the Vuforia SDK include video background configuration.

Function Documentation

vuRenderControllerSetRenderViewConfig()

VuResult vuRenderControllerSetRenderViewConfig	(	VuController *	controller,
		const VuRenderViewConfig *	renderViewConfig
	)

Set the current render view configuration.

Note

On some devices a default, full screen, render view configuration can be determined by Engine during creation. If the device does not provide the necessary information, no default render view configuration will be set and the Application must call this method explicitly. You can use vuRenderControllerGetRenderViewConfig after Engine creation to determine if a default render view configuration was set.

The default, full screen, render view configuration is setup as landscape orientation only, independent of the actual interface orientation at Engine creation time. If the actual interface orientation is different from landscape at Engine creation time, then vuRenderControllerSetRenderViewConfig should be called immediately after Engine has been created.

An updated configuration must be provided every time there are changes to the render view, e.g. when the interface rotation changes.

Returns

VU_SUCCESS if the render view information was set successfully, VU_FAILED if the render view information could not be set

vuRenderControllerGetRenderViewConfig()

VuResult vuRenderControllerGetRenderViewConfig	(	const VuController *	controller,
		VuRenderViewConfig *	renderViewConfig
	)

Get the current render view configuration.

Note

This call will fail if no render view config is set. See vuRenderControllerSetRenderViewConfig for more details.

Returns

VU_SUCCESS on success, or VU_FAILED if no render view config is set

vuRenderControllerGetVideoBackgroundViewport()

VuResult vuRenderControllerGetVideoBackgroundViewport	(	const VuController *	controller,
		VuVector4I *	vbViewport
	)

Get the video background viewport (its location/size on screen)

Vuforia Engine will calculate a viewport internally after Vuforia Engine has been started and a render view config has been set.

If a custom viewport has NOT been set via vuRenderControllerSetVideoBackgroundViewport, Vuforia will calculate a viewport based on the render view config and the current VuVideoBackgroundViewportMode.

If a custom viewport has been set via vuRenderControllerSetVideoBackgroundViewport, Vuforia will calculate a viewport based on the render view config and the custom viewport.

The calculated viewport is only available if Engine is running. If no calculated viewport is available, Vuforia Engine will return the viewport set via vuRenderControllerSetVideoBackgroundViewport.

If no viewport is available at all because Vuforia Engine is not running and no viewport has been set via vuRenderControllerSetVideoBackgroundViewport, this call will fail.

Returns

VU_SUCCESS on success, VU_FAILED if no viewport is available

vuRenderControllerSetVideoBackgroundViewport()

VuResult vuRenderControllerSetVideoBackgroundViewport	(	VuController *	controller,
		const VuVector4I *	vbViewport
	)

Configure the video background viewport (its location/size on screen)

Note

This call will fail if no render view config is set. See vuRenderControllerSetRenderViewConfig for more details.

The last viewport configuration applied with either vuRenderControllerSetVideoBackgroundViewport or vuRenderControllerSetVideoBackgroundViewportMode will override any previously set viewport

vuRenderControllerSetVideoBackgroundViewportMode()

VuResult vuRenderControllerSetVideoBackgroundViewportMode	(	VuController *	controller,
		VuVideoBackgroundViewportMode	vbMode
	)

Configure the video background viewport mode.

Note

This call will fail if no render view config is set. See vuRenderControllerSetRenderViewConfig for more details.

The video backround viewport mode may also be specified on Engine creation via the VuRenderConfig. See the documentation of VuRenderConfig for more details.

The last viewport configuration applied with either vuRenderControllerSetVideoBackgroundViewport or vuRenderControllerSetVideoBackgroundViewportMode will override any previously set viewport

vuRenderControllerGetVideoBackgroundViewInfo()

VuResult vuRenderControllerGetVideoBackgroundViewInfo	(	const VuController *	controller,
		VuVideoBackgroundViewInfo *	viewInfo
	)

Get video background view information for rendering view background.

Note

The video background view information is only available while Vuforia Engine is running. This call will fail if Engine is not running.

The video background view information will only be available when a render view config has been set. Otherwise this call will fail. See vuRenderControllerSetRenderViewConfig for more details.

Warning

The behaviour of this function will change in an upcoming release.

vuRenderControllerSetProjectionMatrixNearFar()

VuResult vuRenderControllerSetProjectionMatrixNearFar	(	VuController *	controller,
		float	nearPlane,
		float	farPlane
	)

Set the values for the near and far plane used by Engine for calculating the projection matrix.

Note

These values are used in the calculation of the projection matrix reported in the VuRenderState that is intended for augmentation rendering (field projectionMatrix).

Default values after Engine creation are 0.01f (near plane) and 100.0f (far plane).

Returns

VU_SUCCESS if the values have been set successfully, VU_FAILED if invalid values have been provided.

vuRenderControllerGetProjectionMatrixNearFar()

VuResult vuRenderControllerGetProjectionMatrixNearFar	(	const VuController *	controller,
		float *	nearPlane,
		float *	farPlane
	)

Get the values of the near and far planes currently used by Engine for calculating the projection matrix.

Returns

VU_SUCCESS on success, VU_FAILED on failure to retrive the values