Layer layouting information separated onto a structure of its own. More...

#include <kzu_layer_base.h>

Data Fields
struct KzcVector2	contentDesiredSize
	Desired size from content. More...

struct KzcVector2	userDesiredSize
	Desired size modified by user width / height properties. More...

struct KzcVector2	desiredSize
	Desired size after properties, transformations and margins. More...

struct KzcVector2	desiredMin
	Minimum point of node desired size quad. More...

struct KzcVector2	desiredMax
	Maximum point of node desired size quad. More...

struct KzcVector2	allocatedSize
	Size available for this layer (from parent). More...

struct KzcVector2	actualSize
	Actual size (allocated size minus margins). More...

struct KzcVector2	compositionTargetSize
	Size limit for composition texture. More...

struct KzcMatrix3x3	layoutTransform
	Layout transform. More...

struct KzcMatrix3x3	tempLayoutTransform
	A temporary transform used to pass a partially calculated layout transform from arrange pass to transform pass. More...

struct KzcMatrix3x3	parentTransform
	Transformation in regard to parent layer, calculated during layout, used for clipping. More...

struct KzcMatrix3x3	propagateTransform
	Render quad transform passed to children. More...

struct KzcMatrix3x3	renderQuadTransform
	Transform in current render target space (same as worldTransform if rendering to screen). More...

struct KzcMatrix3x3	worldTransform
	World transform, composite of all other transforms. More...

struct KzcColorRGBA	backgroundColor
	Color for background brush. More...

struct KzuTexture *	backgroundTexture
	Texture for background brush. More...

kzUint	clippingResult
	Clipping result mask. More...

enum KzuLayerContentStretch	contentStretch
	Layer content stretch. More...

enum KzuLayerForegroundHint	foregroundHint
	Layer foreground hint. More...

enum KzuLayerRenderTargetOverride	renderTargetOverride
	Render target override. More...

kzUint	logicalChildCount
	Child count used for calculations of layouting logic. More...

kzFloat	opacity
	Opacity, determined during the layout phase. More...

kzFloat	propagatedOpacity
	Opacity propagated to children. More...

kzBool	allowComposingClearColor
	Allow clearing of potential composing target color channel (normally yes). More...

kzBool	allowComposingClearDepth
	Allow clearing of potential composing target depth channel (normally yes). More...

kzBool	allowRenderSelf
	Does the layer render itself? More...

kzBool	cacheChildren
	Does the layer cache its children? More...

kzBool	cacheResult
	Does the layer cache its rendering result (itself and its children). More...

kzBool	cacheSelf
	Does the layer cache itself? More...

kzBool	childrenRequireExtract
	Does the layer have children that need extract? More...

kzBool	composingRequiresAlpha
	Is alpha required for render targets? More...

kzBool	composingRequiresDepth
	Is depth required for managed render targets? More...

kzBool	foregroundRequiresAlpha
	Is alpha required for rendering the layer itself? More...

kzBool	offscreenRendering
	Should the layer only be rendered off-screen (and not flipped onto the screen). More...

kzBool	requiresBackgroundQuad
	Does the layer require a background. More...

kzBool	requiresComposingTarget
	Set during layout if this layer requires an intermediate composing target. More...

kzBool	requiresStencil
	Is stencil required in managed render targets. More...

kzBool	supportsStencil
	Is stencil for the layer supported, by default true unless creating texture failed. More...

Detailed Description

Layer layouting information separated onto a structure of its own.

Field Documentation

struct KzcVector2 KzuLayerLayoutingParameters::contentDesiredSize

Desired size from content.

struct KzcVector2 KzuLayerLayoutingParameters::userDesiredSize

Desired size modified by user width / height properties.

struct KzcVector2 KzuLayerLayoutingParameters::desiredSize

Desired size after properties, transformations and margins.

struct KzcVector2 KzuLayerLayoutingParameters::desiredMin

Minimum point of node desired size quad.

struct KzcVector2 KzuLayerLayoutingParameters::desiredMax

Maximum point of node desired size quad.

struct KzcVector2 KzuLayerLayoutingParameters::allocatedSize

Size available for this layer (from parent).

struct KzcVector2 KzuLayerLayoutingParameters::actualSize

Actual size (allocated size minus margins).

struct KzcVector2 KzuLayerLayoutingParameters::compositionTargetSize

Size limit for composition texture.

struct KzcMatrix3x3 KzuLayerLayoutingParameters::layoutTransform

Layout transform.

Set by layouts controlling the layer.

struct KzcMatrix3x3 KzuLayerLayoutingParameters::tempLayoutTransform

A temporary transform used to pass a partially calculated layout transform from arrange pass to transform pass.

struct KzcMatrix3x3 KzuLayerLayoutingParameters::parentTransform

Transformation in regard to parent layer, calculated during layout, used for clipping.

struct KzcMatrix3x3 KzuLayerLayoutingParameters::propagateTransform

Render quad transform passed to children.

struct KzcMatrix3x3 KzuLayerLayoutingParameters::renderQuadTransform

Transform in current render target space (same as worldTransform if rendering to screen).

struct KzcMatrix3x3 KzuLayerLayoutingParameters::worldTransform

World transform, composite of all other transforms.

struct KzcColorRGBA KzuLayerLayoutingParameters::backgroundColor

Color for background brush.

struct KzuTexture* KzuLayerLayoutingParameters::backgroundTexture

Texture for background brush.

kzUint KzuLayerLayoutingParameters::clippingResult

Clipping result mask.

enum KzuLayerContentStretch KzuLayerLayoutingParameters::contentStretch

Layer content stretch.

enum KzuLayerForegroundHint KzuLayerLayoutingParameters::foregroundHint

Layer foreground hint.

enum KzuLayerRenderTargetOverride KzuLayerLayoutingParameters::renderTargetOverride

Render target override.

kzUint KzuLayerLayoutingParameters::logicalChildCount

Child count used for calculations of layouting logic.

Defaults to actual child count, but can be overridden.

kzFloat KzuLayerLayoutingParameters::opacity

Opacity, determined during the layout phase.

kzFloat KzuLayerLayoutingParameters::propagatedOpacity

Opacity propagated to children.

kzBool KzuLayerLayoutingParameters::allowComposingClearColor

Allow clearing of potential composing target color channel (normally yes).

kzBool KzuLayerLayoutingParameters::allowComposingClearDepth

Allow clearing of potential composing target depth channel (normally yes).

kzBool KzuLayerLayoutingParameters::allowRenderSelf

Does the layer render itself?

kzBool KzuLayerLayoutingParameters::cacheChildren

Does the layer cache its children?

kzBool KzuLayerLayoutingParameters::cacheResult

Does the layer cache its rendering result (itself and its children).

kzBool KzuLayerLayoutingParameters::cacheSelf

Does the layer cache itself?

kzBool KzuLayerLayoutingParameters::childrenRequireExtract

Does the layer have children that need extract?

kzBool KzuLayerLayoutingParameters::composingRequiresAlpha

Is alpha required for render targets?

kzBool KzuLayerLayoutingParameters::composingRequiresDepth

Is depth required for managed render targets?

kzBool KzuLayerLayoutingParameters::foregroundRequiresAlpha

Is alpha required for rendering the layer itself?

kzBool KzuLayerLayoutingParameters::offscreenRendering

Should the layer only be rendered off-screen (and not flipped onto the screen).

kzBool KzuLayerLayoutingParameters::requiresBackgroundQuad

Does the layer require a background.

Default: yes, but may be disabled by implementations.

kzBool KzuLayerLayoutingParameters::requiresComposingTarget

Set during layout if this layer requires an intermediate composing target.

kzBool KzuLayerLayoutingParameters::requiresStencil

Is stencil required in managed render targets.

kzBool KzuLayerLayoutingParameters::supportsStencil

Is stencil for the layer supported, by default true unless creating texture failed.

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

user/layers/kzu_layer_base.h

Data Fields

Detailed Description

Field Documentation