kzu_property_group.h File Reference

Property group. 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	kzuPropertyGroupCreate (const struct KzcMemoryManager *memoryManager, struct KzuPropertyManager *propertyManager, struct KzuResourceManager *resourceManager, kzString name, struct KzuPropertyGroup **out_propertyGroup)
	Creates new property group. More...
kzsError	kzuPropertyGroupDelete (struct KzuPropertyGroup *propertyGroup)
	Deletes property group. More...
kzsError	kzuPropertyGroupLoadFromKZB (struct KzuPropertyGroup *propertyGroup, struct KzcInputStream *inputStream, const struct KzuBinaryFileInfo *file)
	Loads property group from KZB. More...
void	kzuPropertyGroupSetOverrideEnabled (struct KzuPropertyGroup *propertyGroup, kzBool enabled)
	Sets property override enabled or disabled. More...
kzBool	kzuPropertyGroupIsOverrideEnabled (const struct KzuPropertyGroup *propertyGroup)
	Returns is property override enabled or not. More...
void	kzuPropertyGroupSetPropertyManager (struct KzuPropertyGroup *propertyGroup, struct KzuPropertyManager *propertyManager)
	Sets property manager to property group. More...
struct KzuResource *	kzuPropertyGroupToResource (const struct KzuPropertyGroup *propertyGroup)
	Converts state manager to resource. More...
struct KzuPropertyGroup *	kzuPropertyGroupFromResource (const struct KzuResource *resource)
	Converts state manager from resource. More...
struct KzuPropertyGroup *	kzuPropertyGroupCastFromResource (const struct KzuResource *resource)
	Casts state manager from resource, KZ_NULL if invalid type. More...

Variables
const KzuResourceType	KZU_RESOURCE_TYPE_PROPERTY_GROUP
	Resource type identifier for property group. More...

Detailed Description

Property group.

Group object that contains set of objects, materials, render passes and scenes, and properties for them.

Copyright 2008-2019 by Rightware. All rights reserved.

Function Documentation

kzsError kzuPropertyGroupCreate	(	const struct KzcMemoryManager *	memoryManager,
		struct KzuPropertyManager *	propertyManager,
		struct KzuResourceManager *	resourceManager,
		kzString	name,
		struct KzuPropertyGroup **	out_propertyGroup
	)

Creates new property group.

kzsError kzuPropertyGroupDelete

(

struct KzuPropertyGroup *

propertyGroup)

Deletes property group.

kzsError kzuPropertyGroupLoadFromKZB	(	struct KzuPropertyGroup *	propertyGroup,
		struct KzcInputStream *	inputStream,
		const struct KzuBinaryFileInfo *	file
	)

Loads property group from KZB.

void kzuPropertyGroupSetOverrideEnabled	(	struct KzuPropertyGroup *	propertyGroup,
		kzBool	enabled
	)

Sets property override enabled or disabled.

kzBool kzuPropertyGroupIsOverrideEnabled

(

const struct KzuPropertyGroup *

propertyGroup)

Returns is property override enabled or not.

void kzuPropertyGroupSetPropertyManager	(	struct KzuPropertyGroup *	propertyGroup,
		struct KzuPropertyManager *	propertyManager
	)

Sets property manager to property group.

For internal use only.

struct KzuResource* kzuPropertyGroupToResource

(

const struct KzuPropertyGroup *

propertyGroup)

Converts state manager to resource.

struct KzuPropertyGroup* kzuPropertyGroupFromResource

(

const struct KzuResource *

resource)

Converts state manager from resource.

struct KzuPropertyGroup* kzuPropertyGroupCastFromResource

(

const struct KzuResource *

resource)

Casts state manager from resource, KZ_NULL if invalid type.

Variable Documentation

const KzuResourceType KZU_RESOURCE_TYPE_PROPERTY_GROUP

Resource type identifier for property group.