Use the Pipeline State Render Pass to set for its child render passes the depth and stencil testing, transparency, and culling. More...

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

Inheritance diagram for kanzi::PipelineStateRenderPass:

[legend]

Public Types
enum	ViewportMode { ViewportModeAbsolute , ViewportModeRelative }

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.

Static Public Member Functions
static PipelineStateRenderPassSharedPtr	create (Domain *domain, string_view name)
	Create a Pipeline State 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
CompositionRequirements	getCompositionRequirements () override
	RenderPass::getCompositionRequirements() implementation.

	PipelineStateRenderPass (Domain *domain, string_view name)
	Constructor.

bool	pushColorBlend (CompositionStack &compositionStack)
	Push the color or blend state into the composition stack.

bool	pushDepthStencil (CompositionStack &compositionStack)
	Push the depth or stencil state into the composition stack.

bool	pushRasterization (CompositionStack &compositionStack)
	Push the rasterization state into the composition stack.

bool	pushViewportScissor (CompositionStack &compositionStack)
	Push the Viewport 2D scissor state into the composition stack.

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< int >	BlendModeProperty
	Use the Blend Mode property to override the blend mode set in each node that this render pass renders.

static PropertyType< GraphicsColorWriteMode >	ColorWriteModeProperty
	Use the Color Write Mode property to set which channels the render pass writes to the color buffer.

static PropertyType< GraphicsCompareFunction >	DepthTestFunctionProperty
	Use the Depth Test Function property to control whether the depth test discards a fragment.

static PropertyType< bool >	DepthWriteEnabledProperty
	Use the Depth Write Enabled property to set whether the render pass writes to the depth buffer.

static PropertyType< GraphicsCompareFunction >	StencilTestFunctionProperty
	Use the Stencil Test Function property to control whether the stencil test discards a fragment.

static PropertyType< int >	StencilReferenceValueProperty
	Use the Stencil Reference Value property to set the reference value for the stencil test.

static PropertyType< int >	StencilMaskProperty
	Use the Stencil Mask property to set a mask on which the AND operation is executed with both the reference value and the stored stencil value when the test is done.

static PropertyType< GraphicsStencilOperation >	StencilFailOperationProperty
	Use the Stencil Fail Operation property to set the operation that the render pass performs when the stencil test fails.

static PropertyType< GraphicsStencilOperation >	StencilPassDepthFailOperationProperty
	Use the Stencil Pass Depth Fail Operation property to set the operation that the render pass performs when the stencil test passes, but the depth test fails.

static PropertyType< GraphicsStencilOperation >	StencilPassDepthPassOperationProperty
	Use the Stencil Pass Depth Pass Operation property to set the operation that the render pass performs when both, the stencil and the depth test, pass.

static PropertyType< bool >	StencilWriteEnabledProperty
	Use the Stencil Write Enabled property to set whether to enable writing to the stencil buffer.

static PropertyType< GraphicsCullMode >	CullModeProperty
	Use the Cull Mode property to set the culling of the triangle faces in the rendered meshes.

static PropertyType< Vector4 >	ViewportProperty
	Use the Viewport property to modify the current rendering Viewport 2D node.

static PropertyType< ViewportMode >	ViewportModeProperty
	Use the Viewport Mode property to set the coordinate type for the Viewport 2D node.

static PropertyType< Vector4 >	ScissorProperty
	Use the Scissor property to set the scissor test within the current rendering Viewport 2D node.

static PropertyType< ViewportMode >	ScissorModeProperty
	Use the Scissor Mode property to set the scissor test coordinate mode.

static PropertyType< Vector2 >	PolygonDepthOffsetProperty
	Use the Polygon Depth Offset property to offset the geometry in the depth buffer.

int	getBlendMode () const
	Gets the value of the BlendModeProperty property.

void	setBlendMode (int value)
	Sets the value of the BlendModeProperty property.

GraphicsColorWriteMode	getColorWriteMode () const
	Gets the value of the ColorWriteModeProperty property.

void	setColorWriteMode (GraphicsColorWriteMode value)
	Sets the value of the ColorWriteModeProperty property.

GraphicsCompareFunction	getDepthTestFunction () const
	Gets the value of the DepthTestFunctionProperty property.

void	setDepthTestFunction (GraphicsCompareFunction value)
	Sets the value of the DepthTestFunctionProperty property.

bool	isDepthWriteEnabled () const
	Gets the value of the DepthWriteEnabledProperty property.

void	setDepthWriteEnabled (bool value)
	Sets the value of the DepthWriteEnabledProperty property.

GraphicsCompareFunction	getStencilTestFunction () const
	Gets the value of the StencilTestFunctionProperty property.

void	setStencilTestFunction (GraphicsCompareFunction value)
	Sets the value of the StencilTestFunctionProperty property.

int	getStencilReferenceValue () const
	Gets the value of the StencilReferenceValueProperty property.

void	setStencilReferenceValue (int value)
	Sets the value of the StencilReferenceValueProperty property.

int	getStencilMask () const
	Gets the value of the StencilMaskProperty property.

void	setStencilMask (int value)
	Sets the value of the StencilMaskProperty property.

GraphicsStencilOperation	getStencilFailOperation () const
	Gets the value of the StencilFailOperationProperty property.

void	setStencilFailOperation (GraphicsStencilOperation value)
	Sets the value of the StencilFailOperationProperty property.

GraphicsStencilOperation	getStencilPassDepthFailOperation () const
	Gets the value of the StencilPassDepthFailOperationProperty property.

void	setStencilPassDepthFailOperation (GraphicsStencilOperation value)
	Sets the value of the StencilPassDepthFailOperationProperty property.

GraphicsStencilOperation	getStencilPassDepthPassOperation () const
	Gets the value of the StencilPassDepthPassOperationProperty property.

void	setStencilPassDepthPassOperation (GraphicsStencilOperation value)
	Sets the value of the StencilPassDepthPassOperationProperty property.

bool	isStencilWriteEnabled () const
	Gets the value of the StencilWriteEnabledProperty property.

void	setStencilWriteEnabled (bool value)
	Sets the value of the StencilWriteEnabledProperty property.

GraphicsCullMode	getCullMode () const
	Gets the value of the CullModeProperty property.

void	setCullMode (GraphicsCullMode value)
	Sets the value of the CullModeProperty property.

Vector4	getViewport () const
	Gets the value of the ViewportProperty property.

void	setViewport (Vector4 value)
	Sets the value of the ViewportProperty property.

ViewportMode	getViewportMode () const
	Gets the value of the ViewportModeProperty property.

void	setViewportMode (ViewportMode value)
	Sets the value of the ViewportModeProperty property.

Vector4	getScissor () const
	Gets the value of the ScissorProperty property.

void	setScissor (Vector4 value)
	Sets the value of the ScissorProperty property.

ViewportMode	getScissorMode () const
	Gets the value of the ScissorModeProperty property.

void	setScissorMode (ViewportMode value)
	Sets the value of the ScissorModeProperty property.

Vector2	getPolygonDepthOffset () const
	Gets the value of the PolygonDepthOffsetProperty.

void	setPolygonDepthOffset (Vector2 value)
	Sets the value of the PolygonDepthOffsetProperty.

Additional Inherited Members
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.

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 Pipeline State Render Pass to set for its child render passes the depth and stencil testing, transparency, and culling.

This render pass sets the rendering state before passing the control to its descendants. After the descendant render passes of a Pipeline State Render Pass execute, Kanzi restores the rendering state. If a Pipeline State Render Pass does not have any descendants, Kanzi does not apply the rendering state you set in that render pass.

You change the rendering state by setting the properties in a Pipeline State Render Pass. The default settings in a Pipeline State Render Pass that you can set are:

BlendModeProperty property is set to Premultiplied alpha
ColorWriteModeProperty property is set to RGBA
Depth test is enabled and DepthTestFunctionProperty is set to Less
DepthWriteEnabledProperty property is enabled
CullModeProperty property is enabled and set to Back
StencilTestFunctionProperty property is disabled
ViewportProperty property is set to the complete size of Viewport2D node or of the current composition target set by a CompositionTargetRenderPass
ScissorProperty property is disabled, unless the current Viewport2D node does not fill the whole composition target area
PolygonDepthOffsetProperty property is not set.

Kanzi groups the rendering state combinations that a Pipeline State Render Pass applies into these state stacks:

Color and blend state
Depth and stencil state
Composition (viewport and scissor) state
Rasterization state

If you do not set a property, Kanzi uses the default or previously set value. See CompositionStack.

Examples

To turn on stencil test and only render where stencil buffer value is not 0:

        // Enable stencil test and set the test function to not equal.
        pipelineStateRenderPass->setStencilTestFunction(GraphicsCompareFunctionNotEqual);
 
        // Set everything except 0 to pass. Set the reference value to 0 and mask to 0xFF (255).
        pipelineStateRenderPass->setStencilReferenceValue(0);
        pipelineStateRenderPass->setStencilMask(255);
 
        // Do not change the stencil buffer state.
        pipelineStateRenderPass->setStencilFailOperation(GraphicsStencilOperationKeep);
        pipelineStateRenderPass->setStencilPassDepthFailOperation(GraphicsStencilOperationKeep);
        pipelineStateRenderPass->setStencilPassDepthPassOperation(GraphicsStencilOperationKeep);

To render only the back faces of objects:

// Cull the front faces instead of the back faces.

pipelineStateRenderPass->setCullMode(GraphicsCullModeFront);

To turn off alpha blending:

// Disable blending.

pipelineStateRenderPass->setBlendMode(GraphicsBlendModeOpaque);

Member Enumeration Documentation

◆ ViewportMode

enum kanzi::PipelineStateRenderPass::ViewportMode

Enumerator
ViewportModeAbsolute	Absolute viewport - pixel coordinates.
ViewportModeRelative	Relative viewport - percentage of current render context size.

Constructor & Destructor Documentation

◆ PipelineStateRenderPass()

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

explicitprotected

Constructor.

Parameters

domain	Domain.
name	Name of the Pipeline State Render Pass.

Member Function Documentation

◆ getBlendMode()

int kanzi::PipelineStateRenderPass::getBlendMode ( ) const

inline

Gets the value of the BlendModeProperty property.

See also: setBlendMode()

Since: Kanzi 3.9.1 return value type changed from GraphicsBlendMode to int.

◆ setBlendMode()

void kanzi::PipelineStateRenderPass::setBlendMode ( int value )

inline

Sets the value of the BlendModeProperty property.

See also: getBlendMode()

Since: Kanzi 3.9.1 data type of value parameter changed from GraphicsBlendMode to int.

◆ getColorWriteMode()

GraphicsColorWriteMode kanzi::PipelineStateRenderPass::getColorWriteMode ( ) const

inline

Gets the value of the ColorWriteModeProperty property.

See also: setColorWriteMode()

◆ setColorWriteMode()

void kanzi::PipelineStateRenderPass::setColorWriteMode ( GraphicsColorWriteMode value )

inline

Sets the value of the ColorWriteModeProperty property.

See also: getColorWriteMode()

◆ getDepthTestFunction()

GraphicsCompareFunction kanzi::PipelineStateRenderPass::getDepthTestFunction ( ) const

inline

Gets the value of the DepthTestFunctionProperty property.

See also: setDepthTestFunction()

◆ setDepthTestFunction()

void kanzi::PipelineStateRenderPass::setDepthTestFunction ( GraphicsCompareFunction value )

inline

Sets the value of the DepthTestFunctionProperty property.

See also: getDepthTestFunction()

◆ isDepthWriteEnabled()

bool kanzi::PipelineStateRenderPass::isDepthWriteEnabled ( ) const

inline

Gets the value of the DepthWriteEnabledProperty property.

See also: setDepthWriteEnabled()

◆ setDepthWriteEnabled()

void kanzi::PipelineStateRenderPass::setDepthWriteEnabled ( bool value )

inline

Sets the value of the DepthWriteEnabledProperty property.

See also: isDepthWriteEnabled()

◆ getStencilTestFunction()

GraphicsCompareFunction kanzi::PipelineStateRenderPass::getStencilTestFunction ( ) const

inline

Gets the value of the StencilTestFunctionProperty property.

See also: setStencilTestFunction()

◆ setStencilTestFunction()

void kanzi::PipelineStateRenderPass::setStencilTestFunction ( GraphicsCompareFunction value )

inline

Sets the value of the StencilTestFunctionProperty property.

See also: getStencilTestFunction()

◆ getStencilReferenceValue()

int kanzi::PipelineStateRenderPass::getStencilReferenceValue ( ) const

inline

Gets the value of the StencilReferenceValueProperty property.

See also: setStencilReferenceValue()

◆ setStencilReferenceValue()

void kanzi::PipelineStateRenderPass::setStencilReferenceValue ( int value )

inline

Sets the value of the StencilReferenceValueProperty property.

See also: getStencilReferenceValue()

◆ getStencilMask()

int kanzi::PipelineStateRenderPass::getStencilMask ( ) const

inline

Gets the value of the StencilMaskProperty property.

See also: setStencilMask()

◆ setStencilMask()

void kanzi::PipelineStateRenderPass::setStencilMask ( int value )

inline

Sets the value of the StencilMaskProperty property.

See also: getStencilMask()

◆ getStencilFailOperation()

GraphicsStencilOperation kanzi::PipelineStateRenderPass::getStencilFailOperation ( ) const

inline

Gets the value of the StencilFailOperationProperty property.

See also: setStencilFailOperation()

◆ setStencilFailOperation()

void kanzi::PipelineStateRenderPass::setStencilFailOperation ( GraphicsStencilOperation value )

inline

Sets the value of the StencilFailOperationProperty property.

See also: getStencilFailOperation()

◆ getStencilPassDepthFailOperation()

GraphicsStencilOperation kanzi::PipelineStateRenderPass::getStencilPassDepthFailOperation ( ) const

inline

Gets the value of the StencilPassDepthFailOperationProperty property.

See also: setStencilPassDepthFailOperation()

◆ setStencilPassDepthFailOperation()

void kanzi::PipelineStateRenderPass::setStencilPassDepthFailOperation ( GraphicsStencilOperation value )

inline

Sets the value of the StencilPassDepthFailOperationProperty property.

See also: getStencilPassDepthFailOperation()

◆ getStencilPassDepthPassOperation()

GraphicsStencilOperation kanzi::PipelineStateRenderPass::getStencilPassDepthPassOperation ( ) const

inline

Gets the value of the StencilPassDepthPassOperationProperty property.

See also: setStencilPassDepthPassOperation()

◆ setStencilPassDepthPassOperation()

void kanzi::PipelineStateRenderPass::setStencilPassDepthPassOperation ( GraphicsStencilOperation value )

inline

Sets the value of the StencilPassDepthPassOperationProperty property.

See also: getStencilPassDepthPassOperation()

◆ isStencilWriteEnabled()

bool kanzi::PipelineStateRenderPass::isStencilWriteEnabled ( ) const

inline

Gets the value of the StencilWriteEnabledProperty property.

See also: setStencilWriteEnabled()

◆ setStencilWriteEnabled()

void kanzi::PipelineStateRenderPass::setStencilWriteEnabled ( bool value )

inline

Sets the value of the StencilWriteEnabledProperty property.

See also: isStencilWriteEnabled()

◆ getCullMode()

GraphicsCullMode kanzi::PipelineStateRenderPass::getCullMode ( ) const

inline

Gets the value of the CullModeProperty property.

See also: setCullMode()

◆ setCullMode()

void kanzi::PipelineStateRenderPass::setCullMode ( GraphicsCullMode value )

inline

Sets the value of the CullModeProperty property.

See also: getCullMode()

◆ getViewport()

Vector4 kanzi::PipelineStateRenderPass::getViewport ( ) const

inline

Gets the value of the ViewportProperty property.

◆ setViewport()

void kanzi::PipelineStateRenderPass::setViewport ( Vector4 value )

inline

Sets the value of the ViewportProperty property.

◆ getViewportMode()

ViewportMode kanzi::PipelineStateRenderPass::getViewportMode ( ) const

inline

Gets the value of the ViewportModeProperty property.

◆ setViewportMode()

void kanzi::PipelineStateRenderPass::setViewportMode ( ViewportMode value )

inline

Sets the value of the ViewportModeProperty property.

◆ getScissor()

Vector4 kanzi::PipelineStateRenderPass::getScissor ( ) const

inline

Gets the value of the ScissorProperty property.

◆ setScissor()

void kanzi::PipelineStateRenderPass::setScissor ( Vector4 value )

inline

Sets the value of the ScissorProperty property.

◆ getScissorMode()

ViewportMode kanzi::PipelineStateRenderPass::getScissorMode ( ) const

inline

Gets the value of the ScissorModeProperty property.

◆ setScissorMode()

void kanzi::PipelineStateRenderPass::setScissorMode ( ViewportMode value )

inline

Sets the value of the ScissorModeProperty property.

◆ getPolygonDepthOffset()

Vector2 kanzi::PipelineStateRenderPass::getPolygonDepthOffset ( ) const

inline

Gets the value of the PolygonDepthOffsetProperty.

Returns: The polygon depth offset.

Since: Kanzi 3.9.4

◆ setPolygonDepthOffset()

void kanzi::PipelineStateRenderPass::setPolygonDepthOffset ( Vector2 value )

inline

Sets the value of the PolygonDepthOffsetProperty.

Parameters

value The polygon depth offset.

Since: Kanzi 3.9.4

◆ makeEditorInfo()

static PropertyTypeEditorInfoSharedPtr kanzi::PipelineStateRenderPass::makeEditorInfo ( )

static

◆ create()

static PipelineStateRenderPassSharedPtr kanzi::PipelineStateRenderPass::create	(	Domain *	domain,
		string_view	name )

static

Create a Pipeline State Render Pass.

Parameters

domain	The domain to use.
name	The name of the Pipeline State Render Pass.

Returns: The created Pipeline State Render Pass.

◆ pushColorBlend()

bool kanzi::PipelineStateRenderPass::pushColorBlend ( CompositionStack & compositionStack )

protected

Push the color or blend state into the composition stack.

Parameters

compositionStack Composition stack to use.

Returns: True if state was pushed.

◆ pushDepthStencil()

bool kanzi::PipelineStateRenderPass::pushDepthStencil ( CompositionStack & compositionStack )

protected

Push the depth or stencil state into the composition stack.

Parameters

compositionStack Composition stack to use.

Returns: True if state was pushed.

◆ pushRasterization()

bool kanzi::PipelineStateRenderPass::pushRasterization ( CompositionStack & compositionStack )

protected

Push the rasterization state into the composition stack.

Parameters

compositionStack Composition stack to use.

Returns: True if state was pushed.

◆ pushViewportScissor()

bool kanzi::PipelineStateRenderPass::pushViewportScissor ( CompositionStack & compositionStack )

protected

Push the Viewport 2D scissor state into the composition stack.

Effectively pushes new composition area.

Parameters

compositionStack Composition stack to use.

Returns: True if state was pushed.

◆ renderOverride()

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

overrideprotectedvirtual

RenderPass::renderOverride() implementation.

Reimplemented from kanzi::RenderPass.

◆ getCompositionRequirements()

CompositionRequirements kanzi::PipelineStateRenderPass::getCompositionRequirements ( )

overrideprotectedvirtual

RenderPass::getCompositionRequirements() implementation.

Reimplemented from kanzi::RenderPass.

Member Data Documentation

◆ BlendModeProperty

PropertyType<int> kanzi::PipelineStateRenderPass::BlendModeProperty

static

Use the Blend Mode property to override the blend mode set in each node that this render pass renders.

The default value is kanzi::GraphicsBlendModeOpaque.

See also: setBlendMode(), getBlendMode()

Since: Kanzi 3.9.1 property data type changed from GraphicsBlendMode to int.

◆ ColorWriteModeProperty

PropertyType<GraphicsColorWriteMode> kanzi::PipelineStateRenderPass::ColorWriteModeProperty

static

Use the Color Write Mode property to set which channels the render pass writes to the color buffer.

To disable the color write, set the property to None. The default value is GraphicsColorWriteModeRGBA.

See also: setColorWriteMode(), getColorWriteMode()

◆ DepthTestFunctionProperty

PropertyType<GraphicsCompareFunction> kanzi::PipelineStateRenderPass::DepthTestFunctionProperty

static

Use the Depth Test Function property to control whether the depth test discards a fragment.

The default value is GraphicsCompareFunctionLess.

See also: setDepthTestFunction(), getDepthTestFunction()

◆ DepthWriteEnabledProperty

PropertyType<bool> kanzi::PipelineStateRenderPass::DepthWriteEnabledProperty

static

Use the Depth Write Enabled property to set whether the render pass writes to the depth buffer.

The default value is True.

See also: setDepthWriteEnabled(), isDepthWriteEnabled()

◆ StencilTestFunctionProperty

PropertyType<GraphicsCompareFunction> kanzi::PipelineStateRenderPass::StencilTestFunctionProperty

static

Use the Stencil Test Function property to control whether the stencil test discards a fragment.

The default value is GraphicsCompareFunctionDisabled.

See also: setStencilTestFunction(), getStencilTestFunction(), StencilReferenceValueProperty

◆ StencilReferenceValueProperty

PropertyType<int> kanzi::PipelineStateRenderPass::StencilReferenceValueProperty

static

Use the Stencil Reference Value property to set the reference value for the stencil test.

The default value is 0.

See also: setStencilReferenceValue(), getStencilReferenceValue(), StencilTestFunctionProperty

◆ StencilMaskProperty

PropertyType<int> kanzi::PipelineStateRenderPass::StencilMaskProperty

static

Use the Stencil Mask property to set a mask on which the AND operation is executed with both the reference value and the stored stencil value when the test is done.

The default value is 255.

See also: setStencilMask(), getStencilMask()

◆ StencilFailOperationProperty

PropertyType<GraphicsStencilOperation> kanzi::PipelineStateRenderPass::StencilFailOperationProperty

static

Use the Stencil Fail Operation property to set the operation that the render pass performs when the stencil test fails.

The default value is GraphicsStencilOperationKeep.

See also: setStencilFailOperation(), getStencilFailOperation()

◆ StencilPassDepthFailOperationProperty

PropertyType<GraphicsStencilOperation> kanzi::PipelineStateRenderPass::StencilPassDepthFailOperationProperty

static

Use the Stencil Pass Depth Fail Operation property to set the operation that the render pass performs when the stencil test passes, but the depth test fails.

The default value is GraphicsStencilOperationKeep.

See also: setStencilPassDepthFailOperation(), getStencilPassDepthFailOperation()

◆ StencilPassDepthPassOperationProperty

PropertyType<GraphicsStencilOperation> kanzi::PipelineStateRenderPass::StencilPassDepthPassOperationProperty

static

Use the Stencil Pass Depth Pass Operation property to set the operation that the render pass performs when both, the stencil and the depth test, pass.

The default value is GraphicsStencilOperationKeep.

See also: setStencilPassDepthPassOperation(), getStencilPassDepthPassOperation()

◆ StencilWriteEnabledProperty

PropertyType<bool> kanzi::PipelineStateRenderPass::StencilWriteEnabledProperty

static

Use the Stencil Write Enabled property to set whether to enable writing to the stencil buffer.

The default value is True.

See also: setStencilWriteEnabled(), isStencilWriteEnabled()

◆ CullModeProperty

PropertyType<GraphicsCullMode> kanzi::PipelineStateRenderPass::CullModeProperty

static

Use the Cull Mode property to set the culling of the triangle faces in the rendered meshes.

Set to:

Back to render the triangles whose normal points towards a Camera node
Front to render the triangles whose normal points away from a Camera node The default value is GraphicsCullModeBack.
See also
setCullMode(), getCullMode()

◆ ViewportProperty

PropertyType<Vector4> kanzi::PipelineStateRenderPass::ViewportProperty

static

Use the Viewport property to modify the current rendering Viewport 2D node.

You can define the Viewport 2D node in either relative or absolute coordinates, the default is relative. Use the ViewportModeProperty property to set the coordinate type.

See also: setViewport(), getViewport(), ViewportModeProperty

◆ ViewportModeProperty

PropertyType<ViewportMode> kanzi::PipelineStateRenderPass::ViewportModeProperty

static

Use the Viewport Mode property to set the coordinate type for the Viewport 2D node.

See also: setViewportMode(), getViewportMode(), ViewportProperty

◆ ScissorProperty

PropertyType<Vector4> kanzi::PipelineStateRenderPass::ScissorProperty

static

Use the Scissor property to set the scissor test within the current rendering Viewport 2D node.

You can define the scissor in either relative or absolute coordinates, the default is relative. Use the ScissorModeProperty property to set the coordinate type.

See also: setScissor(), getScissor(), ScissorModeProperty

◆ ScissorModeProperty

PropertyType<ViewportMode> kanzi::PipelineStateRenderPass::ScissorModeProperty

static

Use the Scissor Mode property to set the scissor test coordinate mode.

See also: setScissorMode(), getScissorMode(), ScissorProperty

◆ PolygonDepthOffsetProperty

PropertyType<Vector2> kanzi::PipelineStateRenderPass::PolygonDepthOffsetProperty

static

Use the Polygon Depth Offset property to offset the geometry in the depth buffer.

For example, you can use the offset to render decals without z fighting.

Kanzi uses the two components (X, Y) of the vector to construct the polygon depth offset as follows:

dZ * X + units * Y

where:

dZ is the depth change derivative for the fragment.
units is the smallest measurable unit of depth.

Kanzi adds the polygon depth offset to the depth as the last step in fragment depth calculation.

See also: getPolygonDepthOffset(), setPolygonDepthOffset()

Since: Kanzi 3.9.4

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

kanzi/core.ui/graphics3d/pipeline_state_render_pass.hpp

Public Types

Static Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Examples

Member Enumeration Documentation

◆ ViewportMode

Constructor & Destructor Documentation

◆ PipelineStateRenderPass()

Member Function Documentation

◆ getBlendMode()

◆ setBlendMode()

◆ getColorWriteMode()

◆ setColorWriteMode()

◆ getDepthTestFunction()

◆ setDepthTestFunction()

◆ isDepthWriteEnabled()

◆ setDepthWriteEnabled()

◆ getStencilTestFunction()

◆ setStencilTestFunction()

◆ getStencilReferenceValue()

◆ setStencilReferenceValue()

◆ getStencilMask()

◆ setStencilMask()

◆ getStencilFailOperation()

◆ setStencilFailOperation()

◆ getStencilPassDepthFailOperation()

◆ setStencilPassDepthFailOperation()

◆ getStencilPassDepthPassOperation()

◆ setStencilPassDepthPassOperation()

◆ isStencilWriteEnabled()

◆ setStencilWriteEnabled()

◆ getCullMode()

◆ setCullMode()

◆ getViewport()

◆ setViewport()

◆ getViewportMode()

◆ setViewportMode()

◆ getScissor()

◆ setScissor()

◆ getScissorMode()

◆ setScissorMode()

◆ getPolygonDepthOffset()

◆ setPolygonDepthOffset()

◆ makeEditorInfo()

◆ create()

◆ pushColorBlend()

◆ pushDepthStencil()

◆ pushRasterization()

◆ pushViewportScissor()

◆ renderOverride()

◆ getCompositionRequirements()

Member Data Documentation

◆ BlendModeProperty

◆ ColorWriteModeProperty

◆ DepthTestFunctionProperty

◆ DepthWriteEnabledProperty

◆ StencilTestFunctionProperty

◆ StencilReferenceValueProperty

◆ StencilMaskProperty

◆ StencilFailOperationProperty

◆ StencilPassDepthFailOperationProperty

◆ StencilPassDepthPassOperationProperty

◆ StencilWriteEnabledProperty

◆ CullModeProperty

◆ ViewportProperty

◆ ViewportModeProperty

◆ ScissorProperty

◆ ScissorModeProperty

◆ PolygonDepthOffsetProperty