Kanzi  3.9.9
Kanzi Engine C++ API
kanzi::PipelineStateRenderPass Class Reference

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. More...
 
typedef vector< AbstractBindingRuntimeSharedPtrBindingRuntimeContainer
 Container type for binding runtimes. More...
 
typedef BindingRuntimeContainer::iterator BindingRuntimeIterator
 Iterator type for binding runtime container. More...
 
using CameraSettingsPtr = unique_ptr< CameraSettings >
 Camera settings unique pointer type. More...
 
typedef ChildContainer::const_iterator ChildConstIterator
 Child container iterator type. More...
 
typedef vector< RenderPassSharedPtrChildContainer
 Container type for children. More...
 
- Public Types inherited from kanzi::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< PropertyStoragePtrPropertyStorageContainer
 
typedef PropertyStorageContainer::iterator PropertyStorageIterator
 
typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStoragePropertyStoragePtr
 
typedef PropertyStorageContainer::reverse_iterator PropertyStorageReverseIterator
 
- Public Types inherited from kanzi::BindingHostConcept
using BindingHostConceptSharedPtr = shared_ptr< BindingHostConcept >
 Binding host concept shared pointer type. More...
 
using BindingRuntimeConstIterator = BindingRuntimeContainer::const_iterator
 Const iterator for binding runtimes. More...
 
using BindingRuntimeContainer = vector< AbstractBindingRuntimeSharedPtr >
 Container for binding runtimes. More...
 
using BindingRuntimeIterator = BindingRuntimeContainer::iterator
 Iterator for binding runtimes. More...
 

Static Public Member Functions

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

Protected Member Functions

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

Properties

static PropertyType< int > BlendModeProperty
 Use the Blend Mode property to override the blend mode set in each node that this render pass renders. More...
 
static PropertyType< GraphicsColorWriteModeColorWriteModeProperty
 Use the Color Write Mode property to set which channels the render pass writes to the color buffer. More...
 
static PropertyType< GraphicsCompareFunctionDepthTestFunctionProperty
 Use the Depth Test Function property to control whether the depth test discards a fragment. More...
 
static PropertyType< bool > DepthWriteEnabledProperty
 Use the Depth Write Enabled property to set whether the render pass writes to the depth buffer. More...
 
static PropertyType< GraphicsCompareFunctionStencilTestFunctionProperty
 Use the Stencil Test Function property to control whether the stencil test discards a fragment. More...
 
static PropertyType< int > StencilReferenceValueProperty
 Use the Stencil Reference Value property to set the reference value for the stencil test. More...
 
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. More...
 
static PropertyType< GraphicsStencilOperationStencilFailOperationProperty
 Use the Stencil Fail Operation property to set the operation that the render pass performs when the stencil test fails. More...
 
static PropertyType< GraphicsStencilOperationStencilPassDepthFailOperationProperty
 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. More...
 
static PropertyType< GraphicsStencilOperationStencilPassDepthPassOperationProperty
 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. More...
 
static PropertyType< bool > StencilWriteEnabledProperty
 Use the Stencil Write Enabled property to set whether to enable writing to the stencil buffer. More...
 
static PropertyType< GraphicsCullModeCullModeProperty
 Use the Cull Mode property to set the culling of the triangle faces in the rendered meshes. More...
 
static PropertyType< Vector4ViewportProperty
 Use the Viewport property to modify the current rendering Viewport 2D node. More...
 
static PropertyType< ViewportModeViewportModeProperty
 Use the Viewport Mode property to set the coordinate type for the Viewport 2D node. More...
 
static PropertyType< Vector4ScissorProperty
 Use the Scissor property to set the scissor test within the current rendering Viewport 2D node. More...
 
static PropertyType< ViewportModeScissorModeProperty
 Use the Scissor Mode property to set the scissor test coordinate mode. More...
 
static PropertyType< Vector2PolygonDepthOffsetProperty
 Use the Polygon Depth Offset property to offset the geometry in the depth buffer. More...
 
int getBlendMode () const
 Gets the value of the BlendModeProperty property. More...
 
void setBlendMode (int value)
 Sets the value of the BlendModeProperty property. More...
 
GraphicsColorWriteMode getColorWriteMode () const
 Gets the value of the ColorWriteModeProperty property. More...
 
void setColorWriteMode (GraphicsColorWriteMode value)
 Sets the value of the ColorWriteModeProperty property. More...
 
GraphicsCompareFunction getDepthTestFunction () const
 Gets the value of the DepthTestFunctionProperty property. More...
 
void setDepthTestFunction (GraphicsCompareFunction value)
 Sets the value of the DepthTestFunctionProperty property. More...
 
bool isDepthWriteEnabled () const
 Gets the value of the DepthWriteEnabledProperty property. More...
 
void setDepthWriteEnabled (bool value)
 Sets the value of the DepthWriteEnabledProperty property. More...
 
GraphicsCompareFunction getStencilTestFunction () const
 Gets the value of the StencilTestFunctionProperty property. More...
 
void setStencilTestFunction (GraphicsCompareFunction value)
 Sets the value of the StencilTestFunctionProperty property. More...
 
int getStencilReferenceValue () const
 Gets the value of the StencilReferenceValueProperty property. More...
 
void setStencilReferenceValue (int value)
 Sets the value of the StencilReferenceValueProperty property. More...
 
int getStencilMask () const
 Gets the value of the StencilMaskProperty property. More...
 
void setStencilMask (int value)
 Sets the value of the StencilMaskProperty property. More...
 
GraphicsStencilOperation getStencilFailOperation () const
 Gets the value of the StencilFailOperationProperty property. More...
 
void setStencilFailOperation (GraphicsStencilOperation value)
 Sets the value of the StencilFailOperationProperty property. More...
 
GraphicsStencilOperation getStencilPassDepthFailOperation () const
 Gets the value of the StencilPassDepthFailOperationProperty property. More...
 
void setStencilPassDepthFailOperation (GraphicsStencilOperation value)
 Sets the value of the StencilPassDepthFailOperationProperty property. More...
 
GraphicsStencilOperation getStencilPassDepthPassOperation () const
 Gets the value of the StencilPassDepthPassOperationProperty property. More...
 
void setStencilPassDepthPassOperation (GraphicsStencilOperation value)
 Sets the value of the StencilPassDepthPassOperationProperty property. More...
 
bool isStencilWriteEnabled () const
 Gets the value of the StencilWriteEnabledProperty property. More...
 
void setStencilWriteEnabled (bool value)
 Sets the value of the StencilWriteEnabledProperty property. More...
 
GraphicsCullMode getCullMode () const
 Gets the value of the CullModeProperty property. More...
 
void setCullMode (GraphicsCullMode value)
 Sets the value of the CullModeProperty property. More...
 
Vector4 getViewport () const
 Gets the value of the ViewportProperty property. More...
 
void setViewport (Vector4 value)
 Sets the value of the ViewportProperty property. More...
 
ViewportMode getViewportMode () const
 Gets the value of the ViewportModeProperty property. More...
 
void setViewportMode (ViewportMode value)
 Sets the value of the ViewportModeProperty property. More...
 
Vector4 getScissor () const
 Gets the value of the ScissorProperty property. More...
 
void setScissor (Vector4 value)
 Sets the value of the ScissorProperty property. More...
 
ViewportMode getScissorMode () const
 Gets the value of the ScissorModeProperty property. More...
 
void setScissorMode (ViewportMode value)
 Sets the value of the ScissorModeProperty property. More...
 
Vector2 getPolygonDepthOffset () const
 Gets the value of the PolygonDepthOffsetProperty. More...
 
void setPolygonDepthOffset (Vector2 value)
 Sets the value of the PolygonDepthOffsetProperty. More...
 

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. More...
 
void attach ()
 Attaches the render pass. More...
 
void attachRecursive (Node &node)
 Recursively attaches a render pass tree. More...
 
ChildConstIterator beginChildren () const
 Returns an iterator to the beginning of the container of child render passes. More...
 
BindingLookupContextPtr createLookupContext (RenderPassSharedPtr templateRoot)
 Creates a lookup context for a given render pass. More...
 
void detach ()
 Detaches the render pass. More...
 
void detachRecursive ()
 Recursively detaches a render pass tree. More...
 
ChildConstIterator endChildren () const
 Returns an iterator to the end of the container of child render passes. More...
 
string getCamera () const
 Gets the value of the CameraProperty. More...
 
RenderPassSharedPtr getChild (size_t index)
 Gets a child render pass at the given index. More...
 
size_t getChildCount () const
 Returns the number of child render passes. More...
 
size_t getChildIndex (RenderPass &childRenderPass) const
 Gets the index of a child in this render pass. More...
 
NodegetHostNode () const
 Gets the host node of a render pass. More...
 
Vector4 getInputViewport () const
 Gets the value of InputViewportAreaProperty. More...
 
RenderPassgetParent () const
 Gets the parent of a render pass. More...
 
ScenegetSceneForRenderPass () const
 Gets the scene being rendered by the render pass. More...
 
RenderPassSharedPtr getTemplateRoot () const
 Gets the template root of this render pass. More...
 
int getUpdateOffset () const
 Gets the update offset of the Render Pass. More...
 
int getUpdateRate () const
 Gets the value of UpdateRateProperty. More...
 
Viewport2DgetViewportForRenderPass () const
 Gets a viewport parent for a render pass. More...
 
void insertChild (size_t index, RenderPassSharedPtr childRenderPass)
 Adds a render pass as a child render pass at given index of the render pass you set. More...
 
bool isAttached () const
 Tells if a render pass is attached. More...
 
bool isAttaching () const
 Tells if a render pass is attaching. More...
 
virtual bool isDeployedOverride () const override
 Indicates whether a GPU resource is deployed. More...
 
bool isDetached () const
 Tells if a render pass is detached. More...
 
bool isDetaching () const
 Tells if render pass is detaching. More...
 
bool isEnabled () const
 Gets the value of the EnabledProperty property. More...
 
ObjectSharedPtr lookupObject (string_view relativePath)
 Lookup for an object from a node. More...
 
template<typename T >
shared_ptr< TlookupObject (string_view relativePath)
 Lookup a relative object of specific type. More...
 
void removeAllChildren ()
 Removes all child render passes from a render pass. More...
 
void removeChild (RenderPass &childRenderPass)
 Removes a child render pass. More...
 
void removeChild (size_t index)
 Removes a child render pass. More...
 
void render (Renderer3D &renderer, CompositionStack &compositionStack, const CameraSettings *cameraSettings)
 Recursively render RenderPass and all of its child render passes. More...
 
virtual void restoreResources ()
 Restore resources after suspend. More...
 
void restoreResourcesRecursive ()
 Recursively calls restoreResources for a RenderPass and all its children. More...
 
void setCamera (string_view value)
 Sets the value of the CameraProperty. More...
 
void setEnabled (bool value)
 Sets the value of the EnabledProperty. More...
 
void setHostNode (Node *hostNode)
 Sets the host node of a render pass. More...
 
void setParent (RenderPass *parent)
 Sets the parent of a render pass. More...
 
void setTemplateRoot (RenderPassSharedPtr templateRoot)
 Sets the template root for this render pass. More...
 
void setUpdateRate (int updateRate)
 Sets the value of UpdateRateProperty. More...
 
void setUpdateRateOffset (int updateOffset)
 Sets the value of UpdateOffsetProperty. More...
 
 ~RenderPass () override
 Destructor. More...
 
- Public Member Functions inherited from kanzi::GPUResource
void destroy ()
 Destroys a GPU resource. More...
 
unsigned int getGPUMemoryUsage () const
 
RenderergetRenderer () const
 
void invalidate ()
 Notify resource that graphics context was lost and all GPU resources are invalid. More...
 
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. More...
 
const string & getName () const
 Gets the resource name. More...
 
const string & getUrl () const
 Gets the resource URL. More...
 
bool isKeepAlive () const
 Tells if the resource has keep alive flag set. More...
 
void reload ()
 
void reloadFromFile (string_view filePath)
 
void reloadFromKzb (KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)
 
void setKeepAlive (bool keepAlive)
 Sets the keep alive flag. More...
 
void setUrl (string_view url)
 Sets the resource URL. More...
 
 ~Resource () override
 Destructor. More...
 
- Public Member Functions inherited from kanzi::Object
AppliedStyleEntrySharedPtr applyObjectStyle (kanzi::StyleSharedPtr style)
 Applies a style to an object. More...
 
void applyObjectStyles ()
 Apply all styles for an object node. More...
 
DomaingetDomain () const
 Returns the domain the object belongs to. More...
 
const MetaclassgetDynamicMetaclass () const override
 Returns the metaclass of the dynamic type of the object. More...
 
MainLoopSchedulergetMainLoopScheduler () const
 Returns the MainLoopScheduler instance of the associated Domain. More...
 
detail::MessageDispatcher * getMessageDispatcher () const
 Returns the message dispatcher of the object. More...
 
ResourceManagergetResourceManager () const
 Returns the resource manager of the object. More...
 
ScriptingContextSharedPtr getScriptingContext () const
 Gets the scripting context of the object. More...
 
 Object (Domain *domain)
 
void setScriptingContext (ScriptingContextSharedPtr context)
 Sets the scripting context of the object. More...
 
void unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)
 
void unapplyObjectStyles ()
 Unapplies and removes all applied styles. More...
 
 ~Object () override
 
- Public Member Functions inherited from kanzi::MetaObject
bool isTypeOf (const Metaclass *objectType) const
 Determines if the type of this object is the given type or derived from it. More...
 
virtual ~MetaObject ()
 
- Public Member Functions inherited from kanzi::PropertyObject
template<typename DataType >
void addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 
template<typename DataType >
void addPropertyModifierWithoutNotifyingHandlers (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 Adds a property modifier without notifying handlers. More...
 
template<typename DataType >
void addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
 
template<typename DataType >
void addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, void *ownerPointer)
 
template<typename DataType >
void addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner *owner)
 
PropertyStorageContainer::iterator beginPropertyStorage ()
 Returns the begin iterator to the internal property storage container. More...
 
PropertyStorageContainer::const_iterator beginPropertyStorage () const
 Returns the begin iterator to the internal property storage container. More...
 
void clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
 
void copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType)
 Copies local value of single property from another object. More...
 
void copyLocalValues (const PropertyObject &other)
 Copies all local values from another object. More...
 
PropertyStorageContainer::iterator endPropertyStorage ()
 Returns the end iterator to the internal property storage container. More...
 
PropertyStorageContainer::const_iterator endPropertyStorage () const
 Returns the end iterator to the internal property storage container. More...
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getAbstractProperty (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getAbstractPropertyBase (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalProperty (const PropertyType< DataType > &propertyType) const
 Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value. More...
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalPropertyBase (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property disregarding modifiers, but does not default to the value in property metadata if there are no inputs to the property value. More...
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getProperty (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property type. More...
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getPropertyBase (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property disregarding modifiers. More...
 
template<typename DataType >
size_t getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType) const
 Gets number of current notification handlers for given property type. More...
 
bool hasBaseValue (AbstractPropertyType propertyType) const
 Evaluates whether there are any inputs into the property value, disregarding modifiers. More...
 
bool hasLocalValue (AbstractPropertyType propertyType) const
 Evaluates whether there is a local value set for the property. More...
 
bool hasNonClassValue (AbstractPropertyType propertyType) const
 Evaluates whether there is a value of any precedence higher than class default value set for the property. More...
 
bool hasValue (AbstractPropertyType propertyType) const
 Evaluates whether there are any inputs into the property value. More...
 
bool isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const
 
 PropertyObject ()
 
void removeKzbProperties (flat_set< AbstractPropertyType > *keepProperties)
 Remove all KZB properties that are not included in a given set. More...
 
void removeKzbProperties ()
 Remove all KZB properties. More...
 
template<typename DataType >
void removeLocalPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *ownerPointer)
 
void removeLocalValue (AbstractPropertyType propertyType)
 Removes the local value associated with the property. More...
 
template<typename DataType >
void removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 
template<typename DataType >
void removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
 
template<typename DataType >
void removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *ownerPointer)
 
template<typename DataType >
void setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value)
 
template<typename DataType >
void setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value)
 Sets the local value of a property type. More...
 
void setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
 
KZ_DEPRECATED void validatePropertyModifiers (AbstractPropertyType propertyType)
 Validates property modifiers and notifies handlers. More...
 
void validatePropertyModifiersAndNotifyHandlers (AbstractPropertyType propertyType)
 Validates property modifiers and notifies handlers. More...
 
virtual ~PropertyObject ()
 
- Public Member Functions inherited from kanzi::BindingHostConceptImpl< RenderPass >
void addBindingRuntime (AbstractBindingRuntimeSharedPtr entry, shared_ptr< void > owner)
 Adds an already-created binding runtime to this binding host. More...
 
BindingRuntimeHandle setBinding (AbstractBindingSharedPtr binding, shared_ptr< RenderPass > templateRoot, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence)
 Wrapper for setting a binding. More...
 
BindingRuntimeHandle setBinding (AbstractBindingSharedPtr binding, shared_ptr< RenderPass > templateRoot, AbstractPropertyType propertyType, PropertyField field)
 Wrapper for setting a binding. More...
 
BindingRuntimeHandle setBinding (AbstractBindingSharedPtr binding, shared_ptr< RenderPass > templateRoot, AbstractPropertyType propertyType, PropertyValuePrecedence precedence)
 Wrapper for setting a binding. More...
 
BindingRuntimeHandle setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence)
 Wrapper for setting a binding. More...
 
BindingRuntimeHandle setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyField field)
 Wrapper for setting a binding. More...
 
BindingRuntimeHandle setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyValuePrecedence precedence)
 Wrapper for setting a binding. More...
 
BindingRuntimeHandle setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType)
 Wrapper for setting a binding. More...
 
BindingRuntimeHandle setBinding (AbstractBindingSharedPtr binding, shared_ptr< RenderPass > templateRoot)
 Sets a binding with no target. More...
 
BindingRuntimeHandle setBinding (AbstractBindingSharedPtr binding)
 Wrapper for setting a binding with no target. More...
 
BindingRuntimeHandle setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, shared_ptr< RenderPass > templateRoot, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence)
 Sets a binding to a certain property. More...
 
BindingRuntimeHandle setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence)
 Wrapper for setting a binding with owner. More...
 
BindingRuntimeHandle setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType)
 Wrapper for setting a binding with owner. More...
 
BindingRuntimeHandle setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, shared_ptr< RenderPass > templateRoot)
 Sets a binding with no target. More...
 
BindingRuntimeHandle setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner)
 Wrapper for setting a binding with no target. More...
 
BindingRuntimeHandle setModifierBinding (AbstractBindingSharedPtr binding, shared_ptr< RenderPass > templateRoot, AbstractPropertyType propertyType, PropertyField field)
 Wrapper for setting a modifier binding. More...
 
BindingRuntimeHandle setModifierBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyField field)
 Wrapper for setting a modifier binding. More...
 
BindingRuntimeHandle setModifierBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType)
 Wrapper for setting a modifier binding. More...
 
BindingRuntimeHandle setModifierBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, shared_ptr< RenderPass > templateRoot, AbstractPropertyType propertyType, PropertyField field)
 Sets a modifier binding. More...
 
BindingRuntimeHandle setModifierBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType, PropertyField field)
 Wrapper for setting a modifier binding. More...
 
BindingRuntimeHandle setModifierBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType)
 Wrapper for setting a modifier binding. More...
 
- Public Member Functions inherited from kanzi::BindingHostConcept
BindingRuntimeConstIterator beginBindingRuntimes () const
 Returns an iterator to the beginning of binding runtimes. More...
 
BindingRuntimeConstIterator endBindingRuntimes () const
 Returns an iterator to the end of binding runtimes. More...
 
AbstractBindingRuntimeSharedPtr getBindingRuntime (size_t idx)
 Gets binding by index. More...
 
size_t getBindingRuntimeCount () const
 Gets the number of binding runtimes added to this node. More...
 
void removeAllBindings ()
 Removes all binding runtimes. More...
 
void removeBinding (BindingRuntimeHandle &bindingRuntime)
 Removes a binding runtime added earlier. More...
 
void removeBindingsWithOwner (shared_ptr< void > owner)
 Removes all binding runtimes with the specified owner. More...
 
- Static Public Attributes inherited from kanzi::RenderPass
static PropertyType< string > CameraProperty
 Sets the Camera node that you want this render pass to use to render content. More...
 
static PropertyType< bool > EnabledProperty
 Use the Enabled property to turn render passes and render pass trees on or off. More...
 
static PropertyType< Vector4InputViewportAreaProperty
 Reports the size of the Viewport 2D that uses this render pass. More...
 
static PropertyType< int > UpdateOffsetProperty
 Sets the offset to add to the frame count when calculating the update rate of the Render Pass. More...
 
static PropertyType< int > UpdateRateProperty
 Sets the rate at which to render the Render Pass. More...
 
- Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtrAppliedStyleContainer
 Applied style container. More...
 
- Protected Attributes inherited from kanzi::RenderPass
AttachmentState m_attachmentState
 Render pass attachment state. More...
 
ChildContainer m_children
 Child render passes. More...
 
bool m_enabled
 Render pass enabled state. More...
 
uint64_t m_frameNumber
 Current frame number used for update rate control. More...
 
Nodem_hostNode
 Pointer to host node this render pass is attached under. More...
 
PropertyType< Vector4 >::Descriptor::TypedValueSource m_inputViewportAreaValueSource
 Value source for the input viewport area property. More...
 
RenderPassm_parent
 Pointer to parent render pass. More...
 
weak_ptr< RenderPassm_templateRoot
 Weak pointer to template root object of this render pass. More...
 
uint64_t m_updateOffset
 Current update rate offset property value cached. More...
 
uint64_t m_updateRate
 Current update rate property value cached. More...
 
- Protected Attributes inherited from kanzi::Object
AppliedStyleContainer m_appliedStyles
 Listing of applied styles applied to this object. More...
 
- Protected Attributes inherited from kanzi::BindingHostConcept
BindingRuntimeContainer m_bindingRuntimes
 Bindings in this object. More...
 

Detailed Description

Use 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:

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

Enumerator
ViewportModeAbsolute 

Absolute viewport - pixel coordinates.

ViewportModeRelative 

Relative viewport - percentage of current render context size.

Constructor & Destructor Documentation

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

Constructor.

Parameters
domainDomain.
nameName of the Pipeline State Render Pass.

Member Function Documentation

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.
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.
GraphicsColorWriteMode kanzi::PipelineStateRenderPass::getColorWriteMode ( ) const
inline

Gets the value of the ColorWriteModeProperty property.

See also
setColorWriteMode()
void kanzi::PipelineStateRenderPass::setColorWriteMode ( GraphicsColorWriteMode  value)
inline

Sets the value of the ColorWriteModeProperty property.

See also
getColorWriteMode()
GraphicsCompareFunction kanzi::PipelineStateRenderPass::getDepthTestFunction ( ) const
inline

Gets the value of the DepthTestFunctionProperty property.

See also
setDepthTestFunction()
void kanzi::PipelineStateRenderPass::setDepthTestFunction ( GraphicsCompareFunction  value)
inline

Sets the value of the DepthTestFunctionProperty property.

See also
getDepthTestFunction()
bool kanzi::PipelineStateRenderPass::isDepthWriteEnabled ( ) const
inline

Gets the value of the DepthWriteEnabledProperty property.

See also
setDepthWriteEnabled()
void kanzi::PipelineStateRenderPass::setDepthWriteEnabled ( bool  value)
inline

Sets the value of the DepthWriteEnabledProperty property.

See also
isDepthWriteEnabled()
GraphicsCompareFunction kanzi::PipelineStateRenderPass::getStencilTestFunction ( ) const
inline

Gets the value of the StencilTestFunctionProperty property.

See also
setStencilTestFunction()
void kanzi::PipelineStateRenderPass::setStencilTestFunction ( GraphicsCompareFunction  value)
inline

Sets the value of the StencilTestFunctionProperty property.

See also
getStencilTestFunction()
int kanzi::PipelineStateRenderPass::getStencilReferenceValue ( ) const
inline

Gets the value of the StencilReferenceValueProperty property.

See also
setStencilReferenceValue()
void kanzi::PipelineStateRenderPass::setStencilReferenceValue ( int  value)
inline

Sets the value of the StencilReferenceValueProperty property.

See also
getStencilReferenceValue()
int kanzi::PipelineStateRenderPass::getStencilMask ( ) const
inline

Gets the value of the StencilMaskProperty property.

See also
setStencilMask()
void kanzi::PipelineStateRenderPass::setStencilMask ( int  value)
inline

Sets the value of the StencilMaskProperty property.

See also
getStencilMask()
GraphicsStencilOperation kanzi::PipelineStateRenderPass::getStencilFailOperation ( ) const
inline

Gets the value of the StencilFailOperationProperty property.

See also
setStencilFailOperation()
void kanzi::PipelineStateRenderPass::setStencilFailOperation ( GraphicsStencilOperation  value)
inline

Sets the value of the StencilFailOperationProperty property.

See also
getStencilFailOperation()
GraphicsStencilOperation kanzi::PipelineStateRenderPass::getStencilPassDepthFailOperation ( ) const
inline
void kanzi::PipelineStateRenderPass::setStencilPassDepthFailOperation ( GraphicsStencilOperation  value)
inline
GraphicsStencilOperation kanzi::PipelineStateRenderPass::getStencilPassDepthPassOperation ( ) const
inline
void kanzi::PipelineStateRenderPass::setStencilPassDepthPassOperation ( GraphicsStencilOperation  value)
inline
bool kanzi::PipelineStateRenderPass::isStencilWriteEnabled ( ) const
inline

Gets the value of the StencilWriteEnabledProperty property.

See also
setStencilWriteEnabled()
void kanzi::PipelineStateRenderPass::setStencilWriteEnabled ( bool  value)
inline

Sets the value of the StencilWriteEnabledProperty property.

See also
isStencilWriteEnabled()
GraphicsCullMode kanzi::PipelineStateRenderPass::getCullMode ( ) const
inline

Gets the value of the CullModeProperty property.

See also
setCullMode()
void kanzi::PipelineStateRenderPass::setCullMode ( GraphicsCullMode  value)
inline

Sets the value of the CullModeProperty property.

See also
getCullMode()
Vector4 kanzi::PipelineStateRenderPass::getViewport ( ) const
inline

Gets the value of the ViewportProperty property.

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

Sets the value of the ViewportProperty property.

ViewportMode kanzi::PipelineStateRenderPass::getViewportMode ( ) const
inline

Gets the value of the ViewportModeProperty property.

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

Sets the value of the ViewportModeProperty property.

Vector4 kanzi::PipelineStateRenderPass::getScissor ( ) const
inline

Gets the value of the ScissorProperty property.

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

Sets the value of the ScissorProperty property.

ViewportMode kanzi::PipelineStateRenderPass::getScissorMode ( ) const
inline

Gets the value of the ScissorModeProperty property.

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

Sets the value of the ScissorModeProperty property.

Vector2 kanzi::PipelineStateRenderPass::getPolygonDepthOffset ( ) const
inline

Gets the value of the PolygonDepthOffsetProperty.

Returns
The polygon depth offset.
Since
Kanzi 3.9.4
void kanzi::PipelineStateRenderPass::setPolygonDepthOffset ( Vector2  value)
inline

Sets the value of the PolygonDepthOffsetProperty.

Parameters
valueThe polygon depth offset.
Since
Kanzi 3.9.4
static PropertyTypeEditorInfoSharedPtr kanzi::PipelineStateRenderPass::makeEditorInfo ( )
static
static PipelineStateRenderPassSharedPtr kanzi::PipelineStateRenderPass::create ( Domain domain,
string_view  name 
)
static

Create a Pipeline State Render Pass.

Parameters
domainThe domain to use.
nameThe name of the Pipeline State Render Pass.
Returns
The created Pipeline State Render Pass.
bool kanzi::PipelineStateRenderPass::pushColorBlend ( CompositionStack compositionStack)
protected

Push the color or blend state into the composition stack.

Parameters
compositionStackComposition stack to use.
Returns
True if state was pushed.
bool kanzi::PipelineStateRenderPass::pushDepthStencil ( CompositionStack compositionStack)
protected

Push the depth or stencil state into the composition stack.

Parameters
compositionStackComposition stack to use.
Returns
True if state was pushed.
bool kanzi::PipelineStateRenderPass::pushRasterization ( CompositionStack compositionStack)
protected

Push the rasterization state into the composition stack.

Parameters
compositionStackComposition stack to use.
Returns
True if state was pushed.
bool kanzi::PipelineStateRenderPass::pushViewportScissor ( CompositionStack compositionStack)
protected

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

Effectively pushes new composition area.

Parameters
compositionStackComposition stack to use.
Returns
True if state was pushed.
void kanzi::PipelineStateRenderPass::renderOverride ( Renderer3D renderer,
CompositionStack compositionStack,
const CameraSettings cameraSettings 
)
overrideprotectedvirtual

RenderPass::renderOverride() implementation.

Reimplemented from kanzi::RenderPass.

CompositionRequirements kanzi::PipelineStateRenderPass::getCompositionRequirements ( )
overrideprotectedvirtual

RenderPass::getCompositionRequirements() implementation.

Reimplemented from kanzi::RenderPass.

Member Data Documentation

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.
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()
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()
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()
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
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
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()
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()
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()
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()
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()
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()
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
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
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
PropertyType<ViewportMode> kanzi::PipelineStateRenderPass::ScissorModeProperty
static

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

See also
setScissorMode(), getScissorMode(), ScissorProperty
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: