kzu_portal_layer.h File Reference

Portal layer class. More...

#include <user/scene_graph/kzu_object_base.h>

Functions
struct KzuPortalLayer *	kzuPortalLayerFromLayer (const struct KzuLayer *layer)
	Convert layer to portal layer. More...
struct KzuLayer *	kzuPortalLayerToLayer (const struct KzuPortalLayer *portalLayer)
	Convert portal layer to layer. More...
kzBool	kzuLayerIsPortal (const struct KzuLayer *layer)
	Tell if a layer is a portal layer. More...
kzBool	kzuObjectNodeIsPortalLayer (const struct KzuObjectNode *objectNode)
	Tell if an object node is a portal layer. More...
kzsError	kzuPortalLayerCreate (const struct KzcMemoryManager *memoryManager, kzString name, struct KzuUIDomain *uiDomain, struct KzuPortalLayer **out_portalLayer)
	Create a portal layer. More...
kzsError	kzuPortalLayerRegisterToFactory (const struct KzuFactory *factory)
	Register portal layer to the factory. More...
struct KzuScene *	kzuPortalLayerGetScene (const struct KzuPortalLayer *portalLayer)
	Get the scene associated with this portal layer. More...

Variables
const KzuObjectType	KZU_OBJECT_TYPE_PORTAL_LAYER
	Object type for portal layers. More...

Detailed Description

Portal layer class.

Copyright 2008-2019 by Rightware. All rights reserved.

Function Documentation

struct KzuPortalLayer* kzuPortalLayerFromLayer

(

const struct KzuLayer *

layer)

Convert layer to portal layer.

struct KzuLayer* kzuPortalLayerToLayer

(

const struct KzuPortalLayer *

portalLayer)

Convert portal layer to layer.

kzBool kzuLayerIsPortal

(

const struct KzuLayer *

layer)

Tell if a layer is a portal layer.

kzBool kzuObjectNodeIsPortalLayer

(

const struct KzuObjectNode *

objectNode)

Tell if an object node is a portal layer.

kzsError kzuPortalLayerCreate	(	const struct KzcMemoryManager *	memoryManager,
		kzString	name,
		struct KzuUIDomain *	uiDomain,
		struct KzuPortalLayer **	out_portalLayer
	)

Create a portal layer.

kzsError kzuPortalLayerRegisterToFactory

(

const struct KzuFactory *

factory)

Register portal layer to the factory.

struct KzuScene* kzuPortalLayerGetScene

(

const struct KzuPortalLayer *

portalLayer)

Get the scene associated with this portal layer.

Variable Documentation

const KzuObjectType KZU_OBJECT_TYPE_PORTAL_LAYER

Object type for portal layers.