Kanzi  3.9.7
Kanzi Engine API
kanzi::RenderPass Class Reference

RenderPass is the base class for Kanzi render passes. More...

#include <kanzi/core.ui/graphics3d/render_pass.hpp>

Inheritance diagram for kanzi::RenderPass:
[legend]

Classes

struct  CameraSettings
 Camera settings structure. More...
 

Public Types

enum  AttachmentState { Detached, Detaching, Attaching, Attached }
 Attachment state for keeping track current status. More...
 
typedef BindingRuntimeContainer::const_iterator BindingRuntimeConstIterator
 Const iterator type for binding runtime container. More...
 
typedef vector< AbstractBindingRuntimeSharedPtrBindingRuntimeContainer
 Container type for binding runtimes. More...
 
typedef BindingRuntimeContainer::iterator BindingRuntimeIterator
 Iterator type for binding runtime container. More...
 
using CameraSettingsPtr = unique_ptr< CameraSettings >
 Camera settings unique pointer type. More...
 
typedef ChildContainer::const_iterator ChildConstIterator
 Child container iterator type. More...
 
typedef vector< RenderPassSharedPtrChildContainer
 Container type for children. More...
 
- Public Types inherited from kanzi::PropertyObject
typedef PropertyStorageContainer::const_iterator PropertyStorageConstIterator
 
typedef vector< PropertyStoragePtrPropertyStorageContainer
 
typedef PropertyStorageContainer::iterator PropertyStorageIterator
 
typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStoragePropertyStoragePtr
 
typedef PropertyStorageContainer::reverse_iterator PropertyStorageReverseIterator
 
- Public Types inherited from kanzi::BindingHostConcept
using BindingHostConceptSharedPtr = shared_ptr< BindingHostConcept >
 Binding host concept shared pointer type. More...
 
using BindingRuntimeConstIterator = BindingRuntimeContainer::const_iterator
 Const iterator for binding runtimes. More...
 
using BindingRuntimeContainer = vector< AbstractBindingRuntimeSharedPtr >
 Container for binding runtimes. More...
 
using BindingRuntimeIterator = BindingRuntimeContainer::iterator
 Iterator for binding runtimes. More...
 

Public Member Functions

void addChild (RenderPassSharedPtr childRenderPass)
 Adds a render pass as the last child of the render pass you set. More...
 
void attach ()
 Attaches the render pass. More...
 
void attachRecursive (Node &node)
 Recursively attaches a render pass tree. More...
 
ChildConstIterator beginChildren () const
 Returns an iterator to the beginning of the container of child render passes. More...
 
BindingLookupContextPtr createLookupContext (RenderPassSharedPtr templateRoot)
 Creates a lookup context for a given render pass. More...
 
void detach ()
 Detaches the render pass. More...
 
void detachRecursive ()
 Recursively detaches a render pass tree. More...
 
ChildConstIterator endChildren () const
 Returns an iterator to the end of the container of child render passes. More...
 
string getCamera () const
 Gets the value of the CameraProperty. More...
 
RenderPassSharedPtr getChild (size_t index)
 Gets a child render pass at the given index. More...
 
size_t getChildCount () const
 Returns the number of child render passes. More...
 
size_t getChildIndex (RenderPass &childRenderPass) const
 Gets the index of a child in this render pass. More...
 
virtual CompositionRequirements getCompositionRequirements ()
 Queries if a render pass requires a depth buffer. More...
 
NodegetHostNode () const
 Gets the host node of a render pass. More...
 
Vector4 getInputViewport () const
 Gets the value of InputViewportAreaProperty. More...
 
RenderPassgetParent () const
 Gets the parent of a render pass. More...
 
ScenegetSceneForRenderPass () const
 Gets the scene being rendered by the render pass. More...
 
RenderPassSharedPtr getTemplateRoot () const
 Gets the template root of this render pass. More...
 
Viewport2DgetViewportForRenderPass () const
 Gets a viewport parent for a render pass. More...
 
void insertChild (size_t index, RenderPassSharedPtr childRenderPass)
 Adds a render pass as a child render pass at given index of the render pass you set. More...
 
bool isAttached () const
 Tells if a render pass is attached. More...
 
bool isAttaching () const
 Tells if a render pass is attaching. More...
 
bool isDetached () const
 Tells if a render pass is detached. More...
 
bool isDetaching () const
 Tells if render pass is detaching. More...
 
bool isEnabled () const
 Gets the value of the EnabledProperty property. More...
 
ObjectSharedPtr lookupObject (string_view relativePath)
 Lookup for an object from a node. More...
 
template<typename T >
shared_ptr< TlookupObject (string_view relativePath)
 Lookup a relative object of specific type. More...
 
void removeAllChildren ()
 Removes all child render passes from a render pass. More...
 
void removeChild (RenderPass &childRenderPass)
 Removes a child render pass. More...
 
void removeChild (size_t index)
 Removes a child render pass. More...
 
void render (Renderer3D &renderer, CompositionStack &compositionStack, const CameraSettings *cameraSettings)
 Recursively render RenderPass and all of its child render passes. More...
 
virtual void restoreResources ()
 Restore resources after suspend. More...
 
void restoreResourcesRecursive ()
 Recursively calls restoreResources for a RenderPass and all its children. More...
 
void setCamera (string_view value)
 Sets the value of the CameraProperty. More...
 
void setEnabled (bool value)
 Sets the value of the EnabledProperty. More...
 
void setHostNode (Node *hostNode)
 Sets the host node of a render pass. More...
 
void setParent (RenderPass *parent)
 Sets the parent of a render pass. More...
 
void setTemplateRoot (RenderPassSharedPtr templateRoot)
 Sets the template root for this render pass. More...
 
 ~RenderPass () override
 Destructor. More...
 
- Public Member Functions inherited from kanzi::Resource
virtual unsigned int getCPUMemoryUsage () const
 Function for getting the memory usage of a resource. More...
 
const string & getName () const
 Gets the resource name. More...
 
const string & getUrl () const
 Gets the resource URL. More...
 
bool isKeepAlive () const
 Tells if the resource has keep alive flag set. More...
 
void reload ()
 
void reloadFromFile (string_view filePath)
 
void reloadFromKzb (KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)
 
void setKeepAlive (bool keepAlive)
 Sets the keep alive flag. More...
 
void setUrl (string_view url)
 Sets the resource URL. More...
 
 ~Resource () override
 Destructor. More...
 
- Public Member Functions inherited from kanzi::Object
AppliedStyleEntrySharedPtr applyObjectStyle (kanzi::StyleSharedPtr style)
 Applies a style to an object. More...
 
void applyObjectStyles ()
 Apply all styles for an object node. More...
 
DomaingetDomain () const
 Returns the domain the object belongs to. More...
 
const MetaclassgetDynamicMetaclass () const override
 Returns the metaclass of the dynamic type of the object. More...
 
MainLoopSchedulergetMainLoopScheduler () const
 Returns the MainLoopScheduler instance of the associated Domain. More...
 
detail::MessageDispatcher * getMessageDispatcher () const
 Returns the message dispatcher of the object. More...
 
ResourceManagergetResourceManager () const
 Returns the resource manager of the object. More...
 
ScriptingContextSharedPtr getScriptingContext () const
 Gets the scripting context of the object. More...
 
 Object (Domain *domain)
 
void setScriptingContext (ScriptingContextSharedPtr context)
 Sets the scripting context of the object. More...
 
void unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)
 
void unapplyObjectStyles ()
 Unapplies and removes all applied styles. More...
 
 ~Object () override
 
- Public Member Functions inherited from kanzi::MetaObject
bool isTypeOf (const Metaclass *objectType) const
 Determines if the type of this object is the given type or derived from it. More...
 
virtual ~MetaObject ()
 
- Public Member Functions inherited from kanzi::PropertyObject
template<typename DataType >
void addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 
template<typename DataType >
void addPropertyModifierWithoutNotifyingHandlers (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 Adds a property modifier without notifying handlers. More...
 
template<typename DataType >
void addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
 
template<typename DataType >
void addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, void *ownerPointer)
 
template<typename DataType >
void addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner *owner)
 
PropertyStorageContainer::iterator beginPropertyStorage ()
 Returns the begin iterator to the internal property storage container. More...
 
PropertyStorageContainer::const_iterator beginPropertyStorage () const
 Returns the begin iterator to the internal property storage container. More...
 
void clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
 
void copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType)
 Copies local value of single property from another object. More...
 
void copyLocalValues (const PropertyObject &other)
 Copies all local values from another object. More...
 
PropertyStorageContainer::iterator endPropertyStorage ()
 Returns the end iterator to the internal property storage container. More...
 
PropertyStorageContainer::const_iterator endPropertyStorage () const
 Returns the end iterator to the internal property storage container. More...
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getAbstractProperty (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getAbstractPropertyBase (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalProperty (const PropertyType< DataType > &propertyType) const
 Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value. More...
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalPropertyBase (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property disregarding modifiers, but does not default to the value in property metadata if there are no inputs to the property value. More...
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getProperty (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property type. More...
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getPropertyBase (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property disregarding modifiers. More...
 
template<typename DataType >
size_t getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType) const
 Gets number of current notification handlers for given property type. More...
 
bool hasBaseValue (AbstractPropertyType propertyType) const
 Evaluates whether there are any inputs into the property value, disregarding modifiers. More...
 
bool hasLocalValue (AbstractPropertyType propertyType) const
 Evaluates whether there is a local value set for the property. More...
 
bool hasNonClassValue (AbstractPropertyType propertyType) const
 Evaluates whether there is a value of any precedence higher than class default value set for the property. More...
 
bool hasValue (AbstractPropertyType propertyType) const
 Evaluates whether there are any inputs into the property value. More...
 
bool isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const
 
 PropertyObject ()
 
void removeKzbProperties (flat_set< AbstractPropertyType > *keepProperties)
 Remove all KZB properties that are not included in a given set. More...
 
void removeKzbProperties ()
 Remove all KZB properties. More...
 
template<typename DataType >
void removeLocalPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *ownerPointer)
 
void removeLocalValue (AbstractPropertyType propertyType)
 Removes the local value associated with the property. More...
 
template<typename DataType >
void removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 
template<typename DataType >
void removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
 
template<typename DataType >
void removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *ownerPointer)
 
template<typename DataType >
void setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value)
 
template<typename DataType >
void setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value)
 Sets the local value of a property type. More...
 
void setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
 
KZ_DEPRECATED void validatePropertyModifiers (AbstractPropertyType propertyType)
 Validates property modifiers and notifies handlers. More...
 
void validatePropertyModifiersAndNotifyHandlers (AbstractPropertyType propertyType)
 Validates property modifiers and notifies handlers. More...
 
virtual ~PropertyObject ()
 
- Public Member Functions inherited from kanzi::BindingHostConceptImpl< RenderPass >
void addBindingRuntime (AbstractBindingRuntimeSharedPtr entry, shared_ptr< void > owner)
 Adds an already-created binding runtime to this binding host. More...
 
BindingRuntimeHandle setBinding (AbstractBindingSharedPtr binding, shared_ptr< RenderPass > templateRoot, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence)
 Wrapper for setting a binding. More...
 
BindingRuntimeHandle setBinding (AbstractBindingSharedPtr binding, shared_ptr< RenderPass > templateRoot, AbstractPropertyType propertyType, PropertyField field)
 Wrapper for setting a binding. More...
 
BindingRuntimeHandle setBinding (AbstractBindingSharedPtr binding, shared_ptr< RenderPass > templateRoot, AbstractPropertyType propertyType, PropertyValuePrecedence precedence)
 Wrapper for setting a binding. More...
 
BindingRuntimeHandle setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence)
 Wrapper for setting a binding. More...
 
BindingRuntimeHandle setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyField field)
 Wrapper for setting a binding. More...
 
BindingRuntimeHandle setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyValuePrecedence precedence)
 Wrapper for setting a binding. More...
 
BindingRuntimeHandle setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType)
 Wrapper for setting a binding. More...
 
BindingRuntimeHandle setBinding (AbstractBindingSharedPtr binding, shared_ptr< RenderPass > templateRoot)
 Sets a binding with no target. More...
 
BindingRuntimeHandle setBinding (AbstractBindingSharedPtr binding)
 Wrapper for setting a binding with no target. More...
 
BindingRuntimeHandle setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, shared_ptr< RenderPass > templateRoot, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence)
 Sets a binding to a certain property. More...
 
BindingRuntimeHandle setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence)
 Wrapper for setting a binding with owner. More...
 
BindingRuntimeHandle setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType)
 Wrapper for setting a binding with owner. More...
 
BindingRuntimeHandle setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, shared_ptr< RenderPass > templateRoot)
 Sets a binding with no target. More...
 
BindingRuntimeHandle setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner)
 Wrapper for setting a binding with no target. More...
 
BindingRuntimeHandle setModifierBinding (AbstractBindingSharedPtr binding, shared_ptr< RenderPass > templateRoot, AbstractPropertyType propertyType, PropertyField field)
 Wrapper for setting a modifier binding. More...
 
BindingRuntimeHandle setModifierBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyField field)
 Wrapper for setting a modifier binding. More...
 
BindingRuntimeHandle setModifierBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType)
 Wrapper for setting a modifier binding. More...
 
BindingRuntimeHandle setModifierBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, shared_ptr< RenderPass > templateRoot, AbstractPropertyType propertyType, PropertyField field)
 Sets a modifier binding. More...
 
BindingRuntimeHandle setModifierBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType, PropertyField field)
 Wrapper for setting a modifier binding. More...
 
BindingRuntimeHandle setModifierBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType)
 Wrapper for setting a modifier binding. More...
 
- Public Member Functions inherited from kanzi::BindingHostConcept
BindingRuntimeConstIterator beginBindingRuntimes () const
 Returns an iterator to the beginning of binding runtimes. More...
 
BindingRuntimeConstIterator endBindingRuntimes () const
 Returns an iterator to the end of binding runtimes. More...
 
AbstractBindingRuntimeSharedPtr getBindingRuntime (size_t idx)
 Gets binding by index. More...
 
size_t getBindingRuntimeCount () const
 Gets the number of binding runtimes added to this node. More...
 
void removeAllBindings ()
 Removes all binding runtimes. More...
 
void removeBinding (BindingRuntimeHandle &bindingRuntime)
 Removes a binding runtime added earlier. More...
 
void removeBindingsWithOwner (shared_ptr< void > owner)
 Removes all binding runtimes with the specified owner. More...
 

Static Public Member Functions

static RenderPassSharedPtr create (Domain *domain, string_view name)
 Create a render pass. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
- Static Public Member Functions inherited from kanzi::Object
static const MetaclassgetStaticMetaclass ()
 Returns the metaclass of Object class. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 Default implementation that returns empty editor info. More...
 
- Static Public Member Functions inherited from kanzi::MetaObject
static const MetaclassgetStaticMetaclass ()
 Returns the metaclass of Object class. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 Default implementation that returns empty editor info. More...
 

Static Public Attributes

static PropertyType< string > CameraProperty
 Sets the Camera node that you want this render pass to use to render content. More...
 
static PropertyType< bool > EnabledProperty
 Use the Enabled property to turn render passes and render pass trees on or off. More...
 
static PropertyType< Vector4InputViewportAreaProperty
 Reports the size of the Viewport 2D that uses this render pass. More...
 

Protected Member Functions

CameraacquireCamera (string_view relativePath) const
 Acquires a Camera node based on the value of the Camera property. More...
 
CompositionRequirements combineChildCompositionRequirements (CompositionRequirements requirements)
 Iterates the children for composition requirements. More...
 
CompositionRequirements getChildCompositionRequirements ()
 Iterates the children for composition requirements. More...
 
virtual void onAttached ()
 Called when a render pass becomes attached. More...
 
virtual void onDetached ()
 Called when a render pass becomes detached. More...
 
void onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) override
 Object::onPropertyChanged() implementation. More...
 
void renderChildren (Renderer3D &renderer, CompositionStack &compositionStack, const CameraSettings *cameraSettings)
 Render all child render passes of a render pass. More...
 
virtual void renderChildrenOverride (Renderer3D &renderer, CompositionStack &compositionStack, const CameraSettings *cameraSettings)
 Implementation-dependent rendering of all child render passes of a render pass. More...
 
virtual void renderOverride (Renderer3D &renderer, CompositionStack &compositionStack, const CameraSettings *cameraSettings)
 Render implementation specific to the RenderPass class. More...
 
 RenderPass (Domain *domain, string_view name)
 Constructor. More...
 
template<typename T >
void updatePropertyValueSourceAndNotify (AbstractPropertyType propertyType, typename PropertyType< T >::Descriptor::TypedValueSource &valueSource, const T &value)
 Updates the local value of a property in a Draw Objects Render Pass. More...
 
- Protected Member Functions inherited from kanzi::Resource
virtual unsigned int getCPUMemoryUsageOverride () const
 
virtual void reloadFromFileOverride (string_view filePath)
 
virtual void reloadFromKzbOverride (KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)
 
virtual void reloadOverride ()
 
 Resource (Domain *domain, string_view name)
 Constructor. More...
 
- Protected Member Functions inherited from kanzi::Object
void initialize ()
 
void onCopy (const Object &other)
 
- Protected Member Functions inherited from kanzi::MetaObject
void initialize ()
 
 MetaObject ()
 
- Protected Member Functions inherited from kanzi::PropertyObject
AbstractPropertyTypeDescriptor::ValueSourceEntryacquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
 Acquires a local value source entry that is free for the assignment of a value. More...
 
AbstractPropertyTypeDescriptor::ModifierStorageacquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
AbstractPropertyTypeDescriptor::NotificationStorageacquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)
 
PropertyStoragePtr acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
 
template<typename DataType >
void addPropertyModifierBase (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner, bool notify)
 Adds a property modifier entry to the property modifier stack and validates them. More...
 
void addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, PropertyValuePrecedence precedence, void *ownerPointer)
 Internally adds a property value source. More...
 
void addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner *owner)
 Internally adds a property value source. More...
 
AbstractPropertyTypeDescriptor::ValueSourceEntryconstructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
PropertyStoragePtr constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
 
void copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &otherPropertyStorage)
 Copy local value from property storage. More...
 
AbstractPropertyTypeDescriptor::ModifierStoragefindModifierStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::NotificationStoragefindNotificationStorage (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::PropertyStoragefindPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const
 Gets the property storage for given property type descriptor. More...
 
PropertyStoragePtr findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
 Gets property storage intrusive pointer which you can use to hold a reference until the end of the operation. More...
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByNameAndDataType (string_view name, PropertyDataType dataType) const
 Finds a property type descriptor by name and data type. More...
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByQualifiedNameAndDataType (string_view qualifiedName, PropertyDataType dataType) const
 Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with qualified names. More...
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType) const
 Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with unqualified names. More...
 
AbstractPropertyTypeDescriptor::ValueSourcegetClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 Gets the top-level value source for a given property descriptor. More...
 
virtual void notifyPropertyHandlers (PropertyStoragePtr &storagePtr, PropertyNotificationReason reason)
 Notifies all property handlers on a property storage. More...
 
void onCopy (const PropertyObject &other)
 
void removeLocalValue (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
 Removes a local value from the given property storage. More...
 
void removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, void *owner)
 Removes a property value source. More...
 
void validatePropertyModifiers (PropertyStoragePtr &propertyStorage)
 Validates property modifiers without notifying handlers. More...
 
void validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)
 Validates property modifiers and notifies handlers. More...
 
- Protected Member Functions inherited from kanzi::BindingHostConceptImpl< RenderPass >
RenderPassgetThisObject ()
 Internal accessor for the Curiously Recurring Template Pattern. More...
 
const RenderPassgetThisObject () const
 Internal accessor for the Curiously Recurring Template Pattern. More...
 
- Protected Member Functions inherited from kanzi::BindingHostConcept
void attachBindings ()
 Attach all bindings stored in this object. More...
 
void detachBindings ()
 Detach bindings. More...
 

Protected Attributes

AttachmentState m_attachmentState
 Render pass attachment state. More...
 
ChildContainer m_children
 Child render passes. More...
 
bool m_enabled
 Render pass enabled state. More...
 
Nodem_hostNode
 Pointer to host node this render pass is attached under. More...
 
PropertyType< Vector4 >::Descriptor::TypedValueSource m_inputViewportAreaValueSource
 Value source for the input viewport area property. More...
 
RenderPassm_parent
 Pointer to parent render pass. More...
 
weak_ptr< RenderPassm_templateRoot
 Weak pointer to template root object of this render pass. More...
 
- Protected Attributes inherited from kanzi::Object
AppliedStyleContainer m_appliedStyles
 Listing of applied styles applied to this object. More...
 
- Protected Attributes inherited from kanzi::BindingHostConcept
BindingRuntimeContainer m_bindingRuntimes
 Bindings in this object. More...
 

Additional Inherited Members

- Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtrAppliedStyleContainer
 Applied style container. More...
 

Detailed Description

RenderPass is the base class for Kanzi render passes.

Use render passes to perform singular render pass operations in 3D scenes. For example, use a render pass to clear the background, render nodes for a specific object source, set up a composition target, and so on.

Combine render passes into a hierarchy to create the rendering result you want to achieve.

Render pass rendering and execution order

The base RenderPass class does not implement any functionality, but renders its descendant render passes. This is the reason why the base RenderPass class is called Group Render Pass in Kanzi Studio. All other render passes either perform draw operations or set the state for successive render passes. In both cases, they pass the control to their descendant render passes only after they execute their own operations. Keep this in mind when you define your own render passes. See Creating your own render pass.

Render passes that perform draw operations are:

Render passes that set state are:

Kanzi excutes render passes by iterating the tree depth-first. This is similar to how Kanzi iterates nodes when it renders the node tree. Each render pass first executes itself, then, one at a time, all of its child render passes. Since the child render passes execute themselves, Kanzi executes the full tree starting from a child render pass before it executes the next child render pass. In the same way, the successive Kanzi executes the sibling render passes before it returns the control returns to the parent render pass.

Using textures created with render passes

You can use a render pass to create a texture and then use that texture in other render passes. The texture bindings are resolved on render. For example, you can show on the screen a texture that a CompositionTargetRenderPass creates, with a BlitRenderPass.

Creating render passes

When you create a render pass, the create function calls the constructor, initializes the render pass, and returns the pointer to the render pass. The render pass constructors are protected and only inheriting classes can access them.

For example, to create a Group Render Pass:

// Create a Group Render Pass which you can use to combine different types of render passes to achieve a specific rendering result.
RenderPassSharedPtr renderPass = RenderPass::create(domain, "Group Render Pass");

Render pass hierarchy

You can combine render passes into a hierarchy to create the rendering result you cannot achieve with any single render pass. When you select a render pass for a Scene or a Viewport2D node, you can select either the root render pass or a specific render pass within such hierarchy. If you select a specific render pass within such hierarchy, Kanzi uses only that render pass and its descendants to render the content.

If a render pass is the root of its own tree, it does not have a parent render pass. In the same manner, if a render pass is a leaf render pass, it does not have any child render passes.

To create a render pass hierarchy:

// Create a top-level Group Render Pass to act as root.
RenderPassSharedPtr defaultRenderPass = RenderPass::create(domain, "Group Render Pass");
// Create a Pipeline State Render Pass you can use to set the rendering state, and add it to the Group Render Pass.
PipelineStateRenderPassSharedPtr pipelineStateRenderPass = PipelineStateRenderPass::create(domain, "Pipeline State Render Pass");
defaultRenderPass->addChild(pipelineStateRenderPass);
// Create a Clear Render Pass to do the clearing before rendering, and add it to the Pipeline State Render Pass.
ClearRenderPassSharedPtr clearRenderPass = ClearRenderPass::create(domain, "Clear Render Pass");
pipelineStateRenderPass->addChild(clearRenderPass);
// Create a Draw Objects Render Pass to render all 3D objects after clearing, and add it to the Pipeline State Render Pass.
DrawObjectsRenderPassSharedPtr drawObjectsRenderPass = DrawObjectsRenderPass::create(domain, "Draw Objects Render Pass");
pipelineStateRenderPass->addChild(drawObjectsRenderPass);

To access descendant render passes (child render passes of the current render pass):

// Gets the first descendant (the first child render pass) of a render pass.
RenderPassSharedPtr childRenderPass = groupRenderPass->getChild(0);

To access ascendant render pass (parent render pass of the current render pass):

// Gets the ascendant (the parent render pass) of a render pass.
RenderPass* parentRenderPass = pipelineStateRenderPass->getParent();

Creating your own render pass class

If you cannot achieve the rendering result with the render passes that come with Kanzi, you can create your own render pass.

Defining the class

Start creating your own render pass by inheriting from the RenderPass base class. Define metaclass and declare property types in the same way as you would in the Node classes. See Node2D.

To create a simple custom render pass:

class ExampleRenderPass;
typedef shared_ptr<ExampleRenderPass> ExampleRenderPassSharedPtr;
class ExampleRenderPass : public RenderPass
{
public:
static PropertyType<float> PolygonDepthOffsetProperty;
float getPolygonDepthOffset() const
{
return getProperty(PolygonDepthOffsetProperty);
}
void setPolygonDepthOffset(float value)
{
setProperty(PolygonDepthOffsetProperty, value);
}
KZ_METACLASS_BEGIN(ExampleRenderPass, RenderPass, "Kanzi.ExampleRenderPass")
KZ_METACLASS_PROPERTY_TYPE(PolygonDepthOffsetProperty)
static PropertyTypeEditorInfoSharedPtr makeEditorInfo();
static ExampleRenderPassSharedPtr create(Domain* domain, string_view name)
{
ExampleRenderPassSharedPtr renderPass = make_polymorphic_shared_ptr<RenderPass>(new ExampleRenderPass(domain, name));
renderPass->initialize();
return renderPass;
}
protected:
explicit ExampleRenderPass(Domain* domain, string_view name) :
RenderPass(domain, name)
{
}
void renderOverride(Renderer3D& renderer, CompositionStack& compositionStack, const CameraSettings* cameraSettings) override;
};
PropertyType<float> ExampleRenderPass::PolygonDepthOffsetProperty(kzMakeFixedString("ExampleRenderPass.PolygonOffset"), 1.0f, 0, false,
(
metadata.displayName = "Polygon Offset";
metadata.host = "Kanzi.RenderPass:context,Kanzi.ExampleRenderPass:auto";
metadata.tooltip = "Defines the polygon offset for rendering the children of the render pass.";
));
PropertyTypeEditorInfoSharedPtr ExampleRenderPass::makeEditorInfo()
{
metadata.displayName = "Example Render Pass";
metadata.tooltip = "Use Example Render Pass to set polygon offset for rendering its render pass tree. For example, this can be useful for rendering decals on existing geometry.";
));
}

RenderPass override functions

When you need to override the functionality of the RenderPass class, override the renderOverride() virtual method:

void ExampleRenderPass::renderOverride(Renderer3D& renderer, CompositionStack& compositionStack, const CameraSettings* cameraSettings)
{
// Modify state. In this case, set the polygon offset.
// This example does not store the existing polygon offset.
float offset = getProperty(PolygonDepthOffsetProperty);
kzsGlPolygonOffset(1.0f, offset);
// Pass to rendering children.
renderChildren(renderer, compositionStack, cameraSettings);
// Restore state.
kzsGlPolygonOffset(0.0f, 0.0f);
}

Member Typedef Documentation

Container type for children.

typedef ChildContainer::const_iterator kanzi::RenderPass::ChildConstIterator

Child container iterator type.

Camera settings unique pointer type.

Container type for binding runtimes.

typedef BindingRuntimeContainer::iterator kanzi::RenderPass::BindingRuntimeIterator

Iterator type for binding runtime container.

typedef BindingRuntimeContainer::const_iterator kanzi::RenderPass::BindingRuntimeConstIterator

Const iterator type for binding runtime container.

Member Enumeration Documentation

Attachment state for keeping track current status.

Enumerator
Detached 

Detached.

Detaching 

Detaching.

Set after detach is called, but not yet completed.

Attaching 

Attaching.

Set after attach is called, but not yet completed.

Attached 

Attached.

Constructor & Destructor Documentation

kanzi::RenderPass::~RenderPass ( )
override

Destructor.

kanzi::RenderPass::RenderPass ( Domain domain,
string_view  name 
)
explicitprotected

Constructor.

Parameters
domainThe domain to use.
nameThe name for the render pass.

Member Function Documentation

bool kanzi::RenderPass::isEnabled ( ) const
inline

Gets the value of the EnabledProperty property.

See also
setEnabled()
Returns
The value of the Enabled property.
void kanzi::RenderPass::setEnabled ( bool  value)
inline

Sets the value of the EnabledProperty.

See also
isEnabled()
Parameters
valueThe new value for Enabled property.
string kanzi::RenderPass::getCamera ( ) const
inline

Gets the value of the CameraProperty.

See also
setCamera()
Returns
The value of the Camera property.
void kanzi::RenderPass::setCamera ( string_view  value)
inline

Sets the value of the CameraProperty.

See also
getCamera()
Parameters
valueThe new value for Camera property.
Vector4 kanzi::RenderPass::getInputViewport ( ) const
inline

Gets the value of InputViewportAreaProperty.

Returns
The value of the InputViewportArea property.
static PropertyTypeEditorInfoSharedPtr kanzi::RenderPass::makeEditorInfo ( )
static
static RenderPassSharedPtr kanzi::RenderPass::create ( Domain domain,
string_view  name 
)
static

Create a render pass.

Parameters
domainThe domain to use.
nameThe name for the render pass.
void kanzi::RenderPass::render ( Renderer3D renderer,
CompositionStack compositionStack,
const CameraSettings cameraSettings 
)

Recursively render RenderPass and all of its child render passes.

Calls renderOverride that you can implement by inheriting classes.

Parameters
rendererThe renderer to use.
compositionStackThe composition stack to use.
cameraSettingsCamera settings passed from parent rendering.
void kanzi::RenderPass::addChild ( RenderPassSharedPtr  childRenderPass)

Adds a render pass as the last child of the render pass you set.

Parameters
childRenderPassThe render pass to add.
void kanzi::RenderPass::insertChild ( size_t  index,
RenderPassSharedPtr  childRenderPass 
)

Adds a render pass as a child render pass at given index of the render pass you set.

Parameters
indexThe index at which to insert the child render pass.
childRenderPassThe render pass to add.
size_t kanzi::RenderPass::getChildIndex ( RenderPass childRenderPass) const

Gets the index of a child in this render pass.

Throws an exception if the given render pass is not a child of this render pass.

Parameters
childRenderPassChild render pass to query index for.
Returns
Index of the child render pass.
void kanzi::RenderPass::removeChild ( RenderPass childRenderPass)

Removes a child render pass.

Throws an exception if the given render pass is not a child of this render pass.

Parameters
childRenderPassThe render pass to remove.
void kanzi::RenderPass::removeChild ( size_t  index)

Removes a child render pass.

Parameters
indexIndex of the child render pass to remove.
void kanzi::RenderPass::removeAllChildren ( )

Removes all child render passes from a render pass.

void kanzi::RenderPass::attachRecursive ( Node node)

Recursively attaches a render pass tree.

Parameters
nodeNode associated with the root render pass.
void kanzi::RenderPass::detachRecursive ( )

Recursively detaches a render pass tree.

Should be called from the node that attached the tree originally.

void kanzi::RenderPass::attach ( )

Attaches the render pass.

void kanzi::RenderPass::detach ( )

Detaches the render pass.

bool kanzi::RenderPass::isAttached ( ) const
inline

Tells if a render pass is attached.

Returns
True if attached, false otherwise.
bool kanzi::RenderPass::isAttaching ( ) const
inline

Tells if a render pass is attaching.

Returns
True if attaching, false otherwise.
bool kanzi::RenderPass::isDetached ( ) const
inline

Tells if a render pass is detached.

Returns
True if detached, false otherwise.
bool kanzi::RenderPass::isDetaching ( ) const
inline

Tells if render pass is detaching.

Returns
True if detaching, false otherwise.
RenderPassSharedPtr kanzi::RenderPass::getTemplateRoot ( ) const
inline

Gets the template root of this render pass.

Template root is used in template root bindings. This is an internal function.

void kanzi::RenderPass::setTemplateRoot ( RenderPassSharedPtr  templateRoot)
inline

Sets the template root for this render pass.

Template root is used in template root bindings. This is an internal function.

RenderPass* kanzi::RenderPass::getParent ( ) const
inline

Gets the parent of a render pass.

Returns
Pointer to parent render pass or a nullptr if the render pass does not have a parent.
void kanzi::RenderPass::setParent ( RenderPass parent)
inline

Sets the parent of a render pass.

Parameters
parentThe parent render pass.
Node* kanzi::RenderPass::getHostNode ( ) const
inline

Gets the host node of a render pass.

Returns
Pointer to host node of a render pass or a nullptr if this render pass does not have a host node.
void kanzi::RenderPass::setHostNode ( Node hostNode)
inline

Sets the host node of a render pass.

Parameters
hostNodeNew host node for the render pass. Use nullptr to clear.
Viewport2D* kanzi::RenderPass::getViewportForRenderPass ( ) const

Gets a viewport parent for a render pass.

Returns
Host viewport or nullptr.
Scene* kanzi::RenderPass::getSceneForRenderPass ( ) const

Gets the scene being rendered by the render pass.

Returns
Associated scene or nullptr.
RenderPassSharedPtr kanzi::RenderPass::getChild ( size_t  index)
inline

Gets a child render pass at the given index.

Throws an error if the index is invalid.

Parameters
indexThe index of the child render pass that you want get.
Returns
Shared pointer to the child render pass at the given index.
size_t kanzi::RenderPass::getChildCount ( ) const
inline

Returns the number of child render passes.

ChildConstIterator kanzi::RenderPass::beginChildren ( ) const
inline

Returns an iterator to the beginning of the container of child render passes.

ChildConstIterator kanzi::RenderPass::endChildren ( ) const
inline

Returns an iterator to the end of the container of child render passes.

ObjectSharedPtr kanzi::RenderPass::lookupObject ( string_view  relativePath)

Lookup for an object from a node.

Object found may be another render pass, a node or a resource within a node.

Parameters
relativePathRelative path to use for lookup.
Returns
Shared pointer referencing object. May be empty if no object found.
template<typename T >
shared_ptr<T> kanzi::RenderPass::lookupObject ( string_view  relativePath)
inline

Lookup a relative object of specific type.

Even if object is found, if it's not of the given type, the search fails.

Returns
Shared pointer referencing object. May be empty if no object found or object is not of correct type.
virtual CompositionRequirements kanzi::RenderPass::getCompositionRequirements ( )
virtual

Queries if a render pass requires a depth buffer.

Use this function to determine the depth buffer requirement for automatically created render targets.

Reimplemented in kanzi::CompositionTargetRenderPass, kanzi::PipelineStateRenderPass, and kanzi::ClearRenderPass.

void kanzi::RenderPass::restoreResourcesRecursive ( )

Recursively calls restoreResources for a RenderPass and all its children.

Calls happen in depth-first order.

virtual void kanzi::RenderPass::restoreResources ( )
virtual

Restore resources after suspend.

Inheriting classes should call parent class methods.

Reimplemented in kanzi::CompositionTargetRenderPass, and kanzi::CubeMapRenderPass.

BindingLookupContextPtr kanzi::RenderPass::createLookupContext ( RenderPassSharedPtr  templateRoot)

Creates a lookup context for a given render pass.

Parameters
templateRootTemplate root for given render pass.
Returns
Newly created render pass lookup context.
void kanzi::RenderPass::onPropertyChanged ( AbstractPropertyType  propertyType,
PropertyNotificationReason  reason 
)
overrideprotectedvirtual

Object::onPropertyChanged() implementation.

Reimplemented from kanzi::PropertyObject.

Reimplemented in kanzi::RenderPassView.

virtual void kanzi::RenderPass::onAttached ( )
protectedvirtual

Called when a render pass becomes attached.

Inheriting classes should call parent class function.

Reimplemented in kanzi::GatherLightsRenderPass, kanzi::DrawObjectsRenderPass, kanzi::NodeListRenderPass, and kanzi::RenderPassView.

virtual void kanzi::RenderPass::onDetached ( )
protectedvirtual

Called when a render pass becomes detached.

Inheriting classes should call parent class function.

Reimplemented in kanzi::CompositionTargetRenderPass, kanzi::GatherLightsRenderPass, kanzi::DrawObjectsRenderPass, kanzi::NodeListRenderPass, and kanzi::RenderPassView.

Camera* kanzi::RenderPass::acquireCamera ( string_view  relativePath) const
protected

Acquires a Camera node based on the value of the Camera property.

Parameters
relativePathRelative camera path in respect to scene.
void kanzi::RenderPass::renderChildren ( Renderer3D renderer,
CompositionStack compositionStack,
const CameraSettings cameraSettings 
)
inlineprotected

Render all child render passes of a render pass.

Parameters
rendererThe renderer to use.
compositionStackThe composition stack to use.
cameraSettingsCamera settings passed from parent rendering or set in this render pass.
CompositionRequirements kanzi::RenderPass::combineChildCompositionRequirements ( CompositionRequirements  requirements)
protected

Iterates the children for composition requirements.

The requirements for children are merged with the requirements passed.

Parameters
requirementsInitial requirements.
Returns
Requirements combined with all children.
CompositionRequirements kanzi::RenderPass::getChildCompositionRequirements ( )
inlineprotected

Iterates the children for composition requirements.

Usually the user should call combineChildCompositionRequirements() instead. This function is used if the render pass has no requirements of its own.

Returns
Requirements combined with all children.
virtual void kanzi::RenderPass::renderOverride ( Renderer3D renderer,
CompositionStack compositionStack,
const CameraSettings cameraSettings 
)
protectedvirtual

Render implementation specific to the RenderPass class.

The default implementation renders all child render passes, but does nothing else. For this reason the base render pass class is considered as a Group Render Pass.

Parameters
rendererThe renderer to use.
compositionStackThe composition stack to use.
cameraSettingsCamera settings passed from parent rendering or set in this render pass.

Reimplemented in kanzi::CompositionTargetRenderPass, kanzi::PipelineStateRenderPass, kanzi::GatherLightsRenderPass, kanzi::CubeMapRenderPass, kanzi::DrawObjectsRenderPass, kanzi::GatherNearestLightsRenderPass, kanzi::NodeListRenderPass, kanzi::ClearRenderPass, kanzi::BlitRenderPass, and kanzi::MaterialSetupRenderPass.

virtual void kanzi::RenderPass::renderChildrenOverride ( Renderer3D renderer,
CompositionStack compositionStack,
const CameraSettings cameraSettings 
)
protectedvirtual

Implementation-dependent rendering of all child render passes of a render pass.

Parameters
rendererThe renderer to use.
compositionStackThe composition stack to use.
cameraSettingsCamera settings passed from parent rendering or set in this render pass.
template<typename T >
void kanzi::RenderPass::updatePropertyValueSourceAndNotify ( AbstractPropertyType  propertyType,
typename PropertyType< T >::Descriptor::TypedValueSource &  valueSource,
const T value 
)
inlineprotected

Updates the local value of a property in a Draw Objects Render Pass.

If the value of the property stays the same, do not run notification handlers for the property. Because we are setting the local value source, only check value sources, do not execute modifiers.

Parameters
propertyTypeProperty type to update.
valueSourceValue source to update.
valueValue to set.

Member Data Documentation

PropertyType<bool> kanzi::RenderPass::EnabledProperty
static

Use the Enabled property to turn render passes and render pass trees on or off.

The default value is true.

See also
isEnabled(), setEnabled()
PropertyType<string> kanzi::RenderPass::CameraProperty
static

Sets the Camera node that you want this render pass to use to render content.

The Camera node must be in the same Scene that is being rendered by the render pass tree. All descendant render passes use the selected camera unless you override it by setting the CameraProperty in those render passes.

See also
setCamera(), getCamera()
PropertyType<Vector4> kanzi::RenderPass::InputViewportAreaProperty
static

Reports the size of the Viewport 2D that uses this render pass.

Kanzi writes the value of this property when entering RenderPass::render(). Use this property to react to changes in viewport size as passed from parent rendering.

Since
Kanzi 3.9.3
ChildContainer kanzi::RenderPass::m_children
protected

Child render passes.

RenderPass* kanzi::RenderPass::m_parent
protected

Pointer to parent render pass.

Node* kanzi::RenderPass::m_hostNode
protected

Pointer to host node this render pass is attached under.

weak_ptr<RenderPass> kanzi::RenderPass::m_templateRoot
protected

Weak pointer to template root object of this render pass.

May be a node or a render pass.

PropertyType<Vector4>::Descriptor::TypedValueSource kanzi::RenderPass::m_inputViewportAreaValueSource
protected

Value source for the input viewport area property.

AttachmentState kanzi::RenderPass::m_attachmentState
protected

Render pass attachment state.

bool kanzi::RenderPass::m_enabled
protected

Render pass enabled state.

Updated when enabled property is updated.


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