kanzi::PipelineStateRenderPass Class Reference

Pipeline state render pass. More...

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

Inheritance diagram for kanzi::PipelineStateRenderPass:
kanzi::RenderPass kanzi::Resource kanzi::Object kanzi::MetaObject kanzi::PropertyObject

Public Types

enum  ViewportMode { ViewportModeAbsolute, ViewportModeRelative }
 
- Public Types inherited from kanzi::RenderPass
typedef vector< RenderPassSharedPtrChildContainer
 
- Public Types inherited from kanzi::PropertyObject
typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStoragePropertyStoragePtr
 
typedef vector< PropertyStoragePtrPropertyStorageContainer
 
typedef PropertyStorageContainer::iterator PropertyStorageIterator
 
typedef PropertyStorageContainer::const_iterator PropertyStorageConstIterator
 
typedef PropertyStorageContainer::reverse_iterator PropertyStorageReverseIterator
 

Public Member Functions

 PipelineStateRenderPass (Domain *domain, string_view name)
 
- Public Member Functions inherited from kanzi::RenderPass
 RenderPass (Domain *domain, string_view name)
 Constructor. More...
 
RenderPassSharedPtr lookupRenderPass (string_view path)
 Resolve a render pass by path. More...
 
void render (Renderer3D &renderer, TransformedScene3D &transformedScene, CompositionStack &compositionStack)
 Recursively render RenderPass and all of its children. More...
 
void addChild (RenderPassSharedPtr childRenderPass)
 Adds a child to render pass. More...
 
void insertChild (size_t index, RenderPassSharedPtr childRenderPass)
 Add child render pass at given index in parent. More...
 
void removeChild (RenderPass &childRenderPass)
 Removes a child render pass. More...
 
void removeAllChildren ()
 Removes all child render passes. More...
 
RenderPassSharedPtr getParent () const
 Gets the parent of the render pass. More...
 
void setParent (RenderPassSharedPtr parent)
 Sets the parent of the render pass. More...
 
RenderPassSharedPtr getChild (size_t index)
 Gets a child render pass at given index. If index is out of range 0 is returned. More...
 
size_t getChildCount () const
 Returns the amount of child render passes. More...
 
ChildContainer::const_iterator beginChildren () const
 Returns an iterator to the beginning of the child container. More...
 
ChildContainer::const_iterator endChildren () const
 Returns an iterator to the end of the child container. More...
 
TextureSharedPtr getCompositionResult ()
 Gets composition target that was used for rendering. More...
 
size_t getTextureBindingCount () const
 Gets number of texture bindings. More...
 
ResourceBinding getTextureBinding (size_t index) const
 Gets texture binding by index. More...
 
void addTextureBinding (AbstractPropertyType propertyType, string_view path, bool fromKzb)
 Add a texture binding. More...
 
void addTextureBinding (AbstractPropertyType propertyType, string_view path)
 Add a texture binding. More...
 
bool removeTextureBinding (AbstractPropertyType propertyType)
 Remove texture binding. More...
 
void removeKzbTextureBindings ()
 Remove resource bindings which were loaded from kzb files. More...
 
virtual void loadFromKZB (const KzuResourceLoaderThreadContext *threadContext, KzcInputStream *inputStream, const KzuBinaryFileInfo *file) KZ_OVERRIDE
 Resource::loadFromKZB() implementation. More...
 
- Public Member Functions inherited from kanzi::Resource
KzcMemoryManagergetMemoryManager () const
 
 Resource (Domain *domain, string_view name)
 
virtual ~Resource ()
 
virtual void unloadOverride ()
 Unload function for resource. Releases all CPU memory taken by the resource except the resource loader. More...
 
virtual unsigned int getCPUMemoryUsage () const
 Function for getting the memory usage of a resource. More...
 
void setKZB (const KzuBinaryDirectory *binaryDirectory, string_view path)
 Set the binary directory and path of the resource. More...
 
const string & getName () const
 Gets the resource name. More...
 
const string & getUrl () const
 Gets the resource URL. More...
 
void setUrl (string_view url)
 Sets the resource URL. More...
 
void setNotLoaded ()
 
bool isFromKZB () const
 
void reload ()
 
void reloadFromKzb (KzcInputStream *inputStream, const KzuBinaryFileInfo *file)
 
void reloadFromKzb (KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)
 
void reloadFromFile (string_view filePath)
 
void load ()
 
void unload ()
 
bool isLoaded () const
 
void kzuResourceLoad_private (const KzuResourceLoaderThreadContext *threadContext)
 Private function for kzuResourceLoad() with specified thread context. More...
 
void kzuResourceFinishLoading_private (const KzuResourceLoaderThreadContext *threadContext)
 Private function for finishing the loading of the resource. More...
 
bool isKeepAlive () const
 Tells if the resource has keep alive flag set. More...
 
void setKeepAlive (bool keepAlive)
 Sets the keep alive flag. More...
 
- Public Member Functions inherited from kanzi::Object
 Object (Domain *domain)
 
virtual ~Object ()
 
DomaingetDomain () const
 Returns the domain the object belongs to. More...
 
KzuTaskSchedulergetTaskScheduler () const
 Returns the task scheduler of the object. More...
 
KzuMessageDispatchergetMessageDispatcher () const
 Returns the message dispatcher of the object. More...
 
ResourceManagergetResourceManager () const
 Returns the resource manager of the object. More...
 
virtual const MetaclassgetDynamicMetaclass () const KZ_OVERRIDE
 Returns the metaclass of the dynamic type of the object. More...
 
AppliedStyleEntryapplyObjectStyle (kanzi::StyleSharedPtr style)
 Applies a style to an object. More...
 
void unapplyObjectStyle (AppliedStyleEntry *appliedStyleEntry)
 
void applyObjectStyles ()
 Apply all styles for an object node. More...
 
void unapplyObjectStyles ()
 Unapplies and removes all applied styles. More...
 
- Public Member Functions inherited from kanzi::MetaObject
virtual ~MetaObject ()
 
bool isTypeOf (const Metaclass *objectType) const
 Determines if the type of this object is the given type or derived from it. More...
 
- Public Member Functions inherited from kanzi::PropertyObject
 PropertyObject ()
 
virtual ~PropertyObject ()
 
template<typename DataType >
void setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value)
 Sets the local value of a property. More...
 
void removeKzbProperties ()
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getProperty (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property. More...
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalProperty (const PropertyType< DataType > &propertyType) const
 Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value. More...
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getPropertyBase (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property disregarding modifiers. More...
 
template<typename DataType >
void setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value)
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getAbstractProperty (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getAbstractPropertyBase (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const
 
void setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
 
bool isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const
 
void clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
 
bool hasValue (AbstractPropertyType propertyType) const
 Evaluates whether there are any inputs into the property value. More...
 
bool hasBaseValue (AbstractPropertyType propertyType) const
 Evaluates whether there are any inputs into the property value, disregarding modifiers. More...
 
bool hasLocalValue (AbstractPropertyType propertyType) const
 Evaluates whether there is a local value set for the property. More...
 
bool hasNonClassValue (AbstractPropertyType propertyType) const
 Evaluates whether there is a value of any precedence higher than class default value set for the property. More...
 
void removeLocalValue (AbstractPropertyType propertyType)
 Removes the local value associated with the property. More...
 
void copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType)
 Copies local value of single property from another object. More...
 
void copyLocalValues (const PropertyObject &other)
 Copies all local values from another object. More...
 
virtual void onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason)
 Virtual function to handle property change notifications. More...
 
template<typename DataType >
void addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, void *owner)
 
template<typename DataType >
void removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *owner)
 
template<typename DataType >
void addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 
template<typename DataType >
void removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 
void validatePropertyModifiers (AbstractPropertyType propertyType)
 
template<typename DataType >
void addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
 
template<typename DataType >
void removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
 
template<typename DataType >
size_t getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType)
 Gets number of current notification handlers for given property type. More...
 

Static Public Member Functions

static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
static PipelineStateRenderPassSharedPtr create (Domain *domain, string_view name)
 Create a clear render pass. More...
 
- Static Public Member Functions inherited from kanzi::RenderPass
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
static RenderPassSharedPtr create (Domain *domain, string_view name)
 Create a new render pass. More...
 
static RenderPassSharedPtr loadFromKZB (Domain *domain, string_view name, KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)
 Load and create render pass from kzb. More...
 
- 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

bool pushColorBlend (CompositionStack &compositionStack)
 Push color/blend state into the composition stack. More...
 
bool pushDepthStencil (CompositionStack &compositionStack)
 Push depth/stencil state into the composition stack. More...
 
bool pushRasterization (CompositionStack &compositionStack)
 Push rasterization state into the composition stack. More...
 
bool pushViewportScissor (CompositionStack &compositionStack)
 Push viewport/scissor state into the composition stack. More...
 
void renderOverride (Renderer3D &renderer, TransformedScene3D &transformedScene, CompositionStack &compositionStack) KZ_OVERRIDE
 RenderPass::renderOverride() implementation. More...
 
void requiresDepthBuffer (bool &allowDepthClear, bool &requiresDepth) const KZ_OVERRIDE
 RenderPass::requiresDepthBuffer() implementation. More...
 
- Protected Member Functions inherited from kanzi::RenderPass
virtual void loadFromKZB (Domain *domain, KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)
 Loads render pass content from kzb. More...
 
void loadChildRenderPassesFromKZB (ResourceManager &resourceManager, KzbMemoryParser &parser)
 Load child render passes from KZB. More...
 
void loadProperties (KzbMemoryParser &parser)
 Reimplementation of loadProperties from parser to accommodate paths in properties. More...
 
kzsError readProperties (struct KzcInputStream *inputStream, const struct KzuBinaryFileInfo *file, ResourceManager *resourceManager)
 Reimplementation of property reading to accommodate paths in properties. More...
 
kzsError readProperty (struct KzcInputStream *inputStream, const struct KzuBinaryFileInfo *file, ResourceManager *resourceManager)
 Reimplementation of reading single property to accommodate paths in properties. More...
 
void renderChildren (Renderer3D &renderer, TransformedScene3D &transformedScene, CompositionStack &compositionStack)
 Render all children of the render pass. More...
 
virtual TextureSharedPtr getCompositionResultOverride ()
 Render pass -specific acquirement of composition result. More...
 
- Protected Member Functions inherited from kanzi::Resource
virtual void reloadOverride ()
 
virtual void reloadFromKzbOverride (KzcInputStream *inputStream, const KzuBinaryFileInfo *file)
 
virtual void reloadFromKzbOverride (KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)
 
virtual void reloadFromFileOverride (string_view filePath)
 
virtual unsigned int getCPUMemoryUsageOverride () const
 
- Protected Member Functions inherited from kanzi::Object
void initialize ()
 
void onCopy (const Object &other)
 
- Protected Member Functions inherited from kanzi::MetaObject
 MetaObject ()
 
void initialize ()
 
- Protected Member Functions inherited from kanzi::PropertyObject
void addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, PropertyValuePrecedence precedence, void *owner)
 
void removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, void *owner)
 
AbstractPropertyTypeDescriptor::ValueSourceEntrygetTopValueSourceEntry (AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage) const
 
AbstractPropertyTypeDescriptor::ValueSourceEntrygetTopValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourceEntryfindLocalValueSourceEntry (AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
AbstractPropertyTypeDescriptor::ValueSourceEntryconstructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
AbstractPropertyTypeDescriptor::ValueSourceEntryacquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::PropertyStoragefindPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const
 
PropertyStoragePtr findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
 Gets property storage intrusive pointer that can be used to hold a reference until end of operation. More...
 
PropertyStoragePtr constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
 
PropertyStoragePtr acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::ModifierStorageacquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::ModifierStoragefindModifierStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::NotificationStorageacquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::NotificationStoragefindNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType)
 
void validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)
 
void copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 Copy local value from property storage. More...
 
PropertyStorageContainer::iterator beginPropertyStorage ()
 
PropertyStorageContainer::iterator endPropertyStorage ()
 
virtual void notifyPropertyHandlers (PropertyStoragePtr &propertyStorage, PropertyNotificationReason reason)
 
void onCopy (const PropertyObject &other)
 

Properties

static PropertyType< GraphicsBlendModeBlendModeProperty
 BlendMode property. More...
 
static PropertyType< GraphicsColorWriteModeColorWriteModeProperty
 ColorWriteMode property. More...
 
static PropertyType< GraphicsCompareFunctionDepthTestFunctionProperty
 DepthTestFunction property. More...
 
static PropertyType< bool > DepthWriteEnabledProperty
 DepthWriteEnabled property. More...
 
static PropertyType< GraphicsCompareFunctionStencilTestFunctionProperty
 StencilTestFunction property. More...
 
static PropertyType< int > StencilReferenceValueProperty
 StencilReferenceValue property. More...
 
static PropertyType< int > StencilMaskProperty
 StencilMask property. More...
 
static PropertyType< GraphicsStencilOperationStencilFailOperationProperty
 StencilFailOperation property. More...
 
static PropertyType< GraphicsStencilOperationStencilPassDepthFailOperationProperty
 StencilPassDepthFailOperation property. More...
 
static PropertyType< GraphicsStencilOperationStencilPassDepthPassOperationProperty
 StencilPassDepthPassOperation property. More...
 
static PropertyType< bool > StencilWriteEnabledProperty
 StencilWriteEnabled property. More...
 
static PropertyType< GraphicsCullModeCullModeProperty
 CullMode property. More...
 
static PropertyType< Vector4ViewportProperty
 Viewport property. More...
 
static PropertyType< ViewportModeViewportModeProperty
 ViewportMode property. More...
 
static PropertyType< Vector4ScissorProperty
 Scissor property. More...
 
static PropertyType< ViewportModeScissorModeProperty
 ScissorMode property. More...
 
GraphicsBlendMode getBlendMode () const
 Gets the value of BlendModeProperty. More...
 
void setBlendMode (GraphicsBlendMode value)
 Sets the value of BlendModeProperty. More...
 
GraphicsColorWriteMode getColorWriteMode () const
 Gets the value of ColorWriteModeProperty. More...
 
void setColorWriteMode (GraphicsColorWriteMode value)
 Sets the value of ColorWriteModeProperty. More...
 
GraphicsCompareFunction getDepthTestFunction () const
 Gets the value of DepthTestFunctionProperty. More...
 
void setDepthTestFunction (GraphicsCompareFunction value)
 Sets the value of DepthTestFunctionProperty. More...
 
bool isDepthWriteEnabled () const
 Gets the value of DepthWriteEnabledProperty. More...
 
void setDepthWriteEnabled (bool value)
 Sets the value of DepthWriteEnabledProperty. More...
 
GraphicsCompareFunction getStencilTestFunction () const
 Gets the value of StencilTestFunctionProperty. More...
 
void setStencilTestFunction (GraphicsCompareFunction value)
 Sets the value of StencilTestFunctionProperty. More...
 
int getStencilReferenceValue () const
 Gets the value of StencilReferenceValueProperty. More...
 
void setStencilReferenceValue (int value)
 Sets the value of StencilReferenceValueProperty. More...
 
int getStencilMask () const
 Gets the value of StencilMaskProperty. More...
 
void setStencilMask (int value)
 Sets the value of StencilMaskProperty. More...
 
GraphicsStencilOperation getStencilFailOperation () const
 Gets the value of StencilFailOperationProperty. More...
 
void setStencilFailOperation (GraphicsStencilOperation value)
 Sets the value of StencilFailOperationProperty. More...
 
GraphicsStencilOperation getStencilPassDepthFailOperation () const
 Gets the value of StencilPassDepthFailOperationProperty. More...
 
void setStencilPassDepthFailOperation (GraphicsStencilOperation value)
 Sets the value of StencilPassDepthFailOperationProperty. More...
 
GraphicsStencilOperation getStencilPassDepthPassOperation () const
 Gets the value of StencilPassDepthPassOperationProperty. More...
 
void setStencilPassDepthPassOperation (GraphicsStencilOperation value)
 Sets the value of StencilPassDepthPassOperationProperty. More...
 
bool isStencilWriteEnabled () const
 Gets the value of StencilWriteEnabledProperty. More...
 
void setStencilWriteEnabled (bool value)
 Sets the value of StencilWriteEnabledProperty. More...
 
GraphicsCullMode getCullMode () const
 Gets the value of CullModeProperty. More...
 
void setCullMode (GraphicsCullMode value)
 Sets the value of CullModeProperty. More...
 
Vector4 getViewport () const
 Gets value of ViewportProperty. More...
 
void setViewport (Vector4 value)
 Sets value of ViewportProperty. More...
 
ViewportMode getViewportMode () const
 Gets value of ViewportModeProperty. More...
 
void setViewportMode (ViewportMode value)
 Sets value of ViewportModeProperty. More...
 
Vector4 getScissor () const
 Gets value of ScissorProperty. More...
 
void setScissor (Vector4 value)
 Sets value of ScissorProperty. More...
 
ViewportMode getScissorMode () const
 Gets value of ScissorModeProperty. More...
 
void setScissorMode (ViewportMode value)
 Sets value of ScissorModeProperty. More...
 

Additional Inherited Members

- Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntry * > AppliedStyleContainer
 Applied style container. More...
 
- Protected Attributes inherited from kanzi::Object
AppliedStyleContainer m_appliedStyles
 Listing of applied styles applied to this object. More...
 

Detailed Description

Pipeline state render pass.

Sets up pipeline state for k

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

Member Function Documentation

GraphicsBlendMode kanzi::PipelineStateRenderPass::getBlendMode ( ) const
inline

Gets the value of BlendModeProperty.

See also
setBlendMode()
void kanzi::PipelineStateRenderPass::setBlendMode ( GraphicsBlendMode  value)
inline

Sets the value of BlendModeProperty.

See also
getBlendMode()
GraphicsColorWriteMode kanzi::PipelineStateRenderPass::getColorWriteMode ( ) const
inline

Gets the value of ColorWriteModeProperty.

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

Sets the value of ColorWriteModeProperty.

See also
getColorWriteMode()
GraphicsCompareFunction kanzi::PipelineStateRenderPass::getDepthTestFunction ( ) const
inline
void kanzi::PipelineStateRenderPass::setDepthTestFunction ( GraphicsCompareFunction  value)
inline
bool kanzi::PipelineStateRenderPass::isDepthWriteEnabled ( ) const
inline
void kanzi::PipelineStateRenderPass::setDepthWriteEnabled ( bool  value)
inline
GraphicsCompareFunction kanzi::PipelineStateRenderPass::getStencilTestFunction ( ) const
inline
void kanzi::PipelineStateRenderPass::setStencilTestFunction ( GraphicsCompareFunction  value)
inline
int kanzi::PipelineStateRenderPass::getStencilReferenceValue ( ) const
inline
void kanzi::PipelineStateRenderPass::setStencilReferenceValue ( int  value)
inline
int kanzi::PipelineStateRenderPass::getStencilMask ( ) const
inline

Gets the value of StencilMaskProperty.

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

Sets the value of StencilMaskProperty.

See also
getStencilMask()
GraphicsStencilOperation kanzi::PipelineStateRenderPass::getStencilFailOperation ( ) const
inline
void kanzi::PipelineStateRenderPass::setStencilFailOperation ( GraphicsStencilOperation  value)
inline
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
void kanzi::PipelineStateRenderPass::setStencilWriteEnabled ( bool  value)
inline
GraphicsCullMode kanzi::PipelineStateRenderPass::getCullMode ( ) const
inline

Gets the value of CullModeProperty.

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

Sets the value of CullModeProperty.

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

Gets value of ViewportProperty.

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

Sets value of ViewportProperty.

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

Gets value of ViewportModeProperty.

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

Sets value of ViewportModeProperty.

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

Gets value of ScissorProperty.

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

Sets value of ScissorProperty.

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

Gets value of ScissorModeProperty.

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

Sets value of ScissorModeProperty.

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

Create a clear render pass.

Parameters
domainDomain to use.
nameRender pass name.
Returns
Newly created render pass.
bool kanzi::PipelineStateRenderPass::pushColorBlend ( CompositionStack compositionStack)
protected

Push color/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 depth/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 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 viewport/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,
TransformedScene3D transformedScene,
CompositionStack compositionStack 
)
protectedvirtual

RenderPass::renderOverride() implementation.

Reimplemented from kanzi::RenderPass.

void kanzi::PipelineStateRenderPass::requiresDepthBuffer ( bool &  allowDepthClear,
bool &  requiresDepth 
) const
protectedvirtual

RenderPass::requiresDepthBuffer() implementation.

Reimplemented from kanzi::RenderPass.

Member Data Documentation

PropertyType<GraphicsBlendMode> kanzi::PipelineStateRenderPass::BlendModeProperty
static

BlendMode property.

The default value is GraphicsBlendModeOpaque.

See also
setBlendMode(), getBlendMode()
PropertyType<GraphicsColorWriteMode> kanzi::PipelineStateRenderPass::ColorWriteModeProperty
static

ColorWriteMode property.

The default value is GraphicsColorWriteModeRGBA.

See also
setColorWriteMode(), getColorWriteMode()
PropertyType<GraphicsCompareFunction> kanzi::PipelineStateRenderPass::DepthTestFunctionProperty
static

DepthTestFunction property.

The default value is GraphicsCompareFunctionLess.

See also
setDepthTestFunction(), getDepthTestFunction()
PropertyType<bool> kanzi::PipelineStateRenderPass::DepthWriteEnabledProperty
static

DepthWriteEnabled property.

The default value is true.

See also
setDepthWriteEnabled(), isDepthWriteEnabled()
PropertyType<GraphicsCompareFunction> kanzi::PipelineStateRenderPass::StencilTestFunctionProperty
static

StencilTestFunction property.

The default value is GraphicsCompareFunctionDisabled.

See also
setStencilTestFunction(), getStencilTestFunction()
PropertyType<int> kanzi::PipelineStateRenderPass::StencilReferenceValueProperty
static

StencilReferenceValue property.

The default value is 0.

See also
setStencilReferenceValue(), getStencilReferenceValue()
PropertyType<int> kanzi::PipelineStateRenderPass::StencilMaskProperty
static

StencilMask property.

The default value is 255.

See also
setStencilMask(), getStencilMask()
PropertyType<GraphicsStencilOperation> kanzi::PipelineStateRenderPass::StencilFailOperationProperty
static

StencilFailOperation property.

The default value is GraphicsStencilOperationKeep.

See also
setStencilFailOperation(), getStencilFailOperation()
PropertyType<GraphicsStencilOperation> kanzi::PipelineStateRenderPass::StencilPassDepthFailOperationProperty
static

StencilPassDepthFailOperation property.

The default value is GraphicsStencilOperationKeep.

See also
setStencilPassDepthFailOperation(), getStencilPassDepthFailOperation()
PropertyType<GraphicsStencilOperation> kanzi::PipelineStateRenderPass::StencilPassDepthPassOperationProperty
static

StencilPassDepthPassOperation property.

The default value is GraphicsStencilOperationKeep.

See also
setStencilPassDepthPassOperation(), getStencilPassDepthPassOperation()
PropertyType<bool> kanzi::PipelineStateRenderPass::StencilWriteEnabledProperty
static

StencilWriteEnabled property.

The default value is false.

See also
setStencilWriteEnabled(), isStencilWriteEnabled()
PropertyType<GraphicsCullMode> kanzi::PipelineStateRenderPass::CullModeProperty
static

CullMode property.

The default value is GraphicsCullModeBack.

See also
setCullMode(), getCullMode()
PropertyType<Vector4> kanzi::PipelineStateRenderPass::ViewportProperty
static

Viewport property.

See also
setViewport(), getViewport().
PropertyType<ViewportMode> kanzi::PipelineStateRenderPass::ViewportModeProperty
static

ViewportMode property.

See also
setViewportMode(), getViewportMode().
PropertyType<Vector4> kanzi::PipelineStateRenderPass::ScissorProperty
static

Scissor property.

See also
setScissor(), getScissor().
PropertyType<ViewportMode> kanzi::PipelineStateRenderPass::ScissorModeProperty
static

ScissorMode property.

See also
setScissorMode(), getScissorMode().

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