kzu_material.h File Reference

Specifies material structure and its properties. More...

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

Functions
kzsError	kzuMaterialCreate (const struct KzcMemoryManager *memoryManager, struct KzuUIDomain *uiDomain, kzString name, struct KzuMaterial **out_material)
	Allocates memory and returns a new material. More...
kzsError	kzuMaterialDelete (struct KzuMaterial *material)
	Frees the memory allocated for the material. More...
kzsError	kzuMaterialLoadFromKZB (struct KzuMaterial *material, struct KzcInputStream *inputStream, const struct KzuBinaryFileInfo *file)
	Loads material from KZB. More...
kzsError	kzuMaterialCopy (const struct KzcMemoryManager *memoryManager, const struct KzuMaterial *materialToCopy, struct KzuMaterial **out_material)
	Creates a copy of given material. More...
struct KzuPropertyManager *	kzuMaterialGetPropertyManager (const struct KzuMaterial *material)
	Returns the material property manager. More...
kzString	kzuMaterialGetName (const struct KzuMaterial *material)
	Returns material name from material. More...
struct KzuShader *	kzuMaterialGetShader (const struct KzuMaterial *material)
	Returns shader from material. More...
kzsError	kzuMaterialSetShader (struct KzuMaterial *material, struct KzuShader *shader)
	Private function for setting material shader. More...
kzBool	kzuMaterialIsRenderable (const struct KzuMaterial *material)
	Returns true if material is renderable (located on GPU). More...
struct KzuResource *	kzuMaterialToResource (const struct KzuMaterial *material)
	Converts material to resource. More...
struct KzuMaterial *	kzuMaterialFromResource (const struct KzuResource *resource)
	Converts material from resource. More...
struct KzuMaterial *	kzuMaterialCastFromResource (const struct KzuResource *resource)
	Casts material from resource, KZ_NULL if invalid type. More...
void	kzuMaterialSetPropertyManager (struct KzuMaterial *material, struct KzuPropertyManager *propertyManager)
	Sets property manager to material. More...
void	kzuMaterialSetUIDomain (struct KzuMaterial *material, struct KzuUIDomain *uiDomain)
	Sets ui domain to material. More...

Variables
const KzuResourceType	KZU_RESOURCE_TYPE_MATERIAL
	Resource type identifier for material. More...

Detailed Description

Specifies material structure and its properties.

Copyright 2008-2019 by Rightware. All rights reserved.

Function Documentation

kzsError kzuMaterialCreate	(	const struct KzcMemoryManager *	memoryManager,
		struct KzuUIDomain *	uiDomain,
		kzString	name,
		struct KzuMaterial **	out_material
	)

Allocates memory and returns a new material.

kzsError kzuMaterialDelete

(

struct KzuMaterial *

material)

Frees the memory allocated for the material.

kzsError kzuMaterialLoadFromKZB	(	struct KzuMaterial *	material,
		struct KzcInputStream *	inputStream,
		const struct KzuBinaryFileInfo *	file
	)

Loads material from KZB.

kzsError kzuMaterialCopy	(	const struct KzcMemoryManager *	memoryManager,
		const struct KzuMaterial *	materialToCopy,
		struct KzuMaterial **	out_material
	)

Creates a copy of given material.

struct KzuPropertyManager* kzuMaterialGetPropertyManager

(

const struct KzuMaterial *

material)

Returns the material property manager.

kzString kzuMaterialGetName

(

const struct KzuMaterial *

material)

Returns material name from material.

struct KzuShader* kzuMaterialGetShader

(

const struct KzuMaterial *

material)

Returns shader from material.

kzsError kzuMaterialSetShader	(	struct KzuMaterial *	material,
		struct KzuShader *	shader
	)

Private function for setting material shader.

kzBool kzuMaterialIsRenderable

(

const struct KzuMaterial *

material)

Returns true if material is renderable (located on GPU).

struct KzuResource* kzuMaterialToResource

(

const struct KzuMaterial *

material)

Converts material to resource.

struct KzuMaterial* kzuMaterialFromResource

(

const struct KzuResource *

resource)

Converts material from resource.

struct KzuMaterial* kzuMaterialCastFromResource

(

const struct KzuResource *

resource)

Casts material from resource, KZ_NULL if invalid type.

void kzuMaterialSetPropertyManager	(	struct KzuMaterial *	material,
		struct KzuPropertyManager *	propertyManager
	)

Sets property manager to material.

void kzuMaterialSetUIDomain	(	struct KzuMaterial *	material,
		struct KzuUIDomain *	uiDomain
	)

Sets ui domain to material.

Variable Documentation

const KzuResourceType KZU_RESOURCE_TYPE_MATERIAL

Resource type identifier for material.