Use a Clear Render Pass to clear the color, depth, and stencil buffers of the current render context before passing the control to the descendants of this render pass. More...

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

Inheritance diagram for kanzi::ClearRenderPass:

[legend]

Static Public Member Functions
static ClearRenderPassSharedPtr	create (Domain *domain, string_view name)
	Creates a Clear Render Pass. More...

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

Static Public Member Functions inherited from kanzi::RenderPass
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 Metaclass *	getStaticMetaclass ()
	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 Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class. More...

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info. More...

Protected Member Functions
	ClearRenderPass (Domain *domain, string_view name)
	Constructor. More...

CompositionRequirements	getCompositionRequirements () override
	RenderPass::getCompositionRequirements() implementation. More...

void	renderOverride (Renderer3D &renderer, CompositionStack &compositionStack) override
	RenderPass::renderOverride() implementation. More...

Protected Member Functions inherited from kanzi::RenderPass
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)
	Render all child render passes of a render pass. More...

	RenderPass (Domain *domain, string_view name)
	Constructor. 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 ()

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::ValueSourceEntry *	acquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
	Acquires a local value source entry that is free for the assignment of a value. More...

AbstractPropertyTypeDescriptor::ModifierStorage *	acquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)

AbstractPropertyTypeDescriptor::NotificationStorage *	acquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)

PropertyStoragePtr	acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

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::ValueSourceEntry *	constructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)

PropertyStoragePtr	constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

void	copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &otherPropertyStorage)
	Copy local value from property storage. More...

AbstractPropertyTypeDescriptor::ModifierStorage *	findModifierStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::NotificationStorage *	findNotificationStorage (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::PropertyStorage *	findPropertyStorage (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...

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByNameAndDataType (string_view name, PropertyDataType dataType) const
	Finds a property type descriptor by name and data type. More...

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByQualifiedNameAndDataType (string_view qualifiedName, PropertyDataType dataType) const
	Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with qualified names. More...

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType) const
	Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with unqualified names. More...

AbstractPropertyTypeDescriptor::ValueSource *	getClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const
	Gets the top-level value source for a given property descriptor. More...

virtual void	notifyPropertyHandlers (PropertyStoragePtr &propertyStorage, PropertyNotificationReason reason)

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	validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)

Protected Member Functions inherited from kanzi::BindingHostConceptImpl< RenderPass >
BindingTargetRuntimePtr	createModifierBindingTarget (shared_ptr< RenderPass > templateRoot, AbstractPropertyType propertyType, PropertyField field)
	Creates a property modifier binding target for given combination of property type and field. More...

BindingTargetRuntimePtr	createValueSourceBindingTarget (shared_ptr< RenderPass > templateRoot, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence, bool reuseAllowed)
	Creates a value source binding target for given combination of property type and field. More...

RenderPass *	getThisObject ()
	Internal accessor for the Curiously Recurring Template Pattern. More...

const RenderPass *	getThisObject () 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...

Properties
static PropertyType< ColorRGBA >	ClearColor0Property
	Use the Clear Color 0 property to set the color that you want the Clear Render Pass to use to clear the first color buffer. More...

static PropertyType< ColorRGBA >	ClearColor1Property
	Use the Clear Color 1 property to set the color that you want the Clear Render Pass to use to clear the second color buffer. More...

static PropertyType< ColorRGBA >	ClearColor2Property
	Use the Clear Color 2 property to set the color that you want the Clear Render Pass to use to clear the third color buffer. More...

static PropertyType< ColorRGBA >	ClearColor3Property
	Use the Clear Color 3 property to set the color that you want the Clear Render Pass to use to clear the fourth color buffer. More...

static PropertyType< float >	ClearDepthProperty
	Use the Clear Depth property to set the depth that you want the Clear Render Pass to use to clear the depth buffer. More...

static PropertyType< int >	ClearStencilProperty
	Use the Clear Stencil property to set the clear stencil that you want the Clear Render Pass to use to clear the stencil buffer. More...

ColorRGBA	getClearColor0 () const
	Gets the value of the ClearColor0Property property. More...

void	setClearColor0 (ColorRGBA value)
	Sets the value of the ClearColor0Property property. More...

float	getClearDepth () const
	Gets the value of the ClearDepthProperty property. More...

void	setClearDepth (float value)
	Sets the value of the ClearDepthProperty property. More...

int	getClearStencil () const
	Gets the value of the ClearStencilProperty property. More...

void	setClearStencil (int value)
	Sets the value of the ClearStencilProperty property. More...

Additional Inherited Members
Public Types inherited from kanzi::RenderPass
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< AbstractBindingRuntimeSharedPtr >	BindingRuntimeContainer
	Container type for binding runtimes. More...

typedef BindingRuntimeContainer::iterator	BindingRuntimeIterator
	Iterator type for binding runtime container. More...

typedef ChildContainer::const_iterator	ChildConstIterator
	Child container iterator type. More...

typedef vector< RenderPassSharedPtr >	ChildContainer
	Container type for children. More...

Public Types inherited from kanzi::PropertyObject
typedef PropertyStorageContainer::const_iterator	PropertyStorageConstIterator

typedef vector< PropertyStoragePtr >	PropertyStorageContainer

typedef PropertyStorageContainer::iterator	PropertyStorageIterator

typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStorage >	PropertyStoragePtr

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 inherited from kanzi::RenderPass
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...

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...

Node *	getHostNode () const
	Gets the host node of a render pass. More...

RenderPass *	getParent () const
	Gets the parent of a render pass. More...

Scene *	getSceneForRenderPass () const
	Gets the scene being rendered by the render pass. More...

RenderPassSharedPtr	getTemplateRoot () const
	Gets the template root of this render pass. More...

Viewport2D *	getViewportForRenderPass () 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< T >	lookupObject (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)
	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	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)

	Resource (Domain *domain, string_view name)
	Constructor. More...

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...

Domain *	getDomain () const
	Returns the domain the object belongs to. More...

const Metaclass *	getDynamicMetaclass () const override
	Returns the metaclass of the dynamic type of the object. More...

MainLoopScheduler *	getMainLoopScheduler () const
	Returns the MainLoopScheduler instance of the associated Domain. More...

detail::MessageDispatcher *	getMessageDispatcher () const
	Returns the message dispatcher of the object. More...

ResourceManager *	getResourceManager () 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	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 ()

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)

void	validatePropertyModifiers (AbstractPropertyType propertyType)

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...

AbstractBindingRuntimeSharedPtr	setBinding (AbstractBindingSharedPtr binding, shared_ptr< RenderPass > templateRoot, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence)
	Wrapper for setting a binding. More...

AbstractBindingRuntimeSharedPtr	setBinding (AbstractBindingSharedPtr binding, shared_ptr< RenderPass > templateRoot, AbstractPropertyType propertyType, PropertyField field)
	Wrapper for setting a binding. More...

AbstractBindingRuntimeSharedPtr	setBinding (AbstractBindingSharedPtr binding, shared_ptr< RenderPass > templateRoot, AbstractPropertyType propertyType, PropertyValuePrecedence precedence)
	Wrapper for setting a binding. More...

AbstractBindingRuntimeSharedPtr	setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence)
	Wrapper for setting a binding. More...

AbstractBindingRuntimeSharedPtr	setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyField field)
	Wrapper for setting a binding. More...

AbstractBindingRuntimeSharedPtr	setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyValuePrecedence precedence)
	Wrapper for setting a binding. More...

AbstractBindingRuntimeSharedPtr	setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType)
	Wrapper for setting a binding. More...

AbstractBindingRuntimeSharedPtr	setBinding (AbstractBindingSharedPtr binding, shared_ptr< RenderPass > templateRoot)
	Sets a binding with no target. More...

AbstractBindingRuntimeSharedPtr	setBinding (AbstractBindingSharedPtr binding)
	Wrapper for setting a binding with no target. More...

AbstractBindingRuntimeSharedPtr	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...

AbstractBindingRuntimeSharedPtr	setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence)
	Wrapper for setting a binding with owner. More...

AbstractBindingRuntimeSharedPtr	setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType)
	Wrapper for setting a binding with owner. More...

AbstractBindingRuntimeSharedPtr	setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, shared_ptr< RenderPass > templateRoot)
	Sets a binding with no target. More...

AbstractBindingRuntimeSharedPtr	setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner)
	Wrapper for setting a binding with no target. More...

AbstractBindingRuntimeSharedPtr	setModifierBinding (AbstractBindingSharedPtr binding, shared_ptr< RenderPass > templateRoot, AbstractPropertyType propertyType, PropertyField field)
	Wrapper for setting a modifier binding. More...

AbstractBindingRuntimeSharedPtr	setModifierBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyField field)
	Wrapper for setting a modifier binding. More...

AbstractBindingRuntimeSharedPtr	setModifierBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType)
	Wrapper for setting a modifier binding. More...

AbstractBindingRuntimeSharedPtr	setModifierBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, shared_ptr< RenderPass > templateRoot, AbstractPropertyType propertyType, PropertyField field)
	Sets a modifier binding. More...

AbstractBindingRuntimeSharedPtr	setModifierBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType, PropertyField field)
	Wrapper for setting a modifier binding. More...

AbstractBindingRuntimeSharedPtr	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 (AbstractBindingRuntime &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 Attributes inherited from kanzi::RenderPass
static PropertyType< bool >	EnabledProperty
	Use the Enabled property to turn render passes and render pass trees on or off. More...

Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtr >	AppliedStyleContainer
	Applied style container. 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...

Detailed Description

Use a Clear Render Pass to clear the color, depth, and stencil buffers of the current render context before passing the control to the descendants of this render pass.

When you create a Clear Render Pass using the API, it does not clear any buffers. However, when you create a Clear Render Pass in Kanzi Studio, the render pass clears the depth buffer.

You control which buffers a Clear Render Pass clears by setting in the render pass the properties for those buffers. To disable the clearing of a buffer, remove from that render pass the property for the buffer the clearing of which you want to disable.

Clear values

To clear any of the four color buffers, set the ClearColor0Property, ClearColor1Property, ClearColor2Property, or ClearColor3Property to an RGBA color. Values for each color range from 0.0f to 1.0f. When using the Clear Render Pass in Kanzi Studio, the most common use cases include clearing to either transparent black or any given opaque color. ColorRGBA::transparentBlack() is synonymous to ColorRGBA(0.0f, 0.0f, 0.0f, 0.0f) and provided for convenience.

To clear the depth buffer, set the ClearDepthProperty to a value between 0.0f and 1.0f. 1.0f represents the largest possible value in the depth buffer and is the most commonly used value. Unless you want to achieve a very specific effect, set the value of the ClearDepthProperty to either 1.0f or do not set the value at all.

To clear the stencil buffer, set the ClearStencilProperty to a value between 0 and 255. Since the stencil buffer is usually 8 bits, this means any 8-bit unsigned integer. For example, use the ClearStencilProperty to reset the stencil buffer before masking areas in it.

Examples

To create a Clear Render Pass and set it to clear buffers:

        // Create a Clear Render Pass.
        ClearRenderPassSharedPtr clearRenderPass = ClearRenderPass::create(domain, "Clear Render Pass");
        
        // Set the clear depth to 1.0f, the highest possible depth.
        // All depth comparisons using depth test function "less" pass after the clear.
        clearRenderPass->setClearDepth(1.0f);
        // Set the Clear Color property to transparent black.
        clearRenderPass->setClearColor0(ColorRGBA(0.0f, 0.0f, 0.0f, 0.0f));

Constructor & Destructor Documentation

◆ ClearRenderPass()

kanzi::ClearRenderPass::ClearRenderPass	(	Domain *	domain,
		string_view	name
	)

explicitprotected

Constructor.

Parameters

domain	The domain to use.
name	The name of the Clear Render Pass.

Member Function Documentation

◆ getClearColor0()

ColorRGBA kanzi::ClearRenderPass::getClearColor0 ( ) const

inline

Gets the value of the ClearColor0Property property.

See also: setClearColor0()

Since: Kanzi 3.9.0

◆ setClearColor0()

void kanzi::ClearRenderPass::setClearColor0 ( ColorRGBA value )

inline

Sets the value of the ClearColor0Property property.

See also: getClearColor0()

Since: Kanzi 3.9.0

◆ getClearDepth()

float kanzi::ClearRenderPass::getClearDepth ( ) const

inline

Gets the value of the ClearDepthProperty property.

See also: setClearDepth()

◆ setClearDepth()

void kanzi::ClearRenderPass::setClearDepth ( float value )

inline

Sets the value of the ClearDepthProperty property.

See also: getClearDepth()

◆ getClearStencil()

int kanzi::ClearRenderPass::getClearStencil ( ) const

inline

Gets the value of the ClearStencilProperty property.

See also: setClearStencil()

◆ setClearStencil()

void kanzi::ClearRenderPass::setClearStencil ( int value )

inline

Sets the value of the ClearStencilProperty property.

See also: getClearStencil()

◆ makeEditorInfo()

static PropertyTypeEditorInfoSharedPtr kanzi::ClearRenderPass::makeEditorInfo ( )

static

◆ create()

static ClearRenderPassSharedPtr kanzi::ClearRenderPass::create	(	Domain *	domain,
		string_view	name
	)

static

Creates a Clear Render Pass.

Parameters

domain	The domain to use.
name	The name of the Clear Render Pass.

Returns: The created Clear Render Pass.

◆ renderOverride()

void kanzi::ClearRenderPass::renderOverride	(	Renderer3D &	renderer,
		CompositionStack &	compositionStack
	)

overrideprotectedvirtual

RenderPass::renderOverride() implementation.

Reimplemented from kanzi::RenderPass.

◆ getCompositionRequirements()

CompositionRequirements kanzi::ClearRenderPass::getCompositionRequirements ( )

overrideprotectedvirtual

RenderPass::getCompositionRequirements() implementation.

Reimplemented from kanzi::RenderPass.

Member Data Documentation

◆ ClearColor0Property

PropertyType<ColorRGBA> kanzi::ClearRenderPass::ClearColor0Property

static

Use the Clear Color 0 property to set the color that you want the Clear Render Pass to use to clear the first color buffer.

The default value is sRGB ColorRGBA(0.4f, 0.4f, 0.4f, 1.0f).

See also: setClearColor0(), getClearColor0()

Since: Kanzi 3.9.0

◆ ClearColor1Property

PropertyType<ColorRGBA> kanzi::ClearRenderPass::ClearColor1Property

static

Use the Clear Color 1 property to set the color that you want the Clear Render Pass to use to clear the second color buffer.

The default value is sRGB ColorRGBA(0.0f, 0.0f, 0.0f, 0.0f).

Since: Kanzi 3.9.0

◆ ClearColor2Property

PropertyType<ColorRGBA> kanzi::ClearRenderPass::ClearColor2Property

static

Use the Clear Color 2 property to set the color that you want the Clear Render Pass to use to clear the third color buffer.

The default value is sRGB ColorRGBA(0.0f, 0.0f, 0.0f, 0.0f).

Since: Kanzi 3.9.0

◆ ClearColor3Property

PropertyType<ColorRGBA> kanzi::ClearRenderPass::ClearColor3Property

static

Use the Clear Color 3 property to set the color that you want the Clear Render Pass to use to clear the fourth color buffer.

The default value is sRGB ColorRGBA(0.0f, 0.0f, 0.0f, 0.0f).

Since: Kanzi 3.9.0

◆ ClearDepthProperty

PropertyType<float> kanzi::ClearRenderPass::ClearDepthProperty

static

Use the Clear Depth property to set the depth that you want the Clear Render Pass to use to clear the depth buffer.

The default value is 1.0f.

See also: setClearDepth(), getClearDepth()

◆ ClearStencilProperty

PropertyType<int> kanzi::ClearRenderPass::ClearStencilProperty

static

Use the Clear Stencil property to set the clear stencil that you want the Clear Render Pass to use to clear the stencil buffer.

The default value is 0.

See also: setClearStencil(), getClearStencil()

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

kanzi/core.ui/graphics3d/clear_render_pass.hpp

Static Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Clear values

Examples

Constructor & Destructor Documentation

◆ ClearRenderPass()

Member Function Documentation

◆ getClearColor0()

◆ setClearColor0()

◆ getClearDepth()

◆ setClearDepth()

◆ getClearStencil()

◆ setClearStencil()

◆ makeEditorInfo()

◆ create()

◆ renderOverride()

◆ getCompositionRequirements()

Member Data Documentation

◆ ClearColor0Property

◆ ClearColor1Property

◆ ClearColor2Property

◆ ClearColor3Property

◆ ClearDepthProperty

◆ ClearStencilProperty