VuoSceneRenderer.h File Reference

Description

VuoSceneRenderer interface.

Copyright

Copyright © 2012–2017 Kosada Incorporated. This code may be modified and distributed under the terms of the MIT License. For more information, see http://vuo.org/license.

Typedefs
typedef void *	VuoSceneRenderer
	An object for rendering a scenegraph.

Functions
VuoSceneRenderer	VuoSceneRenderer_make (float backingScaleFactor)
	Creates a reference-counted object for rendering a scenegraph.
void	VuoSceneRenderer_regenerateProjectionMatrix (VuoSceneRenderer sceneRenderer, unsigned int width, unsigned int height)
	Using the first camera found in the scene (or VuoSceneObject_makeDefaultCamera() if there is no camera in the scene), recalculates the projection matrix based on the specified viewport width and height.
void	VuoSceneRenderer_renderToImage (VuoSceneRenderer sceneRenderer, VuoImage *image, VuoImageColorDepth imageColorDepth, VuoMultisample multisample, VuoImage *depthImage)
	Renders the scene onto image and optionally depthImage.
VuoIoSurface	VuoSceneRenderer_renderToIOSurface (VuoSceneRenderer sceneRenderer, VuoImageColorDepth imageColorDepth, VuoMultisample multisample, bool includeDepthBuffer)
	Renders the scene onto an IOSurface.
void	VuoSceneRenderer_setRootSceneObject (VuoSceneRenderer sceneRenderer, VuoSceneObject rootSceneObject)
	Changes the scenegraph to be rendered.
VuoSceneObject	VuoSceneRenderer_getRootSceneObject (VuoSceneRenderer sceneRenderer, bool *isValid)
	Returns the scenegraph to be rendered.
void	VuoSceneRenderer_setCameraName (VuoSceneRenderer sceneRenderer, VuoText cameraName, VuoBoolean useLeftCamera)
	Changes the name of the camera to look for.

Typedef Documentation

typedef void* VuoSceneRenderer

An object for rendering a scenegraph.

Function Documentation

VuoSceneObject VuoSceneRenderer_getRootSceneObject	(	VuoSceneRenderer	sr,
		bool *	isValid
	)

Returns the scenegraph to be rendered.

This function only returns valid data after VuoSceneRenderer_draw has been called.

This function may be called from any thread.

VuoSceneRenderer VuoSceneRenderer_make

(

float

backingScaleFactor

)

Creates a reference-counted object for rendering a scenegraph.

This function may be called from any thread.

void VuoSceneRenderer_regenerateProjectionMatrix	(	VuoSceneRenderer	sr,
		unsigned int	width,
		unsigned int	height
	)

Using the first camera found in the scene (or VuoSceneObject_makeDefaultCamera() if there is no camera in the scene), recalculates the projection matrix based on the specified viewport width and height.

This function may be called from any thread.

void VuoSceneRenderer_renderToImage	(	VuoSceneRenderer	sceneRenderer,
		VuoImage *	image,
		VuoImageColorDepth	imageColorDepth,
		VuoMultisample	multisample,
		VuoImage *	depthImage
	)

Renders the scene onto image and optionally depthImage.

VuoIoSurface VuoSceneRenderer_renderToIOSurface	(	VuoSceneRenderer	sceneRenderer,
		VuoImageColorDepth	imageColorDepth,
		VuoMultisample	multisample,
		bool	includeDepthBuffer
	)

Renders the scene onto an IOSurface.

void VuoSceneRenderer_setCameraName	(	VuoSceneRenderer	sr,
		VuoText	cameraName,
		VuoBoolean	useLeftCamera
	)

Changes the name of the camera to look for.

The first camera whose name contains cameraName will be rendered (next time VuoSceneRenderer_draw() is called), or, if no camera matches, VuoSceneObject_makeDefaultCamera() will be used.

If cameraName is stereoscopic, useLeftCamera selects between the left and right cameras in the stereo pair.

This function may be called from any thread.

void VuoSceneRenderer_setRootSceneObject	(	VuoSceneRenderer	sr,
		VuoSceneObject	rootSceneObject
	)

Changes the scenegraph to be rendered.

This function retains the scene, but it isn't uploaded to the GPU until you call VuoSceneRenderer_draw.

This function may be called from any thread.