kzu_partial_rendering_layer.h File Reference

Partial rendering layer. More...

#include <user/scene_graph/kzu_object_base.h>

Enumerations
enum	KzuPartialRenderingDebugVisualization { KZU_PARTIAL_RENDERING_DEBUG_VISUALIZATION_NONE, KZU_PARTIAL_RENDERING_DEBUG_VISUALIZATION_STENCILS, KZU_PARTIAL_RENDERING_DEBUG_VISUALIZATION_COLOR_BUFFER_CHANGES }
	Partial rendering debug visualizations. More...

Functions
struct KzuPartialRenderingLayer *	kzuPartialRenderingLayerFromLayer (const struct KzuLayer *layer)
	Convert layer to partial rendering layer layer. More...
struct KzuLayer *	kzuPartialRenderingLayerToLayer (const struct KzuPartialRenderingLayer *partialRenderingLayer)
	Convert partial rendering layer to layer. More...
kzBool	kzuLayerIsPartialRenderingLayer (const struct KzuLayer *layer)
	Tells if specified layer is partial rendering layer. More...
kzsError	kzuPartialRenderingLayerCreate (const struct KzcMemoryManager *memoryManager, kzString name, struct KzuUIDomain *uiDomain, struct KzuPartialRenderingLayer **out_partialRenderingLayer)
	Create a partial rendering layer. More...
kzsError	kzuPartialRenderingLayerRegisterToFactory (const struct KzuFactory *factory)
	Register partial rendering layer to the factory. More...
kzsError	kzuPartialRenderingLayerRefresh (struct KzuPartialRenderingLayer *partialRenderingLayer)
	Invalidate all current partial rendering data and start over. More...
void	kzuPartialRenderingLayerSetContentOnly (struct KzuPartialRenderingLayer *partialLayer)
	Turn on 'only content changed -flag. More...

Variables
const KzuObjectType	KZU_OBJECT_TYPE_PARTIAL_RENDERING_LAYER
	Object type identifier for partial rendering layers. More...

Detailed Description

Partial rendering layer.

Extension on viewport layer rendering.

Copyright 2008-2019 by Rightware. All rights reserved.

Enumeration Type Documentation

enum KzuPartialRenderingDebugVisualization

Partial rendering debug visualizations.

Enumerator
KZU_PARTIAL_RENDERING_DEBUG_VISUALIZATION_NONE
KZU_PARTIAL_RENDERING_DEBUG_VISUALIZATION_STENCILS
KZU_PARTIAL_RENDERING_DEBUG_VISUALIZATION_COLOR_BUFFER_CHANGES

Function Documentation

struct KzuPartialRenderingLayer* kzuPartialRenderingLayerFromLayer

(

const struct KzuLayer *

layer)

Convert layer to partial rendering layer layer.

struct KzuLayer* kzuPartialRenderingLayerToLayer

(

const struct KzuPartialRenderingLayer *

partialRenderingLayer)

Convert partial rendering layer to layer.

kzBool kzuLayerIsPartialRenderingLayer

(

const struct KzuLayer *

layer)

Tells if specified layer is partial rendering layer.

kzsError kzuPartialRenderingLayerCreate	(	const struct KzcMemoryManager *	memoryManager,
		kzString	name,
		struct KzuUIDomain *	uiDomain,
		struct KzuPartialRenderingLayer **	out_partialRenderingLayer
	)

Create a partial rendering layer.

kzsError kzuPartialRenderingLayerRegisterToFactory

(

const struct KzuFactory *

factory)

Register partial rendering layer to the factory.

kzsError kzuPartialRenderingLayerRefresh

(

struct KzuPartialRenderingLayer *

partialRenderingLayer)

Invalidate all current partial rendering data and start over.

void kzuPartialRenderingLayerSetContentOnly

(

struct KzuPartialRenderingLayer *

partialLayer)

Turn on 'only content changed -flag.

If this flag is on, the PR layer knows the whole layer content does not need rendering, and it's enough to only stencil the objects within the viewport.

Flagged on extract, if the layer itself was not flagged for rendering when extracting the scene.

Parameters

partialLayer

Partial rendering layer to flag.

Variable Documentation

const KzuObjectType KZU_OBJECT_TYPE_PARTIAL_RENDERING_LAYER

Object type identifier for partial rendering layers.