kzu_shadow_map_composer.h File Reference

Specifies a shadow map composer. 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	kzuShadowMapComposerRegisterToFactory (const struct KzuFactory *factory)
	Registers shadow map composer to factory. More...
kzsError	kzuShadowMapComposerCreate (const struct KzcMemoryManager *memoryManager, kzString name, struct KzuUIDomain *uiDomain, struct KzuShadowMapComposer **out_shadowMapComposer)
	Creates new shadow map composer. More...
kzsError	kzuShadowMapComposerAddShadowMaterialMapping (const struct KzuShadowMapComposer *shadowMapComposer, const struct KzuMaterial *originalMaterial, const struct KzuMaterial *destinationMaterial)
	Adds shadow material mapping to shadow map composer. More...
kzsError	kzuShadowMapComposerRemoveShadowMaterialMapping (const struct KzuShadowMapComposer *shadowMapComposer, const struct KzuMaterial *originalShadowMaterial)
	Removes shadow material mapping from associated material. More...
kzsError	kzuShadowMapComposerAddDepthMaterialMapping (const struct KzuShadowMapComposer *shadowMapComposer, const struct KzuMaterial *originalMaterial, const struct KzuMaterial *destinationMaterial)
	Adds depth material mapping to shadow map composer. More...
kzsError	kzuShadowMapComposerRemoveDepthMaterialMapping (const struct KzuShadowMapComposer *shadowMapComposer, const struct KzuMaterial *originalDepthMaterial)
	Removes depth material mapping from associated material. More...
struct KzuComposer *	kzuShadowMapComposerToComposer (struct KzuShadowMapComposer *composer)
	Casts shadow map composer to composer. More...
struct KzuShadowMapComposer *	kzuShadowMapComposerFromComposer (const struct KzuComposer *composer)
	Casts composer to shadow map composer. More...

Variables
const KzuResourceType	KZU_COMPOSER_TYPE_SHADOW_MAP
	Composer type identifier for shadow map. More...

Detailed Description

Specifies a shadow map composer.

Copyright 2008-2019 by Rightware. All rights reserved.

Function Documentation

kzsError kzuShadowMapComposerRegisterToFactory

(

const struct KzuFactory *

factory)

Registers shadow map composer to factory.

kzsError kzuShadowMapComposerCreate	(	const struct KzcMemoryManager *	memoryManager,
		kzString	name,
		struct KzuUIDomain *	uiDomain,
		struct KzuShadowMapComposer **	out_shadowMapComposer
	)

Creates new shadow map composer.

kzsError kzuShadowMapComposerAddShadowMaterialMapping	(	const struct KzuShadowMapComposer *	shadowMapComposer,
		const struct KzuMaterial *	originalMaterial,
		const struct KzuMaterial *	destinationMaterial
	)

Adds shadow material mapping to shadow map composer.

When original material is the one that receives shadow in rendering, it's replaced with destination material. If original material is already assigned with mapping, new value will override it.

kzsError kzuShadowMapComposerRemoveShadowMaterialMapping	(	const struct KzuShadowMapComposer *	shadowMapComposer,
		const struct KzuMaterial *	originalShadowMaterial
	)

Removes shadow material mapping from associated material.

Nothing is done if no mapping is found.

kzsError kzuShadowMapComposerAddDepthMaterialMapping	(	const struct KzuShadowMapComposer *	shadowMapComposer,
		const struct KzuMaterial *	originalMaterial,
		const struct KzuMaterial *	destinationMaterial
	)

Adds depth material mapping to shadow map composer.

When original material is the one that is used in shadow casters' depth pass, it's replaced with destination material. If original material is already assigned with mapping, new value will override it.

kzsError kzuShadowMapComposerRemoveDepthMaterialMapping	(	const struct KzuShadowMapComposer *	shadowMapComposer,
		const struct KzuMaterial *	originalDepthMaterial
	)

Removes depth material mapping from associated material.

Nothing is done if no mapping is found.

struct KzuComposer* kzuShadowMapComposerToComposer

(

struct KzuShadowMapComposer *

composer)

Casts shadow map composer to composer.

struct KzuShadowMapComposer* kzuShadowMapComposerFromComposer

(

const struct KzuComposer *

composer)

Casts composer to shadow map composer.

Variable Documentation

const KzuResourceType KZU_COMPOSER_TYPE_SHADOW_MAP

Composer type identifier for shadow map.