Class Node2DMetadata

Defines properties and message types for Node2D.

Inherits properties and message types from NodeMetadata.

Property Types

See also PropertyType
Node2DMetadata.AspectRatioProperty

Determines the proportion of width and height. You cannot set both the Aspect Ratio and both, Width and Height.

Node2DMetadata.CachingModeProperty

Sets the caching mode of this node:

  • Disabled sets Kanzi to render the node and its descendants normally, without caching. This is the default.
  • Enabled sets Kanzi to cache the node and its descendants and render the node from the cache image until you invalidate the cache by disabling the Cache Valid property.
  • Automatic sets Kanzi to automatically update the cache of the node whenever the content of the node or its descendants change.
Node2DMetadata.CacheValidProperty

Indicates whether the node is cached. To disable the cache for one frame, disable this property.

Node2DMetadata.LayoutTransformationProperty

The 2D transformation to be applied before layouting.

Node2DMetadata.PerspectiveTransformationProperty

The 3D transformation to be applied after layouting.

Node2DMetadata.PerspectiveTransformationModeProperty

Defines the mode of operation for the coordinate system and field of view.

Node2DMetadata.PerspectiveTransformationFovProperty

The 3D transformation field of view (degrees) to be applied after layouting.

Node2DMetadata.PerspectiveTransformationPivotProperty

The 3D pivot point in relative coordinates.

Node2DMetadata.PerspectiveTransformationOriginProperty

The 3D transformation origin to be used for perspective transformation on this or child nodes.

Node2DMetadata.RenderTransformationOriginProperty

Sets the render transform origin in relative coordinates.

Node2DMetadata.RenderTransformationProperty

The 2D transformation to be applied after layouting.

Node2DMetadata.SnapToPixelProperty

Snap the translation of the node and its size into pixel boundary.

Node2DMetadata.BackgroundBrushProperty

The background brush to paint the background of 2D nodes.

Node2DMetadata.CompositionBrushProperty

The brush to use to compose 2D nodes to screen.

Node2DMetadata.ForegroundBrushProperty

The foreground brush to paint the foreground of 2D nodes.

Node2DMetadata.ForceCompositionProperty

Force rendering to composing target even if not otherwise necessary.

Node2DMetadata.ForegroundHintProperty

Give a hint of the type of the foreground of 2D nodes:

  • None renders the background brush after rendering the node.
  • Translucent renders the background brush before the content of the node.
  • Occluding renders the background brush.
Node2DMetadata.OffscreenRenderingProperty

When set and the node has an explicitly set render target, do not render the resulting framebuffer to screen.

Node2DMetadata.DisableRenderTargetClearProperty

Do not clear render target buffers before rendering into it even if necessary.

Node2DMetadata.PixelFormatProperty

The pixel format of the node if rendering to a texture.

Node2DMetadata.MultisampleLevelProperty

Sets the amount of multisample anti-aliasing to apply to the temporary composition targets to which Kanzi renders this node.

Node2DMetadata.RenderSelfProperty

Whether the node renders itself. Does not affect the rendering of child nodes.

Node2DMetadata.RenderTargetProperty

Forces the node to be rendered into a given render target texture. When set to "No Target", regular conditions whether node is rendered to a texture, such as opacity and rotation, are applied.

Node2DMetadata.RenderTargetMinimumWidthProperty

Sets the minimum width of implicitly generated render targets.

Node2DMetadata.RenderTargetMinimumHeightProperty

Sets the minimum height of implicitly generated render targets.

Node2DMetadata.RenderTargetReallocationLimitProperty

The change in size that triggers reallocation of a render target.

Node2DMetadata.EffectProperty

Reports the runtime effect instance that this node uses. Kanzi sets the value of this property internally when the value of the Effect Prefab property in this node changes.

Node2DMetadata.EffectPrefabProperty

The 2D Effect to use for this node.

Message Types

See also MessageType

Message Arguments

Message arguments classes define message arguments used for different message types. Each class defines a number of property types - arguments - together with getter and setter functions for them.