Module viewport2d

Structs§

ACTUAL_DEPTH_PROPERTY
The calculated size of the node in depth direction when used in a layout.
ACTUAL_HEIGHT_PROPERTY
The calculated height of the node when used in a layout.
ACTUAL_WIDTH_PROPERTY
The calculated width of the node when used in a layout.
ASPECT_RATIO_PROPERTY
Determines the proportion of width and height. You cannot set both the Aspect Ratio and both, Width and Height.
BACKGROUND_BRUSH_PROPERTY
The background brush to paint the background of 2D nodes.
CACHE_VALID_PROPERTY
Indicates whether the node is cached. To disable the cache for one frame, disable this property.
CACHING_MODE_PROPERTY
Sets the caching mode of this node:
CAMERA_PROPERTY
Sets which camera to use in scenes rendered by the selected Viewport 2D. If not set, Kanzi uses the camera in the scene.
CLIP_CHILDREN_PROPERTY
Sets whether to clip the child nodes of this node. Kanzi clips the child nodes whose bounding box is completely outside of the bounding box of their parent node. Use this property with layout nodes. The child nodes can use only translation transformation.
COMPOSITION_BRUSH_PROPERTY
The brush to use to compose 2D nodes to screen.
CONTENT_STRETCH_PROPERTY
Sets how the content that belongs to this node is stretched (as opposed to manipulating the actual node size).
CREATED_FROM_KZB_PROPERTY
Kanzi internally uses this property to distinguish objects like bindings and triggers created in code from objects that are loaded from a kzb file.
DEPTH_ALIGNMENT_PROPERTY
The alignment in depth direction the node should use when it resides under a layout.
DEPTH_MARGIN_PROPERTY
Sets the depth distance between this node and other nodes that are adjacent to this node in a layout.
DEPTH_PROPERTY
The size of the node in depth direction when used in a layout. Overrides the default bounds of the item.
DISABLE_RENDER_TARGET_CLEAR_PROPERTY
Do not clear render target buffers before rendering into it even if necessary.
EFFECTIVELY_ENABLED_PROPERTY
Indicates whether this node and its ancestor nodes are enabled. Use this property in state managers and bindings to observe whether a node is effectively enabled. To enable or disable a node, use the Enabled property. When a node is effectively disabled:
EFFECT_PREFAB_PROPERTY
The 2D Effect to use for this node.
EFFECT_PROPERTY
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.
ENABLED_PROPERTY
Whether this node is enabled. When you disable this property in a node, that node and its descendant nodes in the same overlay focus scope are effectively disabled. Effectively disabling a node removes that node from the focus chain and cancels all the active input manipulators.Use the Effectively Enabled property to observe whether a node is effectively enabled.
FOCUSABLE_PROPERTY
Indicates whether the node can receive focus.
FOCUSED_PROPERTY
Indicates whether the node has the key focus.
FOCUS_STATE_PROPERTY
Reports the focus state of a node:
FONT_FAMILY_PROPERTY
The font family used to render the text.
FORCE_COMPOSITION_PROPERTY
Force rendering to composing target even if not otherwise necessary.
FOREGROUND_BRUSH_PROPERTY
The foreground brush to paint the foreground of 2D nodes.
FOREGROUND_HINT_PROPERTY
Give a hint of the type of the foreground of 2D nodes:
HEIGHT_PROPERTY
The height of the node when used in a layout. Overrides the default bounds of the item.
HIT_TESTABLE_CONTAINER_PROPERTY
When enabled, Kanzi uses the layout bounds as geometry for hit testing.
HIT_TESTABLE_PROPERTY
When enabled, the node can be hit tested. Enabling Hit Testable for a 2D node enables hit testing only for that node. Enabling Hit Testable for a 3D node enables hit testing also for the child nodes. Kanzi hit tests 3D nodes using the default Camera node or the Hit Test Camera node of the active Scene node.
HIT_TEST_CAMERA_PROPERTY
Sets which hit test camera to use in scenes rendered by the selected Viewport 2D. If not set, Kanzi uses the camera in the scene.
HORIZONTAL_ALIGNMENT_PROPERTY
The alignment in horizontal direction the node should use when it resides under a layout.
HORIZONTAL_MARGIN_PROPERTY
Sets the horizontal space between this node and other nodes that are adjacent to this node in a layout.
HOVER_PROPERTY
Indicates whether a node is the foremost hit testable node under the cursor.
INode2DBase
LAYOUT_TRANSFORMATION_PROPERTY
The 2D transformation to be applied before layouting.
LOCALE_PROPERTY
The locale of the node.
MULTISAMPLE_LEVEL_PROPERTY
Sets the amount of multisample anti-aliasing to apply to the temporary composition targets to which Kanzi renders this node.
MessageSubscriptionToken
Message subscription token for nodes.
NAME_PROPERTY
Node name.
Node
Base class for Kanzi nodes.
Node2D
Node2D is the base class of 2D nodes.
Node2DChildrenIterator
NodeComponentIterator
OFFSCREEN_RENDERING_PROPERTY
When set and the node has an explicitly set render target, do not render the resulting framebuffer to screen.
OPACITY_PROPERTY
Opacity of the node.
PATH_PROPERTY
Full path to the node.
PERSPECTIVE_TRANSFORMATION_FOV_PROPERTY
The 3D transformation field of view (degrees) to be applied after layouting.
PERSPECTIVE_TRANSFORMATION_MODE_PROPERTY
Defines the mode of operation for the coordinate system and field of view.
PERSPECTIVE_TRANSFORMATION_ORIGIN_PROPERTY
The 3D transformation origin to be used for perspective transformation on this or child nodes.
PERSPECTIVE_TRANSFORMATION_PIVOT_PROPERTY
The 3D pivot point in relative coordinates.
PERSPECTIVE_TRANSFORMATION_PROPERTY
The 3D transformation to be applied after layouting.
PIXEL_FORMAT_PROPERTY
The pixel format of the node if rendering to a texture.
PROJECTION_2D_TO_3D_SCALE_PROPERTY
Sets the scale factor to project pixels to 3D size. When scale is 1, then the size of one pixel is one 3D space unit.
RENDER_PASS_PREFAB_PROPERTY
Sets which render pass prefab will be used to instantiate the render pass tree.
RENDER_PASS_PROPERTY
The RenderPass used for rendering the Scene for the Viewport. Instantiated from the RenderPassPrefab. Set internally by Kanzi whenever RenderPassPrefabProperty changes.
RENDER_SELF_PROPERTY
Whether the node renders itself. Does not affect the rendering of child nodes.
RENDER_TARGET_MINIMUM_HEIGHT_PROPERTY
Sets the minimum height of implicitly generated render targets.
RENDER_TARGET_MINIMUM_WIDTH_PROPERTY
Sets the minimum width of implicitly generated render targets.
RENDER_TARGET_PROPERTY
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.
RENDER_TARGET_REALLOCATION_LIMIT_PROPERTY
The change in size that triggers reallocation of a render target.
RENDER_TRANSFORMATION_ORIGIN_PROPERTY
Sets the render transform origin in relative coordinates.
RENDER_TRANSFORMATION_PROPERTY
The 2D transformation to be applied after layouting.
SNAP_TO_PIXEL_PROPERTY
Snap the translation of the node and its size into pixel boundary.
STATE_MANAGER_PROPERTY
Sets the State Manager to the node.
STYLE_PROPERTY
Sets a style to the node.
VERTICAL_ALIGNMENT_PROPERTY
The alignment in vertical direction the node should use when it resides under a layout.
VERTICAL_MARGIN_PROPERTY
Sets the vertical space between this node and other nodes that are adjacent to this node in a layout.
VISIBLE_AMOUNT_IN_PARENT_PROPERTY
Sets the amount the node is inside its parent. Use the value of this property in shaders to implement fades. Calculated by the parent node.
VISIBLE_PROPERTY
When disabled, Kanzi does not render the node.
Viewport2D
Use a Viewport 2D to set the size of a render target surface onto which content is projected. Viewport 2D is a 2D node that can project a 3D scene through a camera. Viewport 2D is a special node because it can render both 2D nodes, such as Image, Page, Button 2D, and a Scene, which is a 3D node.
WIDTH_PROPERTY
The width of the node when used in a layout. Overrides the default bounds of the item.

Enums§

ContentStretch
Content stretch option.
DepthAlignment
Depth alignment options.
ForegroundHint
Hint for foreground handling of nodes.
HorizontalAlignment
Horizontal alignment options.
PerspectiveTransformationMode
Node2D perspective transformation mode.
PixelFormat
Pixel formats.
VerticalAlignment
Vertical alignment options.

Traits§

Handler
INode2D

Functions§

MessageSubscriptionToken_Handler_drop
MessageSubscriptionToken_Handler_executor_ref