kzu_layer_render_pass.h File Reference

Specifies a layer render pass. More...

#include "kzu_composer_base.h"
#include <user/resource/kzu_resource_common.h>
#include <core/util/math/kzc_vector2.h>
#include <system/debug/kzs_error.h>
#include <system/kzs_header.h>

Functions
kzsError	kzuLayerRenderPassCreate (const struct KzuUIDomain *uiDomain, kzString name, struct KzuLayerRenderPass **out_layerRenderPass)
	Creates a layer render pass. More...
kzsError	kzuLayerRenderPassDelete (struct KzuComposer *layerRenderPassComposer)
	Deletes layer render pass. More...
struct KzuLayerRenderPass *	kzuLayerRenderPassFromComposer (const struct KzuComposer *composer)
	Cast into layer render pass from composer. More...
struct KzuComposer *	kzuLayerRenderPassToComposer (const struct KzuLayerRenderPass *layerRenderPass)
	Cast layer render pass into composer. More...
void	kzuLayerRenderPassSetRenderingArea (struct KzuLayerRenderPass *layerRenderPass, kzFloat offsetX, kzFloat offsetY, kzFloat sizeX, kzFloat sizeY, const struct KzuCanvas *canvas)
	Set layer rendering area. More...
struct KzuComposer *	kzuLayerRenderPassGetDebugComposer (const struct KzuLayerRenderPass *layerRenderPass)
	Get debug composer. More...
void	kzuLayerRenderPassSetDebugComposer (struct KzuLayerRenderPass *layerRenderPass, struct KzuComposer *debugComposer)
	Set debug composer. More...
struct KzcVector2	kzuLayerRenderPassGetLimits (const struct KzuLayerRenderPass *layerRenderPass)
	Get layer rendering limits. More...
struct KzcVector2	kzuLayerRenderPassGetOffset (const struct KzuLayerRenderPass *layerRenderPass)
	Get layer rendering offset. More...
kzsError	kzuLayerRenderPassApply (struct KzuComposer *layerRenderPassComposer, struct KzuRenderer *renderer, const struct KzuTransformedScene *transformedScene, struct KzuRenderContextStack *renderContextStack)
	Applies a render pass for rendering. More...

Variables
KZ_HEADER_BEGIN const KzuResourceType	KZU_COMPOSER_TYPE_LAYER_RENDER_PASS
	Composer type identifier for layer render pass. More...
struct KzuComposerClass	KZU_COMPOSER_LAYER_RENDER_PASS_CLASS
	Composer class for layer render pass. More...

Detailed Description

Specifies a layer render pass.

Layer render pass is used to render layers, rendering individual scenes still uses their individual render passes.

Copyright 2008-2019 by Rightware. All rights reserved.

Function Documentation

kzsError kzuLayerRenderPassCreate	(	const struct KzuUIDomain *	uiDomain,
		kzString	name,
		struct KzuLayerRenderPass **	out_layerRenderPass
	)

Creates a layer render pass.

kzsError kzuLayerRenderPassDelete

(

struct KzuComposer *

layerRenderPassComposer)

Deletes layer render pass.

struct KzuLayerRenderPass* kzuLayerRenderPassFromComposer

(

const struct KzuComposer *

composer)

Cast into layer render pass from composer.

struct KzuComposer* kzuLayerRenderPassToComposer

(

const struct KzuLayerRenderPass *

layerRenderPass)

Cast layer render pass into composer.

void kzuLayerRenderPassSetRenderingArea	(	struct KzuLayerRenderPass *	layerRenderPass,
		kzFloat	offsetX,
		kzFloat	offsetY,
		kzFloat	sizeX,
		kzFloat	sizeY,
		const struct KzuCanvas *	canvas
	)

Set layer rendering area.

struct KzuComposer* kzuLayerRenderPassGetDebugComposer

(

const struct KzuLayerRenderPass *

layerRenderPass)

Get debug composer.

void kzuLayerRenderPassSetDebugComposer	(	struct KzuLayerRenderPass *	layerRenderPass,
		struct KzuComposer *	debugComposer
	)

Set debug composer.

Layer render pass will not own the debug composer.

struct KzcVector2 kzuLayerRenderPassGetLimits

(

const struct KzuLayerRenderPass *

layerRenderPass)

Get layer rendering limits.

struct KzcVector2 kzuLayerRenderPassGetOffset

(

const struct KzuLayerRenderPass *

layerRenderPass)

Get layer rendering offset.

kzsError kzuLayerRenderPassApply	(	struct KzuComposer *	layerRenderPassComposer,
		struct KzuRenderer *	renderer,
		const struct KzuTransformedScene *	transformedScene,
		struct KzuRenderContextStack *	renderContextStack
	)

Applies a render pass for rendering.

Variable Documentation

KZ_HEADER_BEGIN const KzuResourceType KZU_COMPOSER_TYPE_LAYER_RENDER_PASS

Composer type identifier for layer render pass.

struct KzuComposerClass KZU_COMPOSER_LAYER_RENDER_PASS_CLASS

Composer class for layer render pass.