kzu_partial_rendering_composer.h File Reference

Specifies a partial rendering 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>

Enumerations
enum	KzuPartialRenderingComposerMaskPhase {   KZU_PARTIAL_RENDERING_COMPOSER_MASK_PHASE_NONE, KZU_PARTIAL_RENDERING_COMPOSER_MASK_PHASE_INTERNAL_TRANSPARENT_CONTENT, KZU_PARTIAL_RENDERING_COMPOSER_MASK_PHASE_OCCLUSION_MASK_TRANSPARENT, KZU_PARTIAL_RENDERING_COMPOSER_MASK_PHASE_INTERNAL_OPAQUE_CONTENT,   KZU_PARTIAL_RENDERING_COMPOSER_MASK_PHASE_OCCLUSION_MASK_OPAQUE }
	Specifies list of modes where partial rendering mask can be. More...

Functions
kzsError	kzuPartialRenderingComposerRegisterToFactory (const struct KzuFactory *factory)
	Registers partial rendering composer to factory. More...
kzsError	kzuPartialRenderingComposerCreate (const struct KzcMemoryManager *memoryManager, kzString name, struct KzuUIDomain *uiDomain, struct KzuPartialRenderingComposer **out_partialRenderingComposer)
	Creates new partial rendering composer. More...
kzBool	kzuComposerIsPartialRenderingComposer (const struct KzuComposer *composer)
	Returns if composer is partial rendering composer. More...
struct KzuComposer *	kzuPartialRenderingComposerToComposer (struct KzuPartialRenderingComposer *composer)
	Casts partial rendering composer to composer. More...
struct KzuPartialRenderingComposer *	kzuPartialRenderingComposerFromComposer (const struct KzuComposer *composer)
	Casts composer to partial rendering composer. More...
struct KzcMatrix4x4	kzuPartialRenderingComposerGetPreviousCameraMatrix (const struct KzuPartialRenderingComposer *partialRenderingComposer)
	Get previous camera matrix. More...
kzBool	kzuPartialRenderingComposerGetObjectsChanged (const struct KzuPartialRenderingComposer *partialRenderingComposer)
	Tell if objects have changed for this partial rendering composer. More...
void	kzuPartialRenderingComposerSetObjectsChanged (struct KzuPartialRenderingComposer *partialRenderingComposer, kzBool objectsChanged)
	Set whether objects have been changed within the scene being rendered. More...
struct KzcHashMap *	kzuPartialRenderingComposerGetObjectsInfo (const struct KzuPartialRenderingComposer *partialRenderingComposer)
	Get object info collection. More...
void	kzuPartialRenderingComposerSetCurrentPartialRenderingLayer (struct KzuPartialRenderingComposer *partialRenderingComposer, struct KzuPartialRenderingLayer *layer)
	Sets partial rendering composer for current frame. More...
kzBool	kzuPartialRenderingComposerIsForceReset (const struct KzuPartialRenderingComposer *partialRenderingComposer)
	Is force reset set on a partial rendering composer? More...
void	kzuPartialRenderingComposerSetForceReset (struct KzuPartialRenderingComposer *partialRenderingComposer, kzBool forceReset)
	Set force reset state for a partial rendering composer. More...
void	kzuPartialRenderingComposerSetMaskRenderingPhase (struct KzuPartialRenderingComposer *partialRenderingComposer, enum KzuPartialRenderingComposerMaskPhase maskRendering)
	Sets mask rendering phase enabled for partial rendering composer. More...
void	kzuPartialRenderingComposerSetOwnerLayer_private (struct KzuPartialRenderingComposer *partialRenderingComposer, struct KzuLayer *owner)
	Sets owner (caller) layer for the partial rendering, will be reset after each render. More...

Variables
const KzuResourceType	KZU_COMPOSER_TYPE_PARTIAL_RENDERING
	Composer type identifier for partial rendering. More...

Detailed Description

Specifies a partial rendering composer.

Copyright 2008-2019 by Rightware. All rights reserved.

Enumeration Type Documentation

enum KzuPartialRenderingComposerMaskPhase

Specifies list of modes where partial rendering mask can be.

Enumerator
KZU_PARTIAL_RENDERING_COMPOSER_MASK_PHASE_NONE
KZU_PARTIAL_RENDERING_COMPOSER_MASK_PHASE_INTERNAL_TRANSPARENT_CONTENT
KZU_PARTIAL_RENDERING_COMPOSER_MASK_PHASE_OCCLUSION_MASK_TRANSPARENT
KZU_PARTIAL_RENDERING_COMPOSER_MASK_PHASE_INTERNAL_OPAQUE_CONTENT
KZU_PARTIAL_RENDERING_COMPOSER_MASK_PHASE_OCCLUSION_MASK_OPAQUE

Function Documentation

kzsError kzuPartialRenderingComposerRegisterToFactory

(

const struct KzuFactory *

factory)

Registers partial rendering composer to factory.

kzsError kzuPartialRenderingComposerCreate	(	const struct KzcMemoryManager *	memoryManager,
		kzString	name,
		struct KzuUIDomain *	uiDomain,
		struct KzuPartialRenderingComposer **	out_partialRenderingComposer
	)

Creates new partial rendering composer.

kzBool kzuComposerIsPartialRenderingComposer

(

const struct KzuComposer *

composer)

Returns if composer is partial rendering composer.

struct KzuComposer* kzuPartialRenderingComposerToComposer

(

struct KzuPartialRenderingComposer *

composer)

Casts partial rendering composer to composer.

struct KzuPartialRenderingComposer* kzuPartialRenderingComposerFromComposer

(

const struct KzuComposer *

composer)

Casts composer to partial rendering composer.

struct KzcMatrix4x4 kzuPartialRenderingComposerGetPreviousCameraMatrix

(

const struct KzuPartialRenderingComposer *

partialRenderingComposer)

Get previous camera matrix.

kzBool kzuPartialRenderingComposerGetObjectsChanged

(

const struct KzuPartialRenderingComposer *

partialRenderingComposer)

Tell if objects have changed for this partial rendering composer.

void kzuPartialRenderingComposerSetObjectsChanged	(	struct KzuPartialRenderingComposer *	partialRenderingComposer,
		kzBool	objectsChanged
	)

Set whether objects have been changed within the scene being rendered.

struct KzcHashMap* kzuPartialRenderingComposerGetObjectsInfo

(

const struct KzuPartialRenderingComposer *

partialRenderingComposer)

Get object info collection.

void kzuPartialRenderingComposerSetCurrentPartialRenderingLayer	(	struct KzuPartialRenderingComposer *	partialRenderingComposer,
		struct KzuPartialRenderingLayer *	layer
	)

Sets partial rendering composer for current frame.

kzBool kzuPartialRenderingComposerIsForceReset

(

const struct KzuPartialRenderingComposer *

partialRenderingComposer)

Is force reset set on a partial rendering composer?

void kzuPartialRenderingComposerSetForceReset	(	struct KzuPartialRenderingComposer *	partialRenderingComposer,
		kzBool	forceReset
	)

Set force reset state for a partial rendering composer.

void kzuPartialRenderingComposerSetMaskRenderingPhase	(	struct KzuPartialRenderingComposer *	partialRenderingComposer,
		enum KzuPartialRenderingComposerMaskPhase	maskRendering
	)

Sets mask rendering phase enabled for partial rendering composer.

void kzuPartialRenderingComposerSetOwnerLayer_private	(	struct KzuPartialRenderingComposer *	partialRenderingComposer,
		struct KzuLayer *	owner
	)

Sets owner (caller) layer for the partial rendering, will be reset after each render.

This is to make sure that partial rendering composer is called from partial rendering layer.

Variable Documentation

const KzuResourceType KZU_COMPOSER_TYPE_PARTIAL_RENDERING

Composer type identifier for partial rendering.