KzuLayer Struct Reference

Layer object. More...

#include <kzu_layer.h>

Data Fields
struct KzuObjectNode	objectNode
	Inherited from object node. More...
struct KzuLayerClass *	layerClass
	Layer class. More...
struct KzuRenderTargetTexture *	managedRenderTargets [3]
	Frame buffer texture(s) created by this layer (if needed). More...
struct KzuRenderTargetTexture *	userRenderTarget
	Forced render target (from properties). More...
struct KzuRenderTargetTexture *	cachedRenderTargetChildren
	Cached render target of the layer's children. More...
struct KzuRenderTargetTexture *	cachedRenderTargetFinal
	Combined cached render target, used when both cache self and cache children are on. More...
struct KzuRenderTargetTexture *	cachedRenderTargetSelf
	Cached render target of the layer itself. More...
struct {
struct KzuMaterial *   material
	Material. More...
struct KzuMaterial *   compositionMaterial
	Composition material. More...
struct KzuMaterial *   backgroundMaterial
	Background material. More...
}	materials
	Specifies material resources for layer. More...
struct KzuRenderTargetTexture *	renderTargetTexture
	Render target texture for the layer. More...
enum KzuLayerRenderType	renderType
	Which kind of rendering layer will provide. More...
kzBool	allowRenderChildren
	Are children rendered for this layer or are they handled in a special manner? More...
kzBool	requiresExtract
	Does the layer need extract called? More...
KzuLayerOcclusionMaskFunction	occlusionMaskFunction
	Occlusion mask function for layer, if KZ_NULL uses the default implementation for layer area quad. More...
struct KzuLayerLayoutingParameters	layouting
	Layouting parameters. More...
struct KzuLayerClippingParameters	clipping
	Clipping parameters. More...
struct KzuLayerQuadParameters	quad
	Layer quad parameters. More...
struct KzuLayerBackgroundQuadParameters	backgroundQuad
	Layer background quad parameters. More...
struct KzuLayerQuadParameters	compositionQuad
	Composition quad. More...
struct KzuLayerRenderingParameters	rendering
	Rendering parameters. More...
struct KzuBoundingVolume *	boundingVolume
	Bounding volume. More...

Detailed Description

Layer object.

Needs to inherit object node to gain property system.

Field Documentation

struct KzuObjectNode KzuLayer::objectNode

Inherited from object node.

struct KzuLayerClass* KzuLayer::layerClass

Layer class.

struct KzuRenderTargetTexture* KzuLayer::managedRenderTargets[3]

Frame buffer texture(s) created by this layer (if needed).

struct KzuRenderTargetTexture* KzuLayer::userRenderTarget

Forced render target (from properties).

struct KzuRenderTargetTexture* KzuLayer::cachedRenderTargetChildren

Cached render target of the layer's children.

struct KzuRenderTargetTexture* KzuLayer::cachedRenderTargetFinal

Combined cached render target, used when both cache self and cache children are on.

struct KzuRenderTargetTexture* KzuLayer::cachedRenderTargetSelf

Cached render target of the layer itself.

struct KzuMaterial* KzuLayer::material

Material.

struct KzuMaterial* KzuLayer::compositionMaterial

Composition material.

struct KzuMaterial* KzuLayer::backgroundMaterial

Background material.

struct { ... } KzuLayer::materials

Specifies material resources for layer.

struct KzuRenderTargetTexture* KzuLayer::renderTargetTexture

Render target texture for the layer.

enum KzuLayerRenderType KzuLayer::renderType

Which kind of rendering layer will provide.

kzBool KzuLayer::allowRenderChildren

Are children rendered for this layer or are they handled in a special manner?

kzBool KzuLayer::requiresExtract

Does the layer need extract called?

KzuLayerOcclusionMaskFunction KzuLayer::occlusionMaskFunction

Occlusion mask function for layer, if KZ_NULL uses the default implementation for layer area quad.

struct KzuLayerLayoutingParameters KzuLayer::layouting

Layouting parameters.

struct KzuLayerClippingParameters KzuLayer::clipping

Clipping parameters.

struct KzuLayerQuadParameters KzuLayer::quad

Layer quad parameters.

Combination of layouting and clipping.

struct KzuLayerBackgroundQuadParameters KzuLayer::backgroundQuad

Layer background quad parameters.

Combination of layouting and clipping.

struct KzuLayerQuadParameters KzuLayer::compositionQuad

Composition quad.

struct KzuLayerRenderingParameters KzuLayer::rendering

Rendering parameters.

struct KzuBoundingVolume* KzuLayer::boundingVolume

Bounding volume.

---

The documentation for this struct was generated from the following file:

• user/layers/kzu_layer_base.h