kzu_transformed_scene.h File Reference

Transformed scene object. More...

#include <system/debug/kzs_error.h>
#include <system/kzs_types.h>
#include <system/kzs_header.h>

Functions
kzsError	kzuTransformedSceneCreate (const struct KzcMemoryManager *memoryManager, struct KzuTransformedScene **out_scene)
	Create a new transformed scene object. More...
kzsError	kzuTransformedSceneDelete (struct KzuTransformedScene *transformedScene)
	Delete a transformed scene object. More...
kzsError	kzuTransformedSceneReset (struct KzuTransformedScene *transformedScene)
	Clear a transformed scene object. More...
kzsError	kzuTransformedSceneExtract (struct KzuTransformedScene *transformedScene, struct KzuScene *scene)
	Generates a transformed scene from a scene. More...
kzsError	kzuTransformedSceneExtractFromViewportLayer (struct KzuTransformedScene *transformedScene, const struct KzuViewportLayer *viewportLayer)
	Generates a transformed scene from a scene under a viewport layer. More...
kzsError	kzuTransformedSceneExtractFromLayer (struct KzuTransformedScene *transformedScene, const struct KzuLayer *layer)
	Generates a transformed scene from a layer. More...
struct KzuCameraNode *	kzuTransformedSceneGetCamera (const struct KzuTransformedScene *transformedScene)
	Get the camera that was determined to be used when rendering this transformed scene. More...
struct KzuComposer *	kzuTransformedSceneGetComposer (const struct KzuTransformedScene *transformedScene)
	Get the composer that was determined to be used when rendering this transformed scene. More...
struct KzuScene *	kzuTransformedSceneGetScene (const struct KzuTransformedScene *transformedScene)
	Get the scene that was used to generate the transformed scene. More...
struct KzcDynamicArray *	kzuTransformedSceneGetObjects (const struct KzuTransformedScene *transformedScene)
	Get the transformed object array KzcDynamicArray<struct KzuTransformedObjectNode*>. More...
struct KzuTransformedObjectNode *	kzuTransformedSceneGetRootNode (const struct KzuTransformedScene *transformedScene)
	Get the transformed root object node. More...
struct KzuObjectSourceRuntimeData *	kzuTransformedSceneGetObjectSourceRuntimeData (const struct KzuTransformedScene *transformedScene)
	Get the object source runtime data. More...
struct KzuTransformedObjectNode *	kzuTransformedSceneResolveHitTestCameraNode (const struct KzuTransformedScene *transformedScene)
	Get current transformed camera node. More...
void	kzuTransformedSceneSetExtractedViewCamera (struct KzuTransformedScene *transformedScene, struct KzuTransformedObjectNode *transformedObjectNode)
	Sets view camera of transformed scene. More...
struct KzuTransformedObjectNode *	kzuTransformedSceneGetExtractedViewCamera (const struct KzuTransformedScene *transformedScene)
	Gets view camera of transformed scene. More...

Detailed Description

Transformed scene object.

Transformed scene is extracted from a scene object. After extracting it holds all the data needed to perform updates and to render the scene.

Copyright 2008-2019 by Rightware. All rights reserved.

Function Documentation

kzsError kzuTransformedSceneCreate	(	const struct KzcMemoryManager *	memoryManager,
		struct KzuTransformedScene **	out_scene
	)

Create a new transformed scene object.

kzsError kzuTransformedSceneDelete

(

struct KzuTransformedScene *

transformedScene)

Delete a transformed scene object.

kzsError kzuTransformedSceneReset

(

struct KzuTransformedScene *

transformedScene)

Clear a transformed scene object.

This invalidates the transformed scene - it cannot be used for rendering afterwards.

Parameters

transformedScene

Transformed scene to reset.

kzsError kzuTransformedSceneExtract	(	struct KzuTransformedScene *	transformedScene,
		struct KzuScene *	scene
	)

Generates a transformed scene from a scene.

kzsError kzuTransformedSceneExtractFromViewportLayer	(	struct KzuTransformedScene *	transformedScene,
		const struct KzuViewportLayer *	viewportLayer
	)

Generates a transformed scene from a scene under a viewport layer.

kzsError kzuTransformedSceneExtractFromLayer	(	struct KzuTransformedScene *	transformedScene,
		const struct KzuLayer *	layer
	)

Generates a transformed scene from a layer.

struct KzuCameraNode* kzuTransformedSceneGetCamera

(

const struct KzuTransformedScene *

transformedScene)

Get the camera that was determined to be used when rendering this transformed scene.

struct KzuComposer* kzuTransformedSceneGetComposer

(

const struct KzuTransformedScene *

transformedScene)

Get the composer that was determined to be used when rendering this transformed scene.

struct KzuScene* kzuTransformedSceneGetScene

(

const struct KzuTransformedScene *

transformedScene)

Get the scene that was used to generate the transformed scene.

struct KzcDynamicArray* kzuTransformedSceneGetObjects

(

const struct KzuTransformedScene *

transformedScene)

Get the transformed object array KzcDynamicArray<struct KzuTransformedObjectNode*>.

struct KzuTransformedObjectNode* kzuTransformedSceneGetRootNode

(

const struct KzuTransformedScene *

transformedScene)

Get the transformed root object node.

struct KzuObjectSourceRuntimeData* kzuTransformedSceneGetObjectSourceRuntimeData

(

const struct KzuTransformedScene *

transformedScene)

Get the object source runtime data.

struct KzuTransformedObjectNode* kzuTransformedSceneResolveHitTestCameraNode

(

const struct KzuTransformedScene *

transformedScene)

Get current transformed camera node.

void kzuTransformedSceneSetExtractedViewCamera	(	struct KzuTransformedScene *	transformedScene,
		struct KzuTransformedObjectNode *	transformedObjectNode
	)

Sets view camera of transformed scene.

struct KzuTransformedObjectNode* kzuTransformedSceneGetExtractedViewCamera

(

const struct KzuTransformedScene *

transformedScene)

Gets view camera of transformed scene.