Render Pass

Render Pass available properties

Name	Description	Inherited	Exported to Kanzi Engine
Addressing Mode	Sets how Kanzi handles the texture coordinates of the automatically generated composition target textures outside of the [0, 0] - [1, 1] rectangle: - Repeat sets the texture to repeat outside of these coordinates. This is the default value. - Mirror sets the texture to repeat, but mirrors every other repetition. - Clamp confines the texture to these coordinates and outside of these texture coordinates repeats the edge texels of the texture. -Mirror once sets the texture to repeat once in the negative direction, and after that clamps the texture.	No	Yes
Blend Intensity	Controls the intensity of materials that are blended on top of an existing color. Attached property enables overriding of the blend intensity of the used materials at render pass or object node level.	No	Yes
Blend Mode	Controls how blending is performed. Attached property enables overriding of the blend mode of the used materials at render pass or object node level. Use "Alpha: Automatic" setting to use premultiplied or non-premultiplied alpha depending on the value of "Use Premultiplied Alpha by Default" project setting.	No	Yes
Blend Mode	Overrides the blend mode set in each node that this render pass renders.	No	Yes
Calculated Camera Matrix	Camera matrix calculated during DrawObjectsRenderPass rendering.	No	Yes
Calculated Projection Matrix	Projection matrix calculated during DrawObjectsRenderPass rendering.	No	Yes
Calculated Projection Near / Far Planes.	Near / far planes calculated during DrawObjectsRenderPass rendering.	No	Yes
Camera	Sets the Camera node that you want to use to render the nodes. To use the default Camera node in that Scene node, do not set the value for this property.	No	Yes
Clear Color 0	Sets the color that you want the Clear Render Pass to use to clear the first (default) color buffer.	No	Yes
Clear Color 1	Sets the color that you want the Clear Render Pass to use to clear the second color buffer.	No	Yes
Clear Color 2	Sets the color that you want the Clear Render Pass to use to clear the third color buffer.	No	Yes
Clear Color 3	Sets the color that you want the Clear Render Pass to use to clear the fourth color buffer.	No	Yes
Clear Depth	Sets the depth that you want the Clear Render Pass to use to clear the depth buffer.	No	Yes
Clear Stencil	Sets the clear stencil that you want the Clear Render Pass to use to clear the stencil buffer.	No	Yes
Color Write Mode	Sets which channels the render pass writes to the color buffer. To disable the color write, set the property to None.	No	Yes
Composition Target	Sets the target to which you want to render the result of this Cubemap Render Pass.	No	Yes
Composition Target 0	Sets the first color target to which you want to render the result of the child render passes of this render pass.	No	Yes
Composition Target 1	Sets the second color target to which you want to render the result of the child render passes of this render pass.	No	Yes
Composition Target 2	Sets the third color target to which you want to render the result of the child render passes of this render pass.	No	Yes
Composition Target 3	Sets the fourth color target to which you want to render the result of the child render passes of this render pass.	No	Yes
Cull Mode	Sets the culling of the triangle faces in the rendered meshes. Set to: - Back to render the triangles whose normal points towards a Camera node - Front to render the triangles whose normal points away from a Camera node	No	Yes
Depth Compare Function	Sets the comparison function to be used with comparison samplers of the Composition Target Render Pass' depth target.	No	Yes
Depth Compare Function	Sets the comparison function to be used with comparison samplers of the Cubemap Render Pass' depth target.	No	Yes
Depth Format	Sets the format of the automatically created depth render buffer used for the cubemap rendering. If this property is not set, the depth requirement and format are autodetected.	No	Yes
Depth Target	Sets the depth target to which you want to render the result of the child render passes of this render pass.	No	Yes
Depth Test Function	Controls whether the depth test discards a fragment.	No	Yes
Depth Texture Format	Sets the format of the automatically created Result Depth Texture.	No	Yes
Depth Write Enabled	Sets whether the render pass writes to the depth buffer.	No	Yes
Description	Add a description of the purpose of this item. To export descriptions to a plain text file, select File > Export > Export Descriptions. When you export the kzb file, this description is not included in the exported file.	No	No
Directional Lights	Use this property to bind the directional light set for rendering.	No	Yes
Disable KZB Export	Disables the exporting of the item into KZB. Can be used for, e.g. letting items out from certain profiles. The disabled items are always included in preview.	No	No
Enabled	Use Enabled property to toggle render passes and their child render pass tree on and off. Disabled render passes still exist in the tree, but are not executed.	No	Yes
Enabled	This determines if composer is rendered (enabled by default).	No	Yes
Engine Factory Name	The factory name for this composer. Can be used to instantiate composer or render pass from plugin.	No	No
Filter	Sets the filter that the Node List Render Pass uses to filter or sort a list of incoming nodes.	No	Yes
Filter Mode	Sets how Kanzi handles accessing the texture samples of the automatically generated composition target: - Nearest takes the color from the nearest sample. - Linear interpolates color from neighboring samples. This is the default value.	No	Yes
Filter Mode	Sets how Kanzi handles accessing the texture samples of the automatically generated composition cubemap target: - Nearest takes the color from the nearest sample. - Linear interpolates color from neighboring samples. This is the default value.	No	Yes
Flush After Render	This determines if GPU pipeline is flushed after rendering of this composer has occurred, to prevent GPU pipeline stall.	No	Yes
Frustum Culling	Enable to disable rendering objects that are not inside the view frustum. Trades GPU rendering time for CPU cull test time.	No	Yes
Height	Sets the absolute height for the automatically created composition target textures. If this property is not set, the size is taken from the current composition stack state using the values of the Resolution Multiplier and Resolution Divisor properties.	No	Yes
Material	Sets to the Material that you want a Blit Render Pass to use to blit one or more textures.	No	Yes
Material	Sets the material that will be used to render all nodes rendered by this DrawObjectsWithMaterialRenderPass.	No	Yes
Material	Sets the material that will have all other Material Setup Render Pass properties set to.	No	Yes
Mipmap Mode	Sets the mipmap mode of the automatically created composition target. To enable mipmaps set the property value to Linear or Nearest. Enabling mipmaps introduces the runtime cost of generating mipmaps after rendering. To disable mipmaps remove the property.	No	Yes
Mipmap Mode	Sets the mipmap mode of the automatically created composition cubemap target. To enable mipmaps set the property value to Linear or Nearest. Enabling mipmaps introduces the runtime cost of generating mipmaps after rendering. To disable mipmaps remove the property.	No	Yes
Multisample Level	Sets the number of samples you want to use for each output pixel of the automatically generated composition target textures. To disable multisampling, remove the property or set the property value to 1.	No	Yes
Node List	Input node list range. Set by a binding from nearest parent node list.	No	Yes
Object Source	Sets the object source which collects the nodes that you want to render with this render pass. To render all nodes in a Scene node (Root Object Source), do not set the value for this property.	No	Yes
Output Directional Lights	Kanzi uses this property to allow binding to directional light set.	No	Yes
Output Node List	Output node list range. Set by Node List Render Pass as result of filtering the Input Node List.	No	Yes
Output Point Lights	Kanzi uses this property to allow binding to point light set.	No	Yes
Output Spot Lights	Kanzi uses this property to allow binding to spot light set.	No	Yes
Override Camera	Sets the Camera node that you want to use to render the nodes to the composition cubemap texture. To use the default Camera node in that Scene node, do not set the value for this property.	No	Yes
Pixel Format	Sets on the GPU the target pixel format of the automatically created composition cubemap target textures.	No	Yes
Pixel Format 0	Sets on the GPU the target pixel format of the first automatically created composition target texture.	No	Yes
Pixel Format 1	Sets on the GPU the target pixel format of the second automatically created composition target texture.	No	Yes
Pixel Format 2	Sets on the GPU the target pixel format of the third automatically created composition target texture.	No	Yes
Pixel Format 3	Sets on the GPU the target pixel format of the fourth automatically created composition target texture.	No	Yes
Point Lights	Use this property to bind the point light set for rendering.	No	Yes
Render Pass Prefab	Sets the Render Pass Prefab that this Render Pass View instantiates.	No	Yes
Rendering Viewport	Viewport applied by DrawObjectsRenderPass rendering.	No	Yes
Resolution	Sets the dimensions of the automatically created composition cubemap target textures. The default value is 64.	No	Yes
Resolution Divisor	Sets the resolution divisor for the automatically created composition target textures. Together with the Resolution Multiplier property this property sets the size of the composition target in relation to the size of the current Viewport 2D node.	No	Yes
Resolution Multiplier	Sets the resolution multiplier for the automatically created composition target textures. Together with the Resolution Divisor property this property sets the size of the composition target in relation to the size of the current Viewport 2D node.	No	Yes
Resolve Immediately	Whether to resolve multisamples and generate mipmaps for the composition target texture immediately after rendering. By default the Composition Target Render Pass resolves multisamples and generates mipmaps immediately. When you continue rendering to the composition target in another Composition Target Render Pass that performs the resolve, disable this property.	No	Yes
Resolve Immediately	Whether to generate mipmaps for the composition target texture immediately after rendering. By default the Cubemap Render Pass generates mipmaps immediately. When you continue rendering to the composition target in another Cubemap Render Pass that performs the resolve, disable this property.	No	Yes
Result Depth Texture	The depth texture to which the Composition Target Render Pass renders its content.	No	Yes
Result Depth Texture	The cubemap depth texture to which the Cubemap Render Pass renders its content.	No	Yes
Result Texture	The result cubemap texture that was rendered to by the Cubemap Render Pass.	No	Yes
Result Texture 0	The first color texture to which the Composition Target Render Pass renders its content.	No	Yes
Result Texture 1	The second color texture to which the Composition Target Render Pass renders its content.	No	Yes
Result Texture 2	The third color texture to which the Composition Target Render Pass renders its content.	No	Yes
Result Texture 3	The fourth color texture to which the Composition Target Render Pass renders its content.	No	Yes
Scissor Area	Sets the scissor test within the current rendering Viewport node. You can define the scissor in either relative or absolute coordinates, the default is relative. Use the Scissor Mode property to set the coordinate type.	No	Yes
Scissor Mode	Sets the scissor test coordinate mode.	No	Yes
Spot Lights	Use this property to bind the spot light set for rendering.	No	Yes
Stencil Fail Operation	Sets the operation that the render pass performs when the stencil test fails.	No	Yes
Stencil Function Mask	Sets a mask on which the AND operation is executed with both the reference value and the stored stencil value when the test is done.	No	Yes
Stencil Function Reference Value	Sets the reference value for the stencil test.	No	Yes
Stencil Pass Depth Fail Operation	Sets the operation that the render pass performs when the stencil test passes, but the depth test fails.	No	Yes
Stencil Pass Depth Pass Operation	Sets the operation that the render pass performs when both, the stencil and the depth test, pass.	No	Yes
Stencil Test Function	Controls whether the stencil test discards a fragment.	No	Yes
Stencil Write Enabled	Sets whether to enable writing to the stencil buffer.	No	Yes
Texture 0	Sets the first texture you want the Blit Render Pass to blit.	No	Yes
Texture 1	Sets the second texture you want the Blit Render Pass to blit.	No	Yes
Texture 2	Sets the third texture you want the Blit Render Pass to blit.	No	Yes
Texture 3	Sets the fourth texture you want the Blit Render Pass to blit.	No	Yes
Viewport Area	Modifies the current rendering Viewport node. You can define the Viewport in either relative or absolute coordinates, the default is relative. Use the Viewport Mode property to set the coordinate type.	No	Yes
Viewport Mode	Sets the coordinate type for the Viewport node.	No	Yes
Width	Sets the absolute width for the automatically created composition target textures. If this property is not set, the size is taken from the current composition stack state using the values of the Resolution Multiplier and Resolution Divisor properties.	No	Yes

Render Pass messages

Name	Description	Inherited	Exported to Kanzi Engine
About To Gain Focus	Kanzi sends this message before a focusable node receives focus.	No	Yes
About To Lose Focus	Kanzi sends this message before the focused node loses focus.	No	Yes
Activate Activity	Send this message to an activity host node to activate the child Activity node that you set in the message. Exclusive Activity Host nodes deactivate the previously active Activity node at the same time.	No	Yes
Activity Prefab Attached	Activity prefab has been attached.	No	Yes
Activity Prefab Detached	Activity prefab has been detached.	No	Yes
Animation Playback Completed	Occurs when animation player completes animation playback.	No	Yes
Animation Playback Started	Occurs when animation player starts animation playback.	No	Yes
Animation Playback Stopped	Occurs when animation player stops animation playback.	No	Yes
Asynchronous Load Completed	Occurs when asynchronous loading of resources from a prefab has been finished.	No	Yes
Button: Cancel	Occurs when a finger is lifted outside of a button that was previously pressed.	No	Yes
Button: Click	Occurs when a finger is lifted on top of a button that was previously pressed and when a pressed button's repeat interval expires.	No	Yes
Button: Down	Occurs when the button is pressed.	No	Yes
Button: Enter	Occurs when a finger that presses a button enters the button's area.	No	Yes
Button: Leave	Occurs when a finger that presses a button leaves the button's area.	No	Yes
Button: Long Press	Occurs when a long press on the button happens.	No	Yes
Button: State Toggled	Occurs when the button's toggle state changes.	No	Yes
Click	Occurs when the pointer is pressed and is released on top of the component and no other gesture has been recognized.	No	Yes
Click Begin	Occurs when the pointer is pressed down on top of the component.	No	Yes
Click Cancel	Occurs when a started click cancels. This occurs, for example, when user pressed button down and slides finger away and releases press.	No	Yes
Click Enter	Occurs when the pointer or touch enters the click manipulator.	No	Yes
Click Leave	Occurs when the pointer or touch leaves the click manipulator.	No	Yes
Command	Command message arguments	No	Yes
Composition Text Changed	Occurs when the text produced in an Input Method Editor is updated in a Text Box node.	No	Yes
Composition Text Committed	Occurs: - When the text produced in an Input Method Editor is committed to the cached text in a Text Box node. - When a trigger executes the Commit Composition Text action.	No	Yes
Cursor Moved	Occurs when the user moves the cursor in a Text Box node.	No	Yes
Data Trigger	Monitors changes in properties and data source values. Use a Data Trigger to apply an action to either set a property value of a target node or activate an Activity node.	No	Yes
Deactivate Activity	Send this message to an activity host node to deactivate the child Activity node that you set in the message. Exclusive Activity Host nodes ignore this message.	No	Yes
Drag and Drop Canceled	Occurs when focus moves away from the node during the drag-and-drop gesture.	No	Yes
Drag and Drop Finished	Occurs when the user lifts their finger after starting the drag-and-drop gesture.	No	Yes
Drag and Drop Moved	Occurs when the user moves their finger after starting the drag-and-drop gesture.	No	Yes
Drag and Drop Started	Occurs when the user holds their finger for 500ms on the node.	No	Yes
Easing Interpolation Completed	Occurs when Property Target Easing Interpolator completes its interpolation.	No	Yes
Editing Finished	Occurs when a Text Box node leaves the editing state after the user modified the text content.	No	Yes
Editing Started	Occurs when the user makes the first modification to the text in a Text Box node that is in the editing state.	No	Yes
Enter Key Canceled	Occurs when: - Focus moves away from a Text Box node while the user presses the Enter key on their hardware or virtual keyboard. - A trigger executes the Cancel Enter Key action.	No	Yes
Enter Key Pressed	Occurs when: - User presses the Enter key on their hardware or virtual keyboard while editing the text in a Text Box node. - A trigger executes the Press Enter Key action.	No	Yes
Enter Key Released	Occurs when: - User releases the Enter key on their hardware or virtual keyboard while editing the text in a Text Box node. - A trigger executes the Release Enter Key action.	No	Yes
Entered Editing State	Occurs when a Text Box node enters the editing state.	No	Yes
Entered State	Occurs when a state manager has entered a state.	No	Yes
Focus Entered Focus Scope	When focus enters a focus scope, Kanzi sends this message to the focus scope node that contains the node that gains focus.	No	Yes
Focus Gained	Kanzi sends this message to the node that received focus.	No	Yes
Focus Left Focus Scope	When focus leaves a focus scope, Kanzi sends this message to the focus scope node that contains the node that loses focus.	No	Yes
Focus Lost	Kanzi sends this message to the node that lost focus.	No	Yes
Intermediate Click	If the multi-click manipulator is set to send messages for intermediate clicks, this trigger is set off every time the pointer is pressed and released on top of the node. To set the multi-click manipulator to send messages for intermediate clicks, in the Multi-Click Gesture enable the Send Intermediate Clicked Messages property.	No	Yes
Interpolation Completed	Occurs when property target interpolator completes interpolation.	No	Yes
Key Canceled	Occurs when Kanzi recognizes a key-canceled gesture. A key-canceled gesture occurs when Kanzi recognizes that the user canceled a gesture.	No	Yes
Key Navigation Canceled	Occurs when the key-pressed gesture is canceled for the navigation direction.	No	Yes
Key Navigation Finished	Occurs when Kanzi recognizes the key-released gesture for the navigation direction. To capture key navigation gestures for a node, create a Navigation Manipulator component in that node.	No	Yes
Key Navigation Started	Occurs when Kanzi recognizes the key-pressed and key repeat gestures for the navigation direction. To capture key navigation gestures for a node, create a Navigation Manipulator component in that node.	No	Yes
Key Pressed	Occurs when Kanzi recognizes a key-pressed gesture. A key-pressed gesture occurs when Kanzi recognizes a key event that contains all the elements that compose that gesture.	No	Yes
Key Released	Occurs when Kanzi recognizes a key-released gesture. A key-released gesture occurs when Kanzi recognizes the release of one of the elements that compose that gesture.	No	Yes
Left Editing State	Occurs when a Text Box node leaves the editing state	No	Yes
Left State	Occurs when a state manager has left a state.	No	Yes
List Box: Item Hidden	Occurs when an item is unloaded from the working memory. To set how many items you want to keep loaded in the working memory at a time, use the Keep Alive Item Count property.	No	Yes
List Box: Item Selected	Occurs when an item is selected.	No	Yes
List Box: Item Visible	Occurs when an item is loaded to the working memory. To set how many items you want to keep loaded in the working memory at a time, use the Keep Alive Item Count property.	No	Yes
List Box: Scroll Finished	Occurs when the List Box stops scrolling.	No	Yes
List Box: Scroll Started	Occurs when the List Box starts to scroll.	No	Yes
List Box: Scrolled	Occurs when the List Box scrolls.	No	Yes
List Box: Target Changed	Occurs when List Box gets a new target item.	No	Yes
List Box: User Scroll Finished	Occurs when the application user stops scrolling the List Box.	No	Yes
List Box: User Scroll Started	Occurs when the application user starts to scroll the List Box.	No	Yes
Long Press	Occurs when the user presses down their finger on the node and holds it down for the time you set in this trigger.	No	Yes
Long Press Cancel	Occurs when focus moves away from the node during the long-press gesture.	No	Yes
Message Trigger		No	Yes
Multi-Click	Occurs when the pointer is pressed and released on top of the node a specified number of times (default 2) within a specified amount of time (default 250 ms) between them.	No	Yes
Multi-Click Canceled	Occurs when focus moves away from the node during the multi-click gesture.	No	Yes
Navigate To Next Activity	Navigates to the next Activity node in the Activity Host.	No	Yes
Navigate To Previous Activity	Navigates to the previous Activity node in the Activity Host.	No	Yes
On Attached	This trigger is set off when the item is initialized. For example, when you add a node to the node tree, or enter a state that contains this trigger.	No	Yes
On Property Change	Occurs when a property is changed	No	Yes
On Timer	Occurs when timer interval is elapsed	No	Yes
Page Activated	Page has been activated.	No	Yes
Page Deactivated	Page has been deactivated.	No	Yes
Page Navigation Finished	Page host has finished navigation process.	No	Yes
Page Navigation Started	Page host has started navigation process.	No	Yes
Pan Canceled	Occurs when focus moves away from the node during the pan gesture.	No	Yes
Pan Entered	Occurs when the pan gesture enters the node the manipulator is attached to.	No	Yes
Pan Finished	Occurs when the user lifts their finger after Kanzi recognizes a pan gesture.	No	Yes
Pan Left	Occurs when the pan gesture leaves the node the manipulator is attached to.	No	Yes
Pan Moved	Occurs when the user changes the position of their finger and that change exceeds the recognition thresholds.	No	Yes
Pan Started	Occurs when the user presses down their finger on the node. If the user lifts their finger before exceeding the position change threshold, Kanzi cancels the pan gesture.	No	Yes
Pinch Canceled	Occurs when focus moves away from the node during the pinch gesture.	No	Yes
Pinch Finished	Occurs when the user lifts their finger after Kanzi recognizes a pinch gesture.	No	Yes
Pinch Moved	Occurs when the user changes the position of their finger and that change exceed the scale or rotation threshold.	No	Yes
Pinch Started	Occurs when the user presses down their finger. If the user lifts their finger before it exceeds the scale or rotate threshold, Kanzi cancels the pinch.	No	Yes
Range Concept: Value Change Finished	Occurs when the range value stops changing.	No	Yes
Range Concept: Value Change Started	Occurs when the range value starts changing.	No	Yes
Range Concept: Value Changed	Occurs when the range value has changed.	No	Yes
Scope Brought To Front	Occurs when a popup or a modal focus scope is brought to front.	No	Yes
Scope Sent To Back	Occurs when a foremost popup or modal focus scope is sent to back.	No	Yes
Scroll Ended	Occurs when the scroll position of a Scroll View node stops changing.	No	Yes
Scroll Started	Occurs when the scroll position of a Scroll View node starts changing.	No	Yes
Scroll Zoomed	Occurs when the zoom level of a Scroll View node changes.	No	Yes
Scrolled	Occurs when the scroll position of a Scroll View node changes.	No	Yes
Selection Changed	Occurs when the user changes the text selection in a Text Box node.	No	Yes
Selection Cleared	Occurs when the user clears or resets the text selection in a Text Box node.	No	Yes
Selection Started	Occurs when the user starts selecting text in a Text Box node.	No	Yes
Snap Request	Occurs when a Scroll View node requests snapping target from the hosting component.	No	Yes
Status Changed Message	To receive notifications when the Activity Status of this activity changes, subscribe to this message.	No	Yes
Text Changed	Occurs when the user changes the text in a Text Box node.	No	Yes
Text Composition Canceled	Occurs: - When the text composition in a Text Box node is canceled by Input Method that is in text composition state. - When a trigger executes the Cancel Text Composition action.	No	Yes
Toggle Button Group: Toggled	Occurs when a button in the group is toggled on.	No	Yes
Toggle Button: Toggled Off	Occurs when the toggle button is toggled off.	No	Yes
Toggle Button: Toggled On	Occurs when the toggle button is toggled on.	No	Yes
Transition Finished	Occurs when a state manager finishes a transition to a state.	No	Yes
Transition Started	Occurs when a state manager begins a transition to a state.	No	Yes
User Scroll Ended Message	Occurs when the user stops scrolling a Scroll View node.	No	Yes
User Scroll Started	Occurs when the user starts scrolling a Scroll View node.	No	Yes

See also

Rendering