Use the Blit Render Pass to blit one or more textures to the screen of the current rendering context using a material. More...

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

Inheritance diagram for kanzi::BlitRenderPass:

[legend]

Static Public Member Functions
static BlitRenderPassSharedPtr	create (Domain *domain, string_view name)
	Create a Blit Render Pass.

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

Static Public Member Functions inherited from kanzi::RenderPass
static RenderPassSharedPtr	create (Domain *domain, string_view name)
	Create a render pass.

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

Static Public Member Functions inherited from kanzi::Object
static const Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class.

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

Static Public Member Functions inherited from kanzi::MetaObject
static const Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class.

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

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

void	onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) override
	Object::onPropertyChanged() implementation.

void	renderOverride (Renderer3D &renderer, CompositionStack &compositionStack, const CameraSettings *cameraSettings) override
	RenderPass::renderOverride() implementation.

Protected Member Functions inherited from kanzi::RenderPass
Camera *	acquireCamera (string_view relativePath) const
	Acquires a Camera node based on the value of the Camera property.

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

CompositionRequirements	getChildCompositionRequirements ()
	Iterates the children for composition requirements.

virtual void	onAttached ()
	Called when a render pass becomes attached.

virtual void	onDetached ()
	Called when a render pass becomes detached.

void	onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) override
	Object::onPropertyChanged() implementation.

void	renderChildren (Renderer3D &renderer, CompositionStack &compositionStack, const CameraSettings *cameraSettings)
	Render all child render passes of a render pass.

virtual void	renderChildrenOverride (Renderer3D &renderer, CompositionStack &compositionStack, const CameraSettings *cameraSettings)
	Implementation-dependent rendering of all child render passes of a render pass.

	RenderPass (Domain *domain, string_view name)
	Constructor.

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.

Protected Member Functions inherited from kanzi::GPUResource
virtual void	destroyOverride ()
	Destroys all GPU resources.

virtual unsigned int	getGPUMemoryUsageOverride () const
	Gets the amount of GPU memory consumed by the resource.

	GPUResource (Domain *domain, string_view name="")
	Constructor.

virtual void	invalidateOverride ()
	Notifies resource that graphics context was lost and all GPU resources are invalid. Called by invalidate().

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.

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.

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

AbstractPropertyTypeDescriptor::NotificationStorage *	acquireNotificationStorage (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.

void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner owner)
	Internally adds a property value source.

void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, PropertyValuePrecedence precedence, void ownerPointer)
	Internally adds a property value source.

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

PropertyStoragePtr	constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

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

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.

PropertyStoragePtr	findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
	Gets property storage intrusive pointer which you can use to hold a reference until the end of the operation.

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

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

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

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.

virtual void	notifyPropertyHandlers (PropertyStoragePtr &storagePtr, PropertyNotificationReason reason)
	Notifies all property handlers on a property storage.

void	onCopy (const PropertyObject &other)

void	removeLocalValue (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
	Removes a local value from the given property storage.

void	removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, void owner)
	Removes a property value source.

void	validatePropertyModifiers (PropertyStoragePtr &propertyStorage)
	Validates property modifiers without notifying handlers.

void	validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)
	Validates property modifiers and notifies handlers.

Protected Member Functions inherited from kanzi::BindingHostConceptImpl< RenderPass >
RenderPass *	getThisObject ()
	Internal accessor for the Curiously Recurring Template Pattern.

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

Protected Member Functions inherited from kanzi::BindingHostConcept
void	attachBindings ()
	Attach all bindings stored in this object.

void	detachBindings ()
	Detach bindings.

Properties
static PropertyType< ResourceSharedPtr >	Texture0Property
	Use the Texture0 property to set the first texture you want a Blit Render Pass to blit.

static PropertyType< ResourceSharedPtr >	Texture1Property
	Use the Texture1 property to set the second texture you want a Blit Render Pass to blit.

static PropertyType< ResourceSharedPtr >	Texture2Property
	Use the Texture2 property to set the third texture you want a Blit Render Pass to blit.

static PropertyType< ResourceSharedPtr >	Texture3Property
	Use the Texture3 property to set the fourth texture you want a Blit Render Pass to blit.

static PropertyType< ResourceSharedPtr >	TextureCubemapProperty
	Sets the cubemap texture that the Blit Render Pass blits.

static PropertyType< ResourceSharedPtr >	MaterialProperty
	Use the Material property to set the material that you want a Blit Render Pass to use to blit one or more textures.

ResourceSharedPtr	getTexture0 () const
	Gets the value of the Texture0Property property.

void	setTexture0 (ResourceSharedPtr value)
	Sets the value of the Texture0Property property.

ResourceSharedPtr	getTexture1 () const
	Gets the value of the Texture1Property property.

void	setTexture1 (ResourceSharedPtr value)
	Sets the value of the Texture1Property property.

ResourceSharedPtr	getTexture2 () const
	Gets the value of the Texture2Property property.

void	setTexture2 (ResourceSharedPtr value)
	Sets the value of the Texture2Property property.

ResourceSharedPtr	getTexture3 () const
	Gets the value of the Texture3Property property.

void	setTexture3 (ResourceSharedPtr value)
	Sets the value of the Texture3Property property.

ResourceSharedPtr	getTextureCubemap () const
	Gets the value of the TextureCubemapProperty property.

void	setTextureCubemap (ResourceSharedPtr value)
	Sets the value of the TextureCubemapProperty property.

ResourceSharedPtr	getMaterial () const
	Gets the value of the MaterialProperty property.

void	setMaterial (ResourceSharedPtr value)
	Sets the value of the MaterialProperty property.

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.

typedef vector< AbstractBindingRuntimeSharedPtr >	BindingRuntimeContainer
	Container type for binding runtimes.

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

using	CameraSettingsPtr
	Camera settings unique pointer type.

typedef ChildContainer::const_iterator	ChildConstIterator
	Child container iterator type.

typedef vector< RenderPassSharedPtr >	ChildContainer
	Container type for children.

Public Types inherited from kanzi::GPUResource
enum	MemoryType { GpuOnly , GpuAndRam , RamOnly }
	Memory upload and RAM preservation strategy for GPU resources. 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
	Binding host concept shared pointer type.

using	BindingRuntimeConstIterator
	Const iterator for binding runtimes.

using	BindingRuntimeContainer
	Container for binding runtimes.

using	BindingRuntimeIterator
	Iterator for binding runtimes.

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.

void	attach ()
	Attaches the render pass.

void	attachRecursive (Node &node)
	Recursively attaches a render pass tree.

ChildConstIterator	beginChildren () const
	Returns an iterator to the beginning of the container of child render passes.

BindingLookupContextPtr	createLookupContext (RenderPassSharedPtr templateRoot)
	Creates a lookup context for a given render pass.

void	detach ()
	Detaches the render pass.

void	detachRecursive ()
	Recursively detaches a render pass tree.

ChildConstIterator	endChildren () const
	Returns an iterator to the end of the container of child render passes.

string	getCamera () const
	Gets the value of the CameraProperty.

RenderPassSharedPtr	getChild (size_t index)
	Gets a child render pass at the given index.

size_t	getChildCount () const
	Returns the number of child render passes.

size_t	getChildIndex (RenderPass &childRenderPass) const
	Gets the index of a child in this render pass.

virtual CompositionRequirements	getCompositionRequirements ()
	Queries if a render pass requires a depth buffer.

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

Vector4	getInputViewport () const
	Gets the value of InputViewportAreaProperty.

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

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

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

int	getUpdateOffset () const
	Gets the update offset of the Render Pass.

int	getUpdateRate () const
	Gets the value of UpdateRateProperty.

Viewport2D *	getViewportForRenderPass () const
	Gets a viewport parent for a render pass.

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.

bool	isAttached () const
	Tells if a render pass is attached.

bool	isAttaching () const
	Tells if a render pass is attaching.

virtual bool	isDeployedOverride () const override
	Indicates whether a GPU resource is deployed.

bool	isDetached () const
	Tells if a render pass is detached.

bool	isDetaching () const
	Tells if render pass is detaching.

bool	isEnabled () const
	Gets the value of the EnabledProperty property.

ObjectSharedPtr	lookupObject (string_view relativePath)
	Lookup for an object from a node.

template<typename T >
shared_ptr< T >	lookupObject (string_view relativePath)
	Lookup a relative object of specific type.

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

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

void	removeChild (size_t index)
	Removes a child render pass.

void	render (Renderer3D &renderer, CompositionStack &compositionStack, const CameraSettings *cameraSettings)
	Recursively render RenderPass and all of its child render passes.

virtual void	restoreResources ()
	Restore resources after suspend.

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

void	setCamera (string_view value)
	Sets the value of the CameraProperty.

void	setEnabled (bool value)
	Sets the value of the EnabledProperty.

void	setHostNode (Node *hostNode)
	Sets the host node of a render pass.

void	setParent (RenderPass *parent)
	Sets the parent of a render pass.

void	setTemplateRoot (RenderPassSharedPtr templateRoot)
	Sets the template root for this render pass.

void	setUpdateRate (int updateRate)
	Sets the value of UpdateRateProperty.

void	setUpdateRateOffset (int updateOffset)
	Sets the value of UpdateOffsetProperty.

	~RenderPass () override
	Destructor.

Public Member Functions inherited from kanzi::GPUResource
void	destroy ()
	Destroys a GPU resource.

unsigned int	getGPUMemoryUsage () const

Renderer *	getRenderer () const

void	invalidate ()
	Notify resource that graphics context was lost and all GPU resources are invalid.

bool	isDeployed () const

	~GPUResource () override

Public Member Functions inherited from kanzi::Resource
virtual unsigned int	getCPUMemoryUsage () const
	Function for getting the memory usage of a resource.

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

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

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

void	reload ()

void	reloadFromFile (string_view filePath)

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

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

void	setUrl (string_view url)
	Sets the resource URL.

	~Resource () override
	Destructor.

Public Member Functions inherited from kanzi::Object
AppliedStyleEntrySharedPtr	applyObjectStyle (kanzi::StyleSharedPtr style)
	Applies a style to an object.

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

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

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

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

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

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

ScriptingContextSharedPtr	getScriptingContext () const
	Gets the scripting context of the object.

	Object (Domain *domain)

void	setScriptingContext (ScriptingContextSharedPtr context)
	Sets the scripting context of the object.

void	unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)

void	unapplyObjectStyles ()
	Unapplies and removes all applied styles.

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

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.

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, AbstractPropertyTypeDescriptor::ValueSourceOwner owner)

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

PropertyStorageContainer::iterator	beginPropertyStorage ()
	Returns the begin iterator to the internal property storage container.

PropertyStorageContainer::const_iterator	beginPropertyStorage () const
	Returns the begin iterator to the internal property storage container.

void	clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

void	copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType)
	Copies local value of single property from another object.

void	copyLocalValues (const PropertyObject &other)
	Copies all local values from another object.

PropertyStorageContainer::iterator	endPropertyStorage ()
	Returns the end iterator to the internal property storage container.

PropertyStorageContainer::const_iterator	endPropertyStorage () const
	Returns the end iterator to the internal property storage container.

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.

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.

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

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

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

bool	hasBaseValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value, disregarding modifiers.

bool	hasLocalValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a local value set for the property.

bool	hasNonClassValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a value of any precedence higher than class default value set for the property.

bool	hasValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value.

bool	isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const

	PropertyObject ()

void	removeKzbProperties ()
	Remove all KZB properties.

void	removeKzbProperties (flat_set< AbstractPropertyType > *keepProperties)
	Remove all KZB properties that are not included in a given set.

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.

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.

void	setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

KZ_DEPRECATED void	validatePropertyModifiers (AbstractPropertyType propertyType)
	Validates property modifiers and notifies handlers.

void	validatePropertyModifiersAndNotifyHandlers (AbstractPropertyType propertyType)
	Validates property modifiers and notifies handlers.

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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

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

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

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

BindingRuntimeHandle	setModifierBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType)
	Wrapper for setting a modifier binding.

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

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

Public Member Functions inherited from kanzi::BindingHostConcept
BindingRuntimeConstIterator	beginBindingRuntimes () const
	Returns an iterator to the beginning of binding runtimes.

BindingRuntimeConstIterator	endBindingRuntimes () const
	Returns an iterator to the end of binding runtimes.

AbstractBindingRuntimeSharedPtr	getBindingRuntime (size_t idx)
	Gets binding by index.

size_t	getBindingRuntimeCount () const
	Gets the number of binding runtimes added to this node.

void	removeAllBindings ()
	Removes all binding runtimes.

void	removeBinding (BindingRuntimeHandle &bindingRuntime)
	Removes a binding runtime added earlier.

void	removeBindingsWithOwner (shared_ptr< void > owner)
	Removes all binding runtimes with the specified owner.

Static Public Attributes inherited from kanzi::RenderPass
static PropertyType< string >	CameraProperty
	Sets the Camera node that you want this render pass to use to render content.

static PropertyType< bool >	EnabledProperty
	Use the Enabled property to turn render passes and render pass trees on or off.

static PropertyType< Vector4 >	InputViewportAreaProperty
	Reports the size of the Viewport 2D that uses this render pass.

static PropertyType< int >	UpdateOffsetProperty
	Sets the offset to add to the frame count when calculating the update rate of the Render Pass.

static PropertyType< int >	UpdateRateProperty
	Sets the rate at which to render the Render Pass.

Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtr >	AppliedStyleContainer
	Applied style container.

Protected Attributes inherited from kanzi::RenderPass
AttachmentState	m_attachmentState
	Render pass attachment state.

ChildContainer	m_children
	Child render passes.

bool	m_enabled
	Render pass enabled state.

uint64_t	m_frameNumber
	Current frame number used for update rate control.

Node *	m_hostNode
	Pointer to host node this render pass is attached under.

PropertyType< Vector4 >::Descriptor::TypedValueSource	m_inputViewportAreaValueSource
	Value source for the input viewport area property.

RenderPass *	m_parent
	Pointer to parent render pass.

weak_ptr< RenderPass >	m_templateRoot
	Weak pointer to template root object of this render pass.

uint64_t	m_updateOffset
	Current update rate offset property value cached.

uint64_t	m_updateRate
	Current update rate property value cached.

Protected Attributes inherited from kanzi::Object
AppliedStyleContainer	m_appliedStyles
	Listing of applied styles applied to this object.

Protected Attributes inherited from kanzi::BindingHostConcept
BindingRuntimeContainer	m_bindingRuntimes
	Bindings in this object.

Detailed Description

Use the Blit Render Pass to blit one or more textures to the screen of the current rendering context using a material.

After the blit operation, a Blit Render Pass passes the control to its descendants and then further to its siblings and parent.

Use the Blit Render Pass to show the result of other render passes. For example, to show the result of a Composition Target Render Pass, in the Blit Render Pass bind one of the texture properties (Texture0Property, Texture1Property, Texture2Property, or Texture3Property) to the render target texture that the Composition Target Render Pass creates:

        // To show the result of a Composition Target Render Pass, in the Blit Render Pass bind the Texture0Property
        // to a Composition Target Render Pass. In this example, the "Composition Target Render Pass" is a sibling
        // to the Blit Render Pass.
        AbstractBindingSharedPtr binding = Binding::create("../Composition Target Render Pass", CompositionTargetRenderPass::ResultTexture0Property);
        blitRenderPass->setBinding(binding, BlitRenderPass::Texture0Property, PropertyValuePrecedenceLocal);

Kanzi Studio uses a default blit material named "DefaultBlitMaterial" which is in the resource dictionary of the Screen node. This default blit material uses only the Texture0Property and its purpose is to show the result of a CompositionTargetRenderPass.

If you use your own materials in a Blit Render Pass, to ensure ease of use in Kanzi Studio projects, use the Blit Render Pass default texture properties.

Constructor & Destructor Documentation

◆ BlitRenderPass()

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

explicitprotected

Constructor.

Parameters

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

Member Function Documentation

◆ getTexture0()

ResourceSharedPtr kanzi::BlitRenderPass::getTexture0 ( ) const

inline

Gets the value of the Texture0Property property.

See also: setTexture0()

◆ setTexture0()

void kanzi::BlitRenderPass::setTexture0 ( ResourceSharedPtr value )

inline

Sets the value of the Texture0Property property.

See also: getTexture0()

◆ getTexture1()

ResourceSharedPtr kanzi::BlitRenderPass::getTexture1 ( ) const

inline

Gets the value of the Texture1Property property.

See also: setTexture1()

◆ setTexture1()

void kanzi::BlitRenderPass::setTexture1 ( ResourceSharedPtr value )

inline

Sets the value of the Texture1Property property.

See also: getTexture1()

◆ getTexture2()

ResourceSharedPtr kanzi::BlitRenderPass::getTexture2 ( ) const

inline

Gets the value of the Texture2Property property.

See also: setTexture2()

◆ setTexture2()

void kanzi::BlitRenderPass::setTexture2 ( ResourceSharedPtr value )

inline

Sets the value of the Texture2Property property.

See also: getTexture2()

◆ getTexture3()

ResourceSharedPtr kanzi::BlitRenderPass::getTexture3 ( ) const

inline

Gets the value of the Texture3Property property.

See also: setTexture3()

◆ setTexture3()

void kanzi::BlitRenderPass::setTexture3 ( ResourceSharedPtr value )

inline

Sets the value of the Texture3Property property.

See also: getTexture3()

◆ getTextureCubemap()

ResourceSharedPtr kanzi::BlitRenderPass::getTextureCubemap ( ) const

inline

Gets the value of the TextureCubemapProperty property.

See also: setTextureCubemap()

Since: Kanzi 3.9.10

◆ setTextureCubemap()

void kanzi::BlitRenderPass::setTextureCubemap ( ResourceSharedPtr value )

inline

Sets the value of the TextureCubemapProperty property.

See also: getTextureCubemap()

Since: Kanzi 3.9.10

◆ getMaterial()

ResourceSharedPtr kanzi::BlitRenderPass::getMaterial ( ) const

inline

Gets the value of the MaterialProperty property.

See also: setMaterial()

◆ setMaterial()

void kanzi::BlitRenderPass::setMaterial ( ResourceSharedPtr value )

inline

Sets the value of the MaterialProperty property.

See also: getMaterial()

◆ makeEditorInfo()

static PropertyTypeEditorInfoSharedPtr kanzi::BlitRenderPass::makeEditorInfo ( )

static

◆ create()

static BlitRenderPassSharedPtr kanzi::BlitRenderPass::create	(	Domain *	domain,
		string_view	name )

static

Create a Blit Render Pass.

Parameters

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

Returns: The created Blit Render Pass.

◆ onPropertyChanged()

void kanzi::BlitRenderPass::onPropertyChanged	(	AbstractPropertyType	propertyType,
		PropertyNotificationReason	reason )

overrideprotectedvirtual

Object::onPropertyChanged() implementation.

Reimplemented from kanzi::PropertyObject.

◆ renderOverride()

void kanzi::BlitRenderPass::renderOverride	(	Renderer3D &	renderer,
		CompositionStack &	compositionStack,
		const CameraSettings *	cameraSettings )

overrideprotectedvirtual

RenderPass::renderOverride() implementation.

Reimplemented from kanzi::RenderPass.

Member Data Documentation

◆ Texture0Property

PropertyType<ResourceSharedPtr> kanzi::BlitRenderPass::Texture0Property

static

Use the Texture0 property to set the first texture you want a Blit Render Pass to blit.

The default value is ResourceSharedPtr().

See also: setTexture0(), getTexture0()

◆ Texture1Property

PropertyType<ResourceSharedPtr> kanzi::BlitRenderPass::Texture1Property

static

Use the Texture1 property to set the second texture you want a Blit Render Pass to blit.

The default value is ResourceSharedPtr().

See also: setTexture1(), getTexture1()

◆ Texture2Property

PropertyType<ResourceSharedPtr> kanzi::BlitRenderPass::Texture2Property

static

Use the Texture2 property to set the third texture you want a Blit Render Pass to blit.

The default value is ResourceSharedPtr().

See also: setTexture2(), getTexture2()

◆ Texture3Property

PropertyType<ResourceSharedPtr> kanzi::BlitRenderPass::Texture3Property

static

Use the Texture3 property to set the fourth texture you want a Blit Render Pass to blit.

The default value is ResourceSharedPtr().

See also: setTexture3(), getTexture3()

◆ TextureCubemapProperty

PropertyType<ResourceSharedPtr> kanzi::BlitRenderPass::TextureCubemapProperty

static

Sets the cubemap texture that the Blit Render Pass blits.

The default value is ResourceSharedPtr().

See also: setTextureCubemap(), getTextureCubemap()

Since: Kanzi 3.9.10

◆ MaterialProperty

PropertyType<ResourceSharedPtr> kanzi::BlitRenderPass::MaterialProperty

static

Use the Material property to set the material that you want a Blit Render Pass to use to blit one or more textures.

The default value is ResourceSharedPtr().

See also: setMaterial(), getMaterial()

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

kanzi/core.ui/graphics3d/blit_render_pass.hpp

Static Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BlitRenderPass()

Member Function Documentation

◆ getTexture0()

◆ setTexture0()

◆ getTexture1()

◆ setTexture1()

◆ getTexture2()

◆ setTexture2()

◆ getTexture3()

◆ setTexture3()

◆ getTextureCubemap()

◆ setTextureCubemap()

◆ getMaterial()

◆ setMaterial()

◆ makeEditorInfo()

◆ create()

◆ onPropertyChanged()

◆ renderOverride()

Member Data Documentation

◆ Texture0Property

◆ Texture1Property

◆ Texture2Property

◆ Texture3Property

◆ TextureCubemapProperty

◆ MaterialProperty