kzu_cubemap_composer.h File Reference

Specifies a composer which renders to a dynamic cubemap. More...

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

Functions
kzsError	kzuCubemapComposerRegisterToFactory (const struct KzuFactory *factory)
	Registers cubemap composer to factory. More...
kzsError	kzuCubemapComposerCreate (const struct KzcMemoryManager *memoryManager, kzString name, struct KzuUIDomain *uiDomain, struct KzuCubemapComposer **out_cubemapComposer)
	Creates new cubemap composer. More...
struct KzuComposer *	kzuCubemapComposerToComposer (struct KzuCubemapComposer *composer)
	Casts cubemap composer to composer. More...
struct KzuCubemapComposer *	kzuCubemapComposerFromComposer (const struct KzuComposer *composer)
	Casts composer to cubemap composer. More...
struct KzuCubemapRenderTargetTexture *	kzuCubemapComposerGetTexture (const struct KzuComposer *composer)
	Returns the rendertarget cubemap texture from composer. More...
kzsError	kzuCubemapComposerAttachToViewerNode (const struct KzuComposer *composer, struct KzuObjectNode *viewerNode)
	Attaches cubemap composer to viewer node. More...
kzsError	kzuCubemapComposerDetachFromViewerNode (const struct KzuComposer *composer, struct KzuObjectNode *viewerNode)
	Detaches cubemap composer from viewer node. More...

Variables
const KzuResourceType	KZU_COMPOSER_TYPE_CUBEMAP
	Composer type identifier for cubemap composer. More...

Detailed Description

Specifies a composer which renders to a dynamic cubemap.

Copyright 2008-2019 by Rightware. All rights reserved.

Function Documentation

kzsError kzuCubemapComposerRegisterToFactory

(

const struct KzuFactory *

factory)

Registers cubemap composer to factory.

kzsError kzuCubemapComposerCreate	(	const struct KzcMemoryManager *	memoryManager,
		kzString	name,
		struct KzuUIDomain *	uiDomain,
		struct KzuCubemapComposer **	out_cubemapComposer
	)

Creates new cubemap composer.

struct KzuComposer* kzuCubemapComposerToComposer

(

struct KzuCubemapComposer *

composer)

Casts cubemap composer to composer.

struct KzuCubemapComposer* kzuCubemapComposerFromComposer

(

const struct KzuComposer *

composer)

Casts composer to cubemap composer.

struct KzuCubemapRenderTargetTexture* kzuCubemapComposerGetTexture

(

const struct KzuComposer *

composer)

Returns the rendertarget cubemap texture from composer.

kzsError kzuCubemapComposerAttachToViewerNode	(	const struct KzuComposer *	composer,
		struct KzuObjectNode *	viewerNode
	)

Attaches cubemap composer to viewer node.

kzsError kzuCubemapComposerDetachFromViewerNode	(	const struct KzuComposer *	composer,
		struct KzuObjectNode *	viewerNode
	)

Detaches cubemap composer from viewer node.

Variable Documentation

const KzuResourceType KZU_COMPOSER_TYPE_CUBEMAP

Composer type identifier for cubemap composer.