kzu_step_rendering_layer.h File Reference

Step rendering layer. More...

#include <user/scene_graph/kzu_object_base.h>

Functions
struct KzuStepRenderingLayer *	kzuStepRenderingLayerFromLayer (const struct KzuLayer *layer)
	Convert layer to partial rendering layer layer. More...
struct KzuLayer *	kzuStepRenderingLayerToLayer (const struct KzuStepRenderingLayer *stepRenderingLayer)
	Convert partial rendering layer to layer. More...
kzBool	kzuLayerIsStepRenderingLayer (const struct KzuLayer *layer)
	Tells if specified layer is partial rendering layer. More...
kzsError	kzuStepRenderingLayerCreate (const struct KzcMemoryManager *memoryManager, kzString name, struct KzuUIDomain *uiDomain, struct KzuStepRenderingLayer **out_stepRenderingLayer)
	Create an image layer. More...
kzsError	kzuStepRenderingLayerRegisterToFactory (const struct KzuFactory *factory)
	Register partial rendering layer layer to the factory. More...
kzBool	kzuStepRenderingLayerIsRenderingQueueEmpty (const struct KzuStepRenderingLayer *stepRenderingLayer)
	Tells if rendering queue of the layer is empty after the layer was rendered last time. More...
void	kzuStepRenderingLayerSetIsLastRenderingRound (struct KzuStepRenderingLayer *stepRenderingLayer, kzBool isLastRound)
	If set to TRUE, this flag will force layer to render all operations from current queue, flip the targets and finish rendering. More...

Variables
const KzuObjectType	KZU_OBJECT_TYPE_STEP_RENDERING_LAYER
	Object type identifier for step rendering layers. More...

Detailed Description

Step rendering layer.

Extension on viewport layer rendering, perform double-buffered rendering in steps, one render pass at a time.

Copyright 2008-2019 by Rightware. All rights reserved.

Function Documentation

struct KzuStepRenderingLayer* kzuStepRenderingLayerFromLayer

(

const struct KzuLayer *

layer)

Convert layer to partial rendering layer layer.

struct KzuLayer* kzuStepRenderingLayerToLayer

(

const struct KzuStepRenderingLayer *

stepRenderingLayer)

Convert partial rendering layer to layer.

kzBool kzuLayerIsStepRenderingLayer

(

const struct KzuLayer *

layer)

Tells if specified layer is partial rendering layer.

kzsError kzuStepRenderingLayerCreate	(	const struct KzcMemoryManager *	memoryManager,
		kzString	name,
		struct KzuUIDomain *	uiDomain,
		struct KzuStepRenderingLayer **	out_stepRenderingLayer
	)

Create an image layer.

kzsError kzuStepRenderingLayerRegisterToFactory

(

const struct KzuFactory *

factory)

Register partial rendering layer layer to the factory.

kzBool kzuStepRenderingLayerIsRenderingQueueEmpty

(

const struct KzuStepRenderingLayer *

stepRenderingLayer)

Tells if rendering queue of the layer is empty after the layer was rendered last time.

void kzuStepRenderingLayerSetIsLastRenderingRound	(	struct KzuStepRenderingLayer *	stepRenderingLayer,
		kzBool	isLastRound
	)

If set to TRUE, this flag will force layer to render all operations from current queue, flip the targets and finish rendering.

Variable Documentation

const KzuObjectType KZU_OBJECT_TYPE_STEP_RENDERING_LAYER

Object type identifier for step rendering layers.