kzu_shadow_map.h File Reference

Specifies a shadow map rendering utility, that is used for rendering shadows based on depth pass rendered from light. More...

#include <system/debug/kzs_error.h>
#include <system/wrappers/kzs_opengl_base.h>
#include <system/kzs_header.h>

Functions
kzsError	kzuShadowMapCreate (const struct KzcMemoryManager *memoryManager, struct KzuShadowMap **out_shadowMap)
	Creates shadow map. More...
kzsError	kzuShadowMapDelete (struct KzuShadowMap *shadowMap)
	Deletes shadow map. More...
kzsError	kzuShadowMapPrepare (struct KzuShadowMap *shadowMap, const struct KzuRenderer *renderer, kzUint width, kzUint height)
	Prepares shadow map from current renderer state. More...
kzsError	kzuShadowMapApply (struct KzuShadowMap *shadowMap, const struct KzuRenderer *renderer, const struct KzuScene *scene, kzUint index)
	Applies shadow map for rendering, on given index. More...
kzsError	kzuShadowMapDetach (const struct KzuScene *scene)
	Detaches shadow maps, so that shadow maps generated are no more used as texture properties. More...
struct KzuRenderTargetTexture *	kzuShadowMapGetShadowMapTexture (const struct KzuShadowMap *shadowMap)
	Gets shadow map texture from shadow map. More...

Detailed Description

Specifies a shadow map rendering utility, that is used for rendering shadows based on depth pass rendered from light.

Copyright 2008-2019 by Rightware. All rights reserved.

Function Documentation

kzsError kzuShadowMapCreate	(	const struct KzcMemoryManager *	memoryManager,
		struct KzuShadowMap **	out_shadowMap
	)

Creates shadow map.

kzsError kzuShadowMapDelete

(

struct KzuShadowMap *

shadowMap)

Deletes shadow map.

kzsError kzuShadowMapPrepare	(	struct KzuShadowMap *	shadowMap,
		const struct KzuRenderer *	renderer,
		kzUint	width,
		kzUint	height
	)

Prepares shadow map from current renderer state.

kzsError kzuShadowMapApply	(	struct KzuShadowMap *	shadowMap,
		const struct KzuRenderer *	renderer,
		const struct KzuScene *	scene,
		kzUint	index
	)

Applies shadow map for rendering, on given index.

Index must be < 4 or it is ignored

kzsError kzuShadowMapDetach

(

const struct KzuScene *

scene)

Detaches shadow maps, so that shadow maps generated are no more used as texture properties.

struct KzuRenderTargetTexture* kzuShadowMapGetShadowMapTexture

(

const struct KzuShadowMap *

shadowMap)

Gets shadow map texture from shadow map.