kzu_composer.h File Reference

Specifies a composer structure, which is set of render passes that are processed in order. More...

#include <user/resource/kzu_resource_common.h>
#include <core/util/collection/kzc_dynamic_array.h>
#include <system/kzs_types.h>
#include <system/debug/kzs_error.h>
#include <system/kzs_header.h>

Functions
kzsError	kzuComposerDelete (const struct KzuComposer *composer)
	Deletes a composer. More...
kzsError	kzuComposerLoadFromKZB (const struct KzuComposer *composer, struct KzcInputStream *inputStream, const struct KzuBinaryFileInfo *file)
	Loads composer from KZB. More...
kzsError	kzuComposerInitialize (struct KzuComposer *composer)
	Initializes a composer. More...
kzsError	kzuComposerUninitialize (struct KzuComposer *composer)
	Uninitializes a composer. More...
KzuResourceType	kzuComposerGetType (const struct KzuComposer *composer)
	Returns composer's type. More...
struct KzuPropertyManager *	kzuComposerGetPropertyManager (const struct KzuComposer *composer)
	Get the property manager of a composer. More...
kzsError	kzuComposerAddChild (const struct KzuComposer *composer, const struct KzuComposer *childComposer)
	Adds a child to composer. More...
kzsError	kzuComposerAddChildAtIndex (const struct KzuComposer *composer, kzUint index, const struct KzuComposer *childComposer)
	Add child composer at given index in parent. More...
kzsError	kzuComposerRemoveChild (const struct KzuComposer *composer, const struct KzuComposer *childComposer)
	Removes a child from composer. More...
struct KzcDynamicArrayIterator	kzuComposerGetChildren (const struct KzuComposer *composer)
	Gets render passes from composer. More...
kzsError	kzuComposerRemoveAllChildren (const struct KzuComposer *composer)
	Removes all children from composer. More...
struct KzuComposer *	kzuComposerGetChildComposer (const struct KzuComposer *composer, kzUint index)
	Gets a child composer from composer at given index. More...
kzUint	kzuComposerGetChildCount (const struct KzuComposer *composer)
	Returns the amount of render passes in composer. More...
kzsError	kzuComposerApply (struct KzuComposer *composer, struct KzuRenderer *renderer, const struct KzuTransformedScene *transformedScene, struct KzuRenderContextStack *renderContextStack)
	Applies a composer for rendering. More...
kzMutableString	kzuComposerGetName (const struct KzuComposer *composer)
	Gets composer's name. More...
kzsError	kzuComposerSetRenderTarget (struct KzuComposer *composer, struct KzuRenderTarget *renderTarget)
	Sets render target for composer. More...
struct KzuRenderTarget *	kzuComposerGetRenderTarget (const struct KzuComposer *composer)
	Gets render target from composer, KZ_NULL for screen. More...
void	kzuComposerSetPropertyManager (struct KzuComposer *composer, struct KzuPropertyManager *propertyManager)
	Sets property manager for composer. More...
struct KzuResource *	kzuComposerToResource (const struct KzuComposer *composer)
	Converts composer to resource. More...
struct KzuComposer *	kzuComposerFromResource (const struct KzuResource *resource)
	Converts composer from resource. More...
struct KzuComposer *	kzuComposerCastFromResource (const struct KzuResource *resource)
	Casts composer from resource, KZ_NULL if invalid type. More...

Variables
const KzuResourceType	KZU_RESOURCE_TYPE_COMPOSER
	Resource type identifier for composer. More...

Detailed Description

Specifies a composer structure, which is set of render passes that are processed in order.

Copyright 2008-2019 by Rightware. All rights reserved.

Function Documentation

kzsError kzuComposerDelete

(

const struct KzuComposer *

composer)

Deletes a composer.

kzsError kzuComposerLoadFromKZB	(	const struct KzuComposer *	composer,
		struct KzcInputStream *	inputStream,
		const struct KzuBinaryFileInfo *	file
	)

Loads composer from KZB.

kzsError kzuComposerInitialize

(

struct KzuComposer *

composer)

Initializes a composer.

kzsError kzuComposerUninitialize

(

struct KzuComposer *

composer)

Uninitializes a composer.

KzuResourceType kzuComposerGetType

(

const struct KzuComposer *

composer)

Returns composer's type.

struct KzuPropertyManager* kzuComposerGetPropertyManager

(

const struct KzuComposer *

composer)

Get the property manager of a composer.

kzsError kzuComposerAddChild	(	const struct KzuComposer *	composer,
		const struct KzuComposer *	childComposer
	)

Adds a child to composer.

kzsError kzuComposerAddChildAtIndex	(	const struct KzuComposer *	composer,
		kzUint	index,
		const struct KzuComposer *	childComposer
	)

Add child composer at given index in parent.

kzsError kzuComposerRemoveChild	(	const struct KzuComposer *	composer,
		const struct KzuComposer *	childComposer
	)

Removes a child from composer.

struct KzcDynamicArrayIterator kzuComposerGetChildren

(

const struct KzuComposer *

composer)

Gets render passes from composer.

kzsError kzuComposerRemoveAllChildren

(

const struct KzuComposer *

composer)

Removes all children from composer.

struct KzuComposer* kzuComposerGetChildComposer	(	const struct KzuComposer *	composer,
		kzUint	index
	)

Gets a child composer from composer at given index.

If index is out of range KZ_NULL is returned.

kzUint kzuComposerGetChildCount

(

const struct KzuComposer *

composer)

Returns the amount of render passes in composer.

kzsError kzuComposerApply	(	struct KzuComposer *	composer,
		struct KzuRenderer *	renderer,
		const struct KzuTransformedScene *	transformedScene,
		struct KzuRenderContextStack *	renderContextStack
	)

Applies a composer for rendering.

kzMutableString kzuComposerGetName

(

const struct KzuComposer *

composer)

Gets composer's name.

kzsError kzuComposerSetRenderTarget	(	struct KzuComposer *	composer,
		struct KzuRenderTarget *	renderTarget
	)

Sets render target for composer.

KZ_NULL for screen.

struct KzuRenderTarget* kzuComposerGetRenderTarget

(

const struct KzuComposer *

composer)

Gets render target from composer, KZ_NULL for screen.

void kzuComposerSetPropertyManager	(	struct KzuComposer *	composer,
		struct KzuPropertyManager *	propertyManager
	)

Sets property manager for composer.

Warning: This function is deprecated and will be removed in future release.

struct KzuResource* kzuComposerToResource

(

const struct KzuComposer *

composer)

Converts composer to resource.

struct KzuComposer* kzuComposerFromResource

(

const struct KzuResource *

resource)

Converts composer from resource.

struct KzuComposer* kzuComposerCastFromResource

(

const struct KzuResource *

resource)

Casts composer from resource, KZ_NULL if invalid type.

Variable Documentation

const KzuResourceType KZU_RESOURCE_TYPE_COMPOSER

Resource type identifier for composer.