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:

Static Public Member Functions
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

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

Static Public Member Functions inherited from kanzi::RenderPass
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

static RenderPassSharedPtr	create (Domain *domain, string_view name)
	Create a render pass. More...

static RenderPassSharedPtr	loadFromKZB (Domain *domain, string_view name, KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)
	Load and create a render pass from a kzb file. More...

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

virtual void	renderOverride (Renderer3D &renderer, TransformedScene3D &transformedScene, CompositionStack &compositionStack) KZ_OVERRIDE
	RenderPass::renderOverride() implementation. More...

virtual CompositionRequirements	getCompositionRequirements () const KZ_OVERRIDE
	RenderPass::requiresDepthBuffer() implementation. More...

Protected Member Functions inherited from kanzi::RenderPass
	RenderPass (Domain *domain, string_view name)
	Constructor. More...

virtual void	loadFromKZB (Domain *domain, KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)
	Loads render passes from a kzb file. More...

void	loadChildRenderPassesFromKZB (ResourceManager &resourceManager, KzbMemoryParser &parser)
	Load child render passes from a kzb file. More...

void	loadProperties (KzbMemoryParser &parser)
	Reimplementation of the loadProperties from parser to accommodate paths in properties. More...

kzsError	readProperties (struct KzcInputStream inputStream, const struct KzuBinaryFileInfo file, ResourceManager *resourceManager)
	Reimplementation of the property reading to accommodate paths in properties. More...

kzsError	readProperty (struct KzcInputStream inputStream, const struct KzuBinaryFileInfo file, ResourceManager *resourceManager)
	Reimplementation of reading a single property to accommodate paths in properties. More...

void	renderChildren (Renderer3D &renderer, TransformedScene3D &transformedScene, CompositionStack &compositionStack)
	Render all child render passes of a render pass. More...

CompositionRequirements	combineChildCompositionRequirements (CompositionRequirements requirements) const
	Iterates the children for composition requirements. More...

CompositionRequirements	getChildCompositionRequirements () const
	Iterates the children for composition requirements. More...

virtual void	renderMeshOverride (Node3D &node, Morph *morph, Mesh &mesh, unsigned int clusterIndex, MaterialRenderer &materialRenderer)
	Mesh rendering that is specific for a render pass. More...

virtual TextureSharedPtr	getCompositionResultOverride (Framebuffer::AttachmentPoint attachmentPoint)
	Acquiring of composition target specific to the RenderPass class. More...

Protected Member Functions inherited from kanzi::Resource
virtual void	reloadOverride ()

virtual void	reloadFromKzbOverride (KzcInputStream inputStream, const KzuBinaryFileInfo file)

virtual void	reloadFromKzbOverride (KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)

virtual void	reloadFromFileOverride (string_view filePath)

virtual unsigned int	getCPUMemoryUsageOverride () const

Protected Member Functions inherited from kanzi::Object
void	initialize ()

void	onCopy (const Object &other)

Protected Member Functions inherited from kanzi::MetaObject
	MetaObject ()

void	initialize ()

Protected Member Functions inherited from kanzi::PropertyObject
void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, PropertyValuePrecedence precedence, void owner)

void	removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, void owner)

AbstractPropertyTypeDescriptor::ValueSourceEntry *	getTopValueSourceEntry (AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage) const

AbstractPropertyTypeDescriptor::ValueSourceEntry *	getTopValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor) const

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

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

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

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

AbstractPropertyTypeDescriptor::ValueSourceEntry *	findLocalValueSourceEntry (AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)

AbstractPropertyTypeDescriptor::ValueSourceEntry *	constructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)

AbstractPropertyTypeDescriptor::ValueSourceEntry *	acquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::PropertyStorage *	findPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const

PropertyStoragePtr	findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
	Gets property storage intrusive pointer that can be used to hold a reference until end of operation. More...

PropertyStoragePtr	constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

PropertyStoragePtr	acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::ModifierStorage *	acquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::ModifierStorage *	findModifierStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::NotificationStorage *	acquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::NotificationStorage *	findNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType)

void	validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)

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

PropertyStorageContainer::iterator	beginPropertyStorage ()

PropertyStorageContainer::iterator	endPropertyStorage ()

virtual void	notifyPropertyHandlers (PropertyStoragePtr &propertyStorage, PropertyNotificationReason reason)

void	onCopy (const PropertyObject &other)

Properties
static PropertyType< ColorRGBA >	ClearColorProperty
	Use the Clear Color property to set the color that you want the Clear Render Pass to use to clear the 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	getClearColor () const
	Gets the value of the ClearColorProperty property. More...

void	setClearColor (ColorRGBA value)
	Sets the value of the ClearColorProperty 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
typedef vector< RenderPassSharedPtr >	ChildContainer

Public Types inherited from kanzi::PropertyObject
typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStorage >	PropertyStoragePtr

typedef vector< PropertyStoragePtr >	PropertyStorageContainer

typedef PropertyStorageContainer::iterator	PropertyStorageIterator

typedef PropertyStorageContainer::const_iterator	PropertyStorageConstIterator

typedef PropertyStorageContainer::reverse_iterator	PropertyStorageReverseIterator

Public Member Functions inherited from kanzi::RenderPass
RenderPassSharedPtr	lookupRenderPass (string_view path)
	Resolve a render pass by path. More...

void	render (Renderer3D &renderer, TransformedScene3D &transformedScene, CompositionStack &compositionStack)
	Recursively render RenderPass and all of its child render passes. More...

void	renderMesh (Node3D &node, Morph *morph, Mesh &mesh, unsigned int clusterIndex, MaterialRenderer &materialRenderer)
	Use this function to render a mesh owned by a node using the material renderer that the node owns. More...

void	addChild (RenderPassSharedPtr childRenderPass)
	Adds a render pass as the last child of the render pass you set. 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...

void	removeChild (RenderPass &childRenderPass)
	Removes a child render pass. More...

void	removeAllChildren ()
	Removes all child render passes from a render pass. More...

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

void	setParent (RenderPassSharedPtr parent)
	Sets the parent of a render pass. 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...

ChildContainer::const_iterator	beginChildren () const
	Returns an iterator to the beginning of the container of child render passes. More...

ChildContainer::const_iterator	endChildren () const
	Returns an iterator to the end of the container of child render passes. More...

TextureSharedPtr	getCompositionResult (Framebuffer::AttachmentPoint attachmentPoint)
	Gets color composition target that was used for rendering. More...

size_t	getTextureBindingCount () const
	Gets the number of texture bindings. More...

ResourceBinding	getTextureBinding (size_t index) const
	Gets a texture binding by index. More...

void	addTextureBinding (AbstractPropertyType propertyType, string_view path, bool fromKzb)
	Adds a texture binding. More...

void	addTextureBinding (AbstractPropertyType propertyType, string_view path)
	Adds a texture binding. More...

bool	removeTextureBinding (AbstractPropertyType propertyType)
	Removes the texture binding. More...

void	removeKzbTextureBindings ()
	Removes the resource bindings loaded from kzb files. More...

void	restoreResourcesRecursive ()
	Recursively calls restoreResources for a RenderPass and all its children. More...

virtual void	restoreResources ()
	Restore resources after suspend. More...

virtual void	loadFromKZB (const ResourceLoaderThreadContext threadContext, KzcInputStream inputStream, const KzuBinaryFileInfo *file) KZ_OVERRIDE
	Resource::loadFromKZB() implementation. More...

Public Member Functions inherited from kanzi::Resource
KzcMemoryManager *	getMemoryManager () const

	Resource (Domain *domain, string_view name)

virtual	~Resource ()

virtual void	unloadOverride ()
	Unload function for resource. Releases all CPU memory taken by the resource except the resource loader. More...

virtual unsigned int	getCPUMemoryUsage () const
	Function for getting the memory usage of a resource. More...

void	setKZB (const KzuBinaryDirectory *binaryDirectory, string_view path)
	Set the binary directory and path of the resource. More...

const string &	getName () const
	Gets the resource name. More...

const string &	getUrl () const
	Gets the resource URL. More...

void	setUrl (string_view url)
	Sets the resource URL. More...

void	setNotLoaded ()

bool	isFromKZB () const

void	reload ()

void	reloadFromKzb (KzcInputStream inputStream, const KzuBinaryFileInfo file)

void	reloadFromKzb (KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)

void	reloadFromFile (string_view filePath)

void	load ()

void	unload ()

bool	isLoaded () const

void	kzuResourceLoad_private (const ResourceLoaderThreadContext *threadContext)
	Private function for kzuResourceLoad() with specified thread context. More...

void	kzuResourceFinishLoading_private (const ResourceLoaderThreadContext *threadContext)
	Private function for finishing the loading of the resource. More...

bool	isKeepAlive () const
	Tells if the resource has keep alive flag set. More...

void	setKeepAlive (bool keepAlive)
	Sets the keep alive flag. More...

Public Member Functions inherited from kanzi::Object
	Object (Domain *domain)

virtual	~Object ()

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

KzuTaskScheduler *	getTaskScheduler () const
	Returns the task scheduler of the object. More...

KzuMessageDispatcher *	getMessageDispatcher () const
	Returns the message dispatcher of the object. More...

ResourceManager *	getResourceManager () const
	Returns the resource manager of the object. More...

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

AppliedStyleEntrySharedPtr	applyObjectStyle (kanzi::StyleSharedPtr style)
	Applies a style to an object. More...

void	unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)

void	applyObjectStyles ()
	Apply all styles for an object node. More...

void	unapplyObjectStyles ()
	Unapplies and removes all applied styles. More...

Public Member Functions inherited from kanzi::MetaObject
virtual	~MetaObject ()

bool	isTypeOf (const Metaclass *objectType) const
	Determines if the type of this object is the given type or derived from it. More...

Public Member Functions inherited from kanzi::PropertyObject
	PropertyObject ()

virtual	~PropertyObject ()

template<typename DataType >
void	setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value)
	Sets the local value of a property. More...

void	removeKzbProperties ()

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getProperty (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property. More...

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 >
PropertyType< DataType >::Traits::ReturnType	getPropertyBase (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property disregarding modifiers. More...

template<typename DataType >
void	setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value)

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

void	setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

bool	isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const

void	clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

bool	hasValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value. 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...

void	removeLocalValue (AbstractPropertyType propertyType)
	Removes the local value associated with the property. More...

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

virtual void	onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason)
	Virtual function to handle property change notifications. More...

template<typename DataType >
void	addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, PropertyValuePrecedence precedence, void owner)

template<typename DataType >
void	removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, void owner)

template<typename DataType >
void	addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)

template<typename DataType >
void	removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)

void	validatePropertyModifiers (AbstractPropertyType propertyType)

template<typename DataType >
void	addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)

template<typename DataType >
void	removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)

template<typename DataType >
size_t	getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType)
	Gets number of current notification handlers for given property type. 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...

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

Valid value for the ClearColorProperty property is any 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.

Valid range for values in the ClearDepthProperty property is from 0.0f to 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 property to either 1.0f or do not set the value at all.

Valid range for values for the ClearStencilProperty property is from 0 to 255. Since the stencil buffer is usually 8 bits, this means any 8-bit unsigned integer. For example, use the ClearStencilProperty property, 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->setClearColor(ColorRGBA(0.0f, 0.0f, 0.0f, 0.0f));

Constructor & Destructor Documentation

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

ColorRGBA kanzi::ClearRenderPass::getClearColor ( ) const

inline

Gets the value of the ClearColorProperty property.

See also: setClearColor()

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

inline

Sets the value of the ClearColorProperty property.

See also: getClearColor()

float kanzi::ClearRenderPass::getClearDepth ( ) const

inline

Gets the value of the ClearDepthProperty property.

See also: setClearDepth()

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

inline

Sets the value of the ClearDepthProperty property.

See also: getClearDepth()

int kanzi::ClearRenderPass::getClearStencil ( ) const

inline

Gets the value of the ClearStencilProperty property.

See also: setClearStencil()

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

inline

Sets the value of the ClearStencilProperty property.

See also: getClearStencil()

static PropertyTypeEditorInfoSharedPtr kanzi::ClearRenderPass::makeEditorInfo ( )

static

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.

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

protectedvirtual

RenderPass::renderOverride() implementation.

Reimplemented from kanzi::RenderPass.

virtual CompositionRequirements kanzi::ClearRenderPass::getCompositionRequirements ( ) const

protectedvirtual

RenderPass::requiresDepthBuffer() implementation.

Reimplemented from kanzi::RenderPass.

Member Data Documentation

PropertyType<ColorRGBA> kanzi::ClearRenderPass::ClearColorProperty

static

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

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

See also: setClearColor(), getClearColor()

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()

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

Member Function Documentation

Member Data Documentation