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

Legacy Render Pass is phased out in favor of specialized render passes that perform individual operations, which are combined in a Legacy Render Pass into a single render pass. More...

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

Inheritance diagram for kanzi::LegacyRenderPass:
[legend]

Public Types

enum  FramebufferTarget { FramebufferTargetDraw, FramebufferTargetMultisampleResolve, FramebufferTargetCount }
 Framebuffer target for set framebuffers. More...
 
enum  InvalidateAttachments { InvalidateAttachmentsNone, InvalidateAttachmentsColor, InvalidateAttachmentsDepthStencil, InvalidateAttachmentsAll }
 RenderTargetTexture attachments to invalidate after Renderpass. More...
 
- 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 LegacyRenderPassSharedPtr create (Domain *domain, string_view name)
 Create a 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

 LegacyRenderPass (Domain *domain, string_view name)
 Constructor. 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...
 
virtual void renderOverride (Renderer3D &renderer, CompositionStack &compositionStack, const CameraSettings *cameraSettings)
 Render implementation specific to the RenderPass class. 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< bool > FlushAfterRenderProperty
 FlushAfterRender property. More...
 
static PropertyType< ResourceSharedPtrRenderPassRenderTargetColor0Property
 RenderPassRenderTargetColor0 property. More...
 
static PropertyType< ResourceSharedPtrRenderPassRenderTargetColor1Property
 RenderPassRenderTargetColor1 property. More...
 
static PropertyType< ResourceSharedPtrRenderPassRenderTargetColor2Property
 RenderPassRenderTargetColor2 property. More...
 
static PropertyType< ResourceSharedPtrRenderPassRenderTargetColor3Property
 RenderPassRenderTargetColor3 property. More...
 
static PropertyType< ResourceSharedPtrRenderPassRenderTargetDepthStencilProperty
 RenderPassRenderTargetDepthStencil property. More...
 
static PropertyType< float > ViewportXProperty
 ViewportX property. More...
 
static PropertyType< float > ViewportYProperty
 ViewportY property. More...
 
static PropertyType< float > ViewportWidthProperty
 ViewportWidth property. More...
 
static PropertyType< float > ViewportHeightProperty
 ViewportHeight property. More...
 
static PropertyType< KzuViewportCoordinateTypeViewportTypeProperty
 ViewportType property. More...
 
static PropertyType< string > RenderPassCameraProperty
 RenderPassCamera property. More...
 
static PropertyType< ResourceSharedPtrRenderPassObjectSourceProperty
 RenderPassObjectSource property. More...
 
static PropertyType< ResourceSharedPtrRenderPassMaterialProperty
 RenderPassMaterial property. More...
 
static PropertyType< int > RenderPassRenderTargetMipmapLevelProperty
 RenderPassRenderTargetMipmapLevel property. More...
 
static PropertyType< bool > RenderPassRenderTargetResolveProperty
 RenderPassRenderTargetResolve property. More...
 
static PropertyType< LegacyRenderPass::InvalidateAttachmentsRenderPassRenderTargetInvalidateAttachmentsProperty
 RenderPassRenderTargetInvalidateAttachments property. More...
 
static PropertyType< bool > RenderPassRenderTargetGenerateMipmapProperty
 RenderPassRenderTargetGenerateMipmap property. More...
 
static PropertyType< bool > FrustumCullingOnProperty
 FrustumCullingOn property. More...
 
static PropertyType< GraphicsCullModeCullModeProperty
 CullMode property. More...
 
static PropertyType< bool > RenderOnceProperty
 RenderOnce property. More...
 
static PropertyType< Vector4Color0IntegerClearValueProperty
 Color0IntegerClearValue property. More...
 
static PropertyType< Vector4Color0FloatClearValueProperty
 Color0FloatClearValue property. More...
 
static PropertyType< Vector4Color1IntegerClearValueProperty
 Color1IntegerClearValue property. More...
 
static PropertyType< Vector4Color1FloatClearValueProperty
 Color1FloatClearValue property. More...
 
static PropertyType< Vector4Color2IntegerClearValueProperty
 Color2IntegerClearValue property. More...
 
static PropertyType< Vector4Color2FloatClearValueProperty
 Color2FloatClearValue property. More...
 
static PropertyType< Vector4Color3IntegerClearValueProperty
 Color3IntegerClearValue property. More...
 
static PropertyType< Vector4Color3FloatClearValueProperty
 Color3FloatClearValue property. More...
 
static PropertyType< ColorRGBAColorBufferClearColorProperty
 ColorBufferClearColor property. More...
 
static PropertyType< bool > ColorBufferClearEnabledProperty
 ColorBufferClearEnabled property. More...
 
static PropertyType< ColorRGBAColor1ColorClearValueProperty
 Color1ColorClearValue property. More...
 
static PropertyType< ColorRGBAColor2ColorClearValueProperty
 Color2ColorClearValue property. More...
 
static PropertyType< ColorRGBAColor3ColorClearValueProperty
 Color3ColorClearValue property. More...
 
static PropertyType< GraphicsColorWriteModeColorWriteModeProperty
 ColorWriteMode property. More...
 
static PropertyType< bool > DepthBufferClearEnabledProperty
 DepthBufferClearEnabled property. More...
 
static PropertyType< float > DepthBufferClearValueProperty
 DepthBufferClearValue property. More...
 
static PropertyType< bool > DepthBufferTestEnabledProperty
 DepthBufferTestEnabled property. More...
 
static PropertyType< bool > DepthBufferWriteEnabledProperty
 DepthBufferWriteEnabled property. More...
 
static PropertyType< bool > StencilBufferClearEnabledProperty
 StencilBufferClearEnabled property. More...
 
static PropertyType< int > StencilBufferClearValueProperty
 StencilBufferClearValue property. More...
 
static PropertyType< GraphicsStencilOperationStencilFailOperationProperty
 StencilFailOperation property. More...
 
static PropertyType< GraphicsStencilOperationStencilPassDepthFailOperationProperty
 StencilPassDepthFailOperation property. More...
 
static PropertyType< GraphicsStencilOperationStencilPassDepthPassOperationProperty
 StencilPassDepthPassOperation property. More...
 
static PropertyType< GraphicsCompareFunctionStencilFunctionProperty
 StencilFunction property. More...
 
static PropertyType< int > StencilFunctionReferenceValueProperty
 StencilFunctionReferenceValue property. More...
 
static PropertyType< int > StencilFunctionReferenceMaskProperty
 StencilFunctionReferenceMask property. More...
 
static PropertyType< bool > StencilBufferTestEnabledProperty
 StencilBufferTestEnabled property. More...
 
static PropertyType< bool > RenderPassScissorEnabledProperty
 RenderPassScissorEnabled property. More...
 
static PropertyType< float > RenderPassScissorXProperty
 RenderPassScissorX property. More...
 
static PropertyType< float > RenderPassScissorYProperty
 RenderPassScissorY property. More...
 
static PropertyType< float > RenderPassScissorWidthProperty
 RenderPassScissorWidth property. More...
 
static PropertyType< float > RenderPassScissorHeightProperty
 RenderPassScissorHeight property. More...
 
static PropertyType< KzuViewportCoordinateTypeRenderPassScissorTypeProperty
 RenderPassScissorType property. More...
 
static PropertyType< bool > ComposerEnabledProperty
 ComposerEnabled property. More...
 
bool isFlushAfterRender () const
 Gets the value of FlushAfterRenderProperty. More...
 
void setFlushAfterRender (bool value)
 Sets the value of FlushAfterRenderProperty. More...
 
ResourceSharedPtr getRenderPassRenderTargetColor0 () const
 Gets the value of RenderPassRenderTargetColor0Property. More...
 
void setRenderPassRenderTargetColor0 (ResourceSharedPtr value)
 Sets the value of RenderPassRenderTargetColor0Property. More...
 
ResourceSharedPtr getRenderPassRenderTargetColor1 () const
 Gets the value of RenderPassRenderTargetColor1Property. More...
 
void setRenderPassRenderTargetColor1 (ResourceSharedPtr value)
 Sets the value of RenderPassRenderTargetColor1Property. More...
 
ResourceSharedPtr getRenderPassRenderTargetColor2 () const
 Gets the value of RenderPassRenderTargetColor2Property. More...
 
void setRenderPassRenderTargetColor2 (ResourceSharedPtr value)
 Sets the value of RenderPassRenderTargetColor2Property. More...
 
ResourceSharedPtr getRenderPassRenderTargetColor3 () const
 Gets the value of RenderPassRenderTargetColor3Property. More...
 
void setRenderPassRenderTargetColor3 (ResourceSharedPtr value)
 Sets the value of RenderPassRenderTargetColor3Property. More...
 
ResourceSharedPtr getRenderPassRenderTargetDepthStencil () const
 Gets the value of RenderPassRenderTargetDepthStencilProperty. More...
 
void setRenderPassRenderTargetDepthStencil (ResourceSharedPtr value)
 Sets the value of RenderPassRenderTargetDepthStencilProperty. More...
 
float getViewportX () const
 Gets the value of ViewportXProperty. More...
 
void setViewportX (float value)
 Sets the value of ViewportXProperty. More...
 
float getViewportY () const
 Gets the value of ViewportYProperty. More...
 
void setViewportY (float value)
 Sets the value of ViewportYProperty. More...
 
float getViewportWidth () const
 Gets the value of ViewportWidthProperty. More...
 
void setViewportWidth (float value)
 Sets the value of ViewportWidthProperty. More...
 
float getViewportHeight () const
 Gets the value of ViewportHeightProperty. More...
 
void setViewportHeight (float value)
 Sets the value of ViewportHeightProperty. More...
 
KzuViewportCoordinateType getViewportType () const
 Gets the value of ViewportTypeProperty. More...
 
void setViewportType (KzuViewportCoordinateType value)
 Sets the value of ViewportTypeProperty. More...
 
string getRenderPassCamera () const
 Gets the value of RenderPassCameraProperty. More...
 
void setRenderPassCamera (string value)
 Sets the value of RenderPassCameraProperty. More...
 
ResourceSharedPtr getRenderPassObjectSource () const
 Gets the value of RenderPassObjectSourceProperty. More...
 
void setRenderPassObjectSource (ResourceSharedPtr value)
 Sets the value of RenderPassObjectSourceProperty. More...
 
ResourceSharedPtr getRenderPassMaterial () const
 Gets the value of RenderPassMaterialProperty. More...
 
void setRenderPassMaterial (ResourceSharedPtr value)
 Sets the value of RenderPassMaterialProperty. More...
 
int getRenderPassRenderTargetMipmapLevel () const
 Gets the value of RenderPassRenderTargetMipmapLevelProperty. More...
 
void setRenderPassRenderTargetMipmapLevel (int value)
 Sets the value of RenderPassRenderTargetMipmapLevelProperty. More...
 
bool isRenderPassRenderTargetResolve () const
 Gets the value of RenderPassRenderTargetResolveProperty. More...
 
void setRenderPassRenderTargetResolve (bool value)
 Sets the value of RenderPassRenderTargetResolveProperty. More...
 
LegacyRenderPass::InvalidateAttachments getRenderPassRenderTargetInvalidateAttachments () const
 Gets the value of RenderPassRenderTargetInvalidateAttachmentsProperty. More...
 
void setRenderPassRenderTargetInvalidateAttachments (LegacyRenderPass::InvalidateAttachments value)
 Sets the value of RenderPassRenderTargetInvalidateAttachmentsProperty. More...
 
bool isRenderPassRenderTargetGenerateMipmap () const
 Gets the value of RenderPassRenderTargetGenerateMipmapProperty. More...
 
void setRenderPassRenderTargetGenerateMipmap (bool value)
 Sets the value of RenderPassRenderTargetGenerateMipmapProperty. More...
 
bool isFrustumCullingOn () const
 Gets the value of FrustumCullingOnProperty. More...
 
void setFrustumCullingOn (bool value)
 Sets the value of FrustumCullingOnProperty. More...
 
GraphicsCullMode getCullMode () const
 Gets the value of CullModeProperty. More...
 
void setCullMode (GraphicsCullMode value)
 Sets the value of CullModeProperty. More...
 
Vector4 getColor0IntegerClearValue () const
 Gets the value of Color0IntegerClearValueProperty. More...
 
void setColor0IntegerClearValue (Vector4 value)
 Sets the value of Color0IntegerClearValueProperty. More...
 
Vector4 getColor0FloatClearValue () const
 Gets the value of Color0FloatClearValueProperty. More...
 
void setColor0FloatClearValue (Vector4 value)
 Sets the value of Color0FloatClearValueProperty. More...
 
Vector4 getColor1IntegerClearValue () const
 Gets the value of Color1IntegerClearValueProperty. More...
 
void setColor1IntegerClearValue (Vector4 value)
 Sets the value of Color1IntegerClearValueProperty. More...
 
Vector4 getColor1FloatClearValue () const
 Gets the value of Color1FloatClearValueProperty. More...
 
void setColor1FloatClearValue (Vector4 value)
 Sets the value of Color1FloatClearValueProperty. More...
 
Vector4 getColor2IntegerClearValue () const
 Gets the value of Color2IntegerClearValueProperty. More...
 
void setColor2IntegerClearValue (Vector4 value)
 Sets the value of Color2IntegerClearValueProperty. More...
 
Vector4 getColor2FloatClearValue () const
 Gets the value of Color2FloatClearValueProperty. More...
 
void setColor2FloatClearValue (Vector4 value)
 Sets the value of Color2FloatClearValueProperty. More...
 
Vector4 getColor3IntegerClearValue () const
 Gets the value of Color3IntegerClearValueProperty. More...
 
void setColor3IntegerClearValue (Vector4 value)
 Sets the value of Color3IntegerClearValueProperty. More...
 
Vector4 getColor3FloatClearValue () const
 Gets the value of Color3FloatClearValueProperty. More...
 
void setColor3FloatClearValue (Vector4 value)
 Sets the value of Color3FloatClearValueProperty. More...
 
ColorRGBA getColorBufferClearColor () const
 Gets the value of ColorBufferClearColorProperty. More...
 
void setColorBufferClearColor (ColorRGBA value)
 Sets the value of ColorBufferClearColorProperty. More...
 
bool isColorBufferClearEnabled () const
 Gets the value of ColorBufferClearEnabledProperty. More...
 
void setColorBufferClearEnabled (bool value)
 Sets the value of ColorBufferClearEnabledProperty. More...
 
ColorRGBA getColor1ColorClearValue () const
 Gets the value of Color1ColorClearValueProperty. More...
 
void setColor1ColorClearValue (ColorRGBA value)
 Sets the value of Color1ColorClearValueProperty. More...
 
ColorRGBA getColor2ColorClearValue () const
 Gets the value of Color2ColorClearValueProperty. More...
 
void setColor2ColorClearValue (ColorRGBA value)
 Sets the value of Color2ColorClearValueProperty. More...
 
ColorRGBA getColor3ColorClearValue () const
 Gets the value of Color3ColorClearValueProperty. More...
 
void setColor3ColorClearValue (ColorRGBA value)
 Sets the value of Color3ColorClearValueProperty. More...
 
GraphicsColorWriteMode getColorWriteMode () const
 Gets the value of ColorWriteModeProperty. More...
 
void setColorWriteMode (GraphicsColorWriteMode value)
 Sets the value of ColorWriteModeProperty. More...
 
bool isDepthBufferClearEnabled () const
 Gets the value of DepthBufferClearEnabledProperty. More...
 
void setDepthBufferClearEnabled (bool value)
 Sets the value of DepthBufferClearEnabledProperty. More...
 
float getDepthBufferClearValue () const
 Gets the value of DepthBufferClearValueProperty. More...
 
void setDepthBufferClearValue (float value)
 Sets the value of DepthBufferClearValueProperty. More...
 
bool isDepthBufferTestEnabled () const
 Gets the value of DepthBufferTestEnabledProperty. More...
 
void setDepthBufferTestEnabled (bool value)
 Sets the value of DepthBufferTestEnabledProperty. More...
 
bool isDepthBufferWriteEnabled () const
 Gets the value of DepthBufferWriteEnabledProperty. More...
 
void setDepthBufferWriteEnabled (bool value)
 Sets the value of DepthBufferWriteEnabledProperty. More...
 
bool isStencilBufferClearEnabled () const
 Gets the value of StencilBufferClearEnabledProperty. More...
 
void setStencilBufferClearEnabled (bool value)
 Sets the value of StencilBufferClearEnabledProperty. More...
 
int getStencilBufferClearValue () const
 Gets the value of StencilBufferClearValueProperty. More...
 
void setStencilBufferClearValue (int value)
 Sets the value of StencilBufferClearValueProperty. 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...
 
GraphicsCompareFunction getStencilFunction () const
 Gets the value of StencilFunctionProperty. More...
 
void setStencilFunction (GraphicsCompareFunction value)
 Sets the value of StencilFunctionProperty. More...
 
int getStencilFunctionReferenceValue () const
 Gets the value of StencilFunctionReferenceValueProperty. More...
 
void setStencilFunctionReferenceValue (int value)
 Sets the value of StencilFunctionReferenceValueProperty. More...
 
int getStencilFunctionReferenceMask () const
 Gets the value of StencilFunctionReferenceMaskProperty. More...
 
void setStencilFunctionReferenceMask (int value)
 Sets the value of StencilFunctionReferenceMaskProperty. More...
 
bool isStencilBufferTestEnabled () const
 Gets the value of StencilBufferTestEnabledProperty. More...
 
void setStencilBufferTestEnabled (bool value)
 Sets the value of StencilBufferTestEnabledProperty. More...
 
bool isRenderPassScissorEnabled () const
 Gets the value of RenderPassScissorEnabledProperty. More...
 
void setRenderPassScissorEnabled (bool value)
 Sets the value of RenderPassScissorEnabledProperty. More...
 
float getRenderPassScissorX () const
 Gets the value of RenderPassScissorXProperty. More...
 
void setRenderPassScissorX (float value)
 Sets the value of RenderPassScissorXProperty. More...
 
float getRenderPassScissorY () const
 Gets the value of RenderPassScissorYProperty. More...
 
void setRenderPassScissorY (float value)
 Sets the value of RenderPassScissorYProperty. More...
 
float getRenderPassScissorWidth () const
 Gets the value of RenderPassScissorWidthProperty. More...
 
void setRenderPassScissorWidth (float value)
 Sets the value of RenderPassScissorWidthProperty. More...
 
float getRenderPassScissorHeight () const
 Gets the value of RenderPassScissorHeightProperty. More...
 
void setRenderPassScissorHeight (float value)
 Sets the value of RenderPassScissorHeightProperty. More...
 
KzuViewportCoordinateType getRenderPassScissorType () const
 Gets the value of RenderPassScissorTypeProperty. More...
 
void setRenderPassScissorType (KzuViewportCoordinateType value)
 Sets the value of RenderPassScissorTypeProperty. More...
 
bool isComposerEnabled () const
 Gets the value of ComposerEnabledProperty. More...
 
void setComposerEnabled (bool value)
 Sets the value of ComposerEnabledProperty. 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...
 
virtual CompositionRequirements getCompositionRequirements ()
 Queries if a render pass requires a depth buffer. 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

Legacy Render Pass is phased out in favor of specialized render passes that perform individual operations, which are combined in a Legacy Render Pass into a single render pass.

See also
BlitRenderPass, ClearRenderPass, CompositionTargetRenderPass, DrawObjectsRenderPass, PipelineStateRenderPass

Member Enumeration Documentation

Framebuffer target for set framebuffers.

Enumerator
FramebufferTargetDraw 

Framebuffer that is used for rendering to in the render pass.

FramebufferTargetMultisampleResolve 

Framebuffer that is multisample resolve destination after render pass.

FramebufferTargetCount 

Number of valid values for FramebufferTarget enum.

RenderTargetTexture attachments to invalidate after Renderpass.

Enumerator
InvalidateAttachmentsNone 

Do not invalidate any attachments.

InvalidateAttachmentsColor 

Invalidate color attachments.

InvalidateAttachmentsDepthStencil 

Invalidate depth/stencil attachment.

InvalidateAttachmentsAll 

Invalidate all attachments.

Constructor & Destructor Documentation

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

Constructor.

Parameters
domainThe domain to use.
nameName of the Legacy Render Pass.

Member Function Documentation

bool kanzi::LegacyRenderPass::isFlushAfterRender ( ) const
inline

Gets the value of FlushAfterRenderProperty.

See also
setFlushAfterRender()
void kanzi::LegacyRenderPass::setFlushAfterRender ( bool  value)
inline

Sets the value of FlushAfterRenderProperty.

See also
isFlushAfterRender()
ResourceSharedPtr kanzi::LegacyRenderPass::getRenderPassRenderTargetColor0 ( ) const
inline
void kanzi::LegacyRenderPass::setRenderPassRenderTargetColor0 ( ResourceSharedPtr  value)
inline
ResourceSharedPtr kanzi::LegacyRenderPass::getRenderPassRenderTargetColor1 ( ) const
inline
void kanzi::LegacyRenderPass::setRenderPassRenderTargetColor1 ( ResourceSharedPtr  value)
inline
ResourceSharedPtr kanzi::LegacyRenderPass::getRenderPassRenderTargetColor2 ( ) const
inline
void kanzi::LegacyRenderPass::setRenderPassRenderTargetColor2 ( ResourceSharedPtr  value)
inline
ResourceSharedPtr kanzi::LegacyRenderPass::getRenderPassRenderTargetColor3 ( ) const
inline
void kanzi::LegacyRenderPass::setRenderPassRenderTargetColor3 ( ResourceSharedPtr  value)
inline
ResourceSharedPtr kanzi::LegacyRenderPass::getRenderPassRenderTargetDepthStencil ( ) const
inline
void kanzi::LegacyRenderPass::setRenderPassRenderTargetDepthStencil ( ResourceSharedPtr  value)
inline
float kanzi::LegacyRenderPass::getViewportX ( ) const
inline

Gets the value of ViewportXProperty.

See also
setViewportX()
void kanzi::LegacyRenderPass::setViewportX ( float  value)
inline

Sets the value of ViewportXProperty.

See also
getViewportX()
float kanzi::LegacyRenderPass::getViewportY ( ) const
inline

Gets the value of ViewportYProperty.

See also
setViewportY()
void kanzi::LegacyRenderPass::setViewportY ( float  value)
inline

Sets the value of ViewportYProperty.

See also
getViewportY()
float kanzi::LegacyRenderPass::getViewportWidth ( ) const
inline

Gets the value of ViewportWidthProperty.

See also
setViewportWidth()
void kanzi::LegacyRenderPass::setViewportWidth ( float  value)
inline

Sets the value of ViewportWidthProperty.

See also
getViewportWidth()
float kanzi::LegacyRenderPass::getViewportHeight ( ) const
inline

Gets the value of ViewportHeightProperty.

See also
setViewportHeight()
void kanzi::LegacyRenderPass::setViewportHeight ( float  value)
inline

Sets the value of ViewportHeightProperty.

See also
getViewportHeight()
KzuViewportCoordinateType kanzi::LegacyRenderPass::getViewportType ( ) const
inline

Gets the value of ViewportTypeProperty.

See also
setViewportType()
void kanzi::LegacyRenderPass::setViewportType ( KzuViewportCoordinateType  value)
inline

Sets the value of ViewportTypeProperty.

See also
getViewportType()
string kanzi::LegacyRenderPass::getRenderPassCamera ( ) const
inline

Gets the value of RenderPassCameraProperty.

See also
setRenderPassCamera()
void kanzi::LegacyRenderPass::setRenderPassCamera ( string  value)
inline

Sets the value of RenderPassCameraProperty.

See also
getRenderPassCamera()
ResourceSharedPtr kanzi::LegacyRenderPass::getRenderPassObjectSource ( ) const
inline
void kanzi::LegacyRenderPass::setRenderPassObjectSource ( ResourceSharedPtr  value)
inline
ResourceSharedPtr kanzi::LegacyRenderPass::getRenderPassMaterial ( ) const
inline
void kanzi::LegacyRenderPass::setRenderPassMaterial ( ResourceSharedPtr  value)
inline
int kanzi::LegacyRenderPass::getRenderPassRenderTargetMipmapLevel ( ) const
inline
void kanzi::LegacyRenderPass::setRenderPassRenderTargetMipmapLevel ( int  value)
inline
bool kanzi::LegacyRenderPass::isRenderPassRenderTargetResolve ( ) const
inline
void kanzi::LegacyRenderPass::setRenderPassRenderTargetResolve ( bool  value)
inline
LegacyRenderPass::InvalidateAttachments kanzi::LegacyRenderPass::getRenderPassRenderTargetInvalidateAttachments ( ) const
inline
void kanzi::LegacyRenderPass::setRenderPassRenderTargetInvalidateAttachments ( LegacyRenderPass::InvalidateAttachments  value)
inline
bool kanzi::LegacyRenderPass::isRenderPassRenderTargetGenerateMipmap ( ) const
inline
void kanzi::LegacyRenderPass::setRenderPassRenderTargetGenerateMipmap ( bool  value)
inline
bool kanzi::LegacyRenderPass::isFrustumCullingOn ( ) const
inline

Gets the value of FrustumCullingOnProperty.

See also
setFrustumCullingOn()
void kanzi::LegacyRenderPass::setFrustumCullingOn ( bool  value)
inline

Sets the value of FrustumCullingOnProperty.

See also
isFrustumCullingOn()
GraphicsCullMode kanzi::LegacyRenderPass::getCullMode ( ) const
inline

Gets the value of CullModeProperty.

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

Sets the value of CullModeProperty.

See also
getCullMode()
Vector4 kanzi::LegacyRenderPass::getColor0IntegerClearValue ( ) const
inline
void kanzi::LegacyRenderPass::setColor0IntegerClearValue ( Vector4  value)
inline
Vector4 kanzi::LegacyRenderPass::getColor0FloatClearValue ( ) const
inline
void kanzi::LegacyRenderPass::setColor0FloatClearValue ( Vector4  value)
inline
Vector4 kanzi::LegacyRenderPass::getColor1IntegerClearValue ( ) const
inline
void kanzi::LegacyRenderPass::setColor1IntegerClearValue ( Vector4  value)
inline
Vector4 kanzi::LegacyRenderPass::getColor1FloatClearValue ( ) const
inline
void kanzi::LegacyRenderPass::setColor1FloatClearValue ( Vector4  value)
inline
Vector4 kanzi::LegacyRenderPass::getColor2IntegerClearValue ( ) const
inline
void kanzi::LegacyRenderPass::setColor2IntegerClearValue ( Vector4  value)
inline
Vector4 kanzi::LegacyRenderPass::getColor2FloatClearValue ( ) const
inline
void kanzi::LegacyRenderPass::setColor2FloatClearValue ( Vector4  value)
inline
Vector4 kanzi::LegacyRenderPass::getColor3IntegerClearValue ( ) const
inline
void kanzi::LegacyRenderPass::setColor3IntegerClearValue ( Vector4  value)
inline
Vector4 kanzi::LegacyRenderPass::getColor3FloatClearValue ( ) const
inline
void kanzi::LegacyRenderPass::setColor3FloatClearValue ( Vector4  value)
inline
ColorRGBA kanzi::LegacyRenderPass::getColorBufferClearColor ( ) const
inline
void kanzi::LegacyRenderPass::setColorBufferClearColor ( ColorRGBA  value)
inline
bool kanzi::LegacyRenderPass::isColorBufferClearEnabled ( ) const
inline
void kanzi::LegacyRenderPass::setColorBufferClearEnabled ( bool  value)
inline
ColorRGBA kanzi::LegacyRenderPass::getColor1ColorClearValue ( ) const
inline
void kanzi::LegacyRenderPass::setColor1ColorClearValue ( ColorRGBA  value)
inline
ColorRGBA kanzi::LegacyRenderPass::getColor2ColorClearValue ( ) const
inline
void kanzi::LegacyRenderPass::setColor2ColorClearValue ( ColorRGBA  value)
inline
ColorRGBA kanzi::LegacyRenderPass::getColor3ColorClearValue ( ) const
inline
void kanzi::LegacyRenderPass::setColor3ColorClearValue ( ColorRGBA  value)
inline
GraphicsColorWriteMode kanzi::LegacyRenderPass::getColorWriteMode ( ) const
inline

Gets the value of ColorWriteModeProperty.

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

Sets the value of ColorWriteModeProperty.

See also
getColorWriteMode()
bool kanzi::LegacyRenderPass::isDepthBufferClearEnabled ( ) const
inline
void kanzi::LegacyRenderPass::setDepthBufferClearEnabled ( bool  value)
inline
float kanzi::LegacyRenderPass::getDepthBufferClearValue ( ) const
inline
void kanzi::LegacyRenderPass::setDepthBufferClearValue ( float  value)
inline
bool kanzi::LegacyRenderPass::isDepthBufferTestEnabled ( ) const
inline
void kanzi::LegacyRenderPass::setDepthBufferTestEnabled ( bool  value)
inline
bool kanzi::LegacyRenderPass::isDepthBufferWriteEnabled ( ) const
inline
void kanzi::LegacyRenderPass::setDepthBufferWriteEnabled ( bool  value)
inline
bool kanzi::LegacyRenderPass::isStencilBufferClearEnabled ( ) const
inline
void kanzi::LegacyRenderPass::setStencilBufferClearEnabled ( bool  value)
inline
int kanzi::LegacyRenderPass::getStencilBufferClearValue ( ) const
inline
void kanzi::LegacyRenderPass::setStencilBufferClearValue ( int  value)
inline
GraphicsStencilOperation kanzi::LegacyRenderPass::getStencilFailOperation ( ) const
inline
void kanzi::LegacyRenderPass::setStencilFailOperation ( GraphicsStencilOperation  value)
inline
GraphicsStencilOperation kanzi::LegacyRenderPass::getStencilPassDepthFailOperation ( ) const
inline
void kanzi::LegacyRenderPass::setStencilPassDepthFailOperation ( GraphicsStencilOperation  value)
inline
GraphicsStencilOperation kanzi::LegacyRenderPass::getStencilPassDepthPassOperation ( ) const
inline
void kanzi::LegacyRenderPass::setStencilPassDepthPassOperation ( GraphicsStencilOperation  value)
inline
GraphicsCompareFunction kanzi::LegacyRenderPass::getStencilFunction ( ) const
inline

Gets the value of StencilFunctionProperty.

See also
setStencilFunction()
void kanzi::LegacyRenderPass::setStencilFunction ( GraphicsCompareFunction  value)
inline

Sets the value of StencilFunctionProperty.

See also
getStencilFunction()
int kanzi::LegacyRenderPass::getStencilFunctionReferenceValue ( ) const
inline
void kanzi::LegacyRenderPass::setStencilFunctionReferenceValue ( int  value)
inline
int kanzi::LegacyRenderPass::getStencilFunctionReferenceMask ( ) const
inline
void kanzi::LegacyRenderPass::setStencilFunctionReferenceMask ( int  value)
inline
bool kanzi::LegacyRenderPass::isStencilBufferTestEnabled ( ) const
inline
void kanzi::LegacyRenderPass::setStencilBufferTestEnabled ( bool  value)
inline
bool kanzi::LegacyRenderPass::isRenderPassScissorEnabled ( ) const
inline
void kanzi::LegacyRenderPass::setRenderPassScissorEnabled ( bool  value)
inline
float kanzi::LegacyRenderPass::getRenderPassScissorX ( ) const
inline
void kanzi::LegacyRenderPass::setRenderPassScissorX ( float  value)
inline
float kanzi::LegacyRenderPass::getRenderPassScissorY ( ) const
inline
void kanzi::LegacyRenderPass::setRenderPassScissorY ( float  value)
inline
float kanzi::LegacyRenderPass::getRenderPassScissorWidth ( ) const
inline
void kanzi::LegacyRenderPass::setRenderPassScissorWidth ( float  value)
inline
float kanzi::LegacyRenderPass::getRenderPassScissorHeight ( ) const
inline
void kanzi::LegacyRenderPass::setRenderPassScissorHeight ( float  value)
inline
KzuViewportCoordinateType kanzi::LegacyRenderPass::getRenderPassScissorType ( ) const
inline
void kanzi::LegacyRenderPass::setRenderPassScissorType ( KzuViewportCoordinateType  value)
inline
bool kanzi::LegacyRenderPass::isComposerEnabled ( ) const
inline

Gets the value of ComposerEnabledProperty.

See also
setComposerEnabled()
void kanzi::LegacyRenderPass::setComposerEnabled ( bool  value)
inline

Sets the value of ComposerEnabledProperty.

See also
isComposerEnabled()
static PropertyTypeEditorInfoSharedPtr kanzi::LegacyRenderPass::makeEditorInfo ( )
static
static LegacyRenderPassSharedPtr kanzi::LegacyRenderPass::create ( Domain domain,
string_view  name 
)
static

Create a render pass.

Parameters
domainDomain to use.
nameRender pass name.
Returns
Newly created render pass.

Member Data Documentation

PropertyType<bool> kanzi::LegacyRenderPass::FlushAfterRenderProperty
static

FlushAfterRender property.

The default value is false.

See also
setFlushAfterRender(), isFlushAfterRender()
PropertyType<ResourceSharedPtr> kanzi::LegacyRenderPass::RenderPassRenderTargetColor0Property
static

RenderPassRenderTargetColor0 property.

The default value is ResourceSharedPtr().

See also
setRenderPassRenderTargetColor0(), getRenderPassRenderTargetColor0()
PropertyType<ResourceSharedPtr> kanzi::LegacyRenderPass::RenderPassRenderTargetColor1Property
static

RenderPassRenderTargetColor1 property.

The default value is ResourceSharedPtr().

See also
setRenderPassRenderTargetColor1(), getRenderPassRenderTargetColor1()
PropertyType<ResourceSharedPtr> kanzi::LegacyRenderPass::RenderPassRenderTargetColor2Property
static

RenderPassRenderTargetColor2 property.

The default value is ResourceSharedPtr().

See also
setRenderPassRenderTargetColor2(), getRenderPassRenderTargetColor2()
PropertyType<ResourceSharedPtr> kanzi::LegacyRenderPass::RenderPassRenderTargetColor3Property
static

RenderPassRenderTargetColor3 property.

The default value is ResourceSharedPtr().

See also
setRenderPassRenderTargetColor3(), getRenderPassRenderTargetColor3()
PropertyType<ResourceSharedPtr> kanzi::LegacyRenderPass::RenderPassRenderTargetDepthStencilProperty
static

RenderPassRenderTargetDepthStencil property.

The default value is ResourceSharedPtr().

See also
setRenderPassRenderTargetDepthStencil(), getRenderPassRenderTargetDepthStencil()
PropertyType<float> kanzi::LegacyRenderPass::ViewportXProperty
static

ViewportX property.

The default value is 0.0f.

See also
setViewportX(), getViewportX()
PropertyType<float> kanzi::LegacyRenderPass::ViewportYProperty
static

ViewportY property.

The default value is 0.0f.

See also
setViewportY(), getViewportY()
PropertyType<float> kanzi::LegacyRenderPass::ViewportWidthProperty
static

ViewportWidth property.

The default value is 1.0f.

See also
setViewportWidth(), getViewportWidth()
PropertyType<float> kanzi::LegacyRenderPass::ViewportHeightProperty
static

ViewportHeight property.

The default value is 1.0f.

See also
setViewportHeight(), getViewportHeight()
PropertyType<KzuViewportCoordinateType> kanzi::LegacyRenderPass::ViewportTypeProperty
static

ViewportType property.

The default value is KZU_VIEWPORT_COORDINATE_RELATIVE.

See also
setViewportType(), getViewportType()
PropertyType<string> kanzi::LegacyRenderPass::RenderPassCameraProperty
static

RenderPassCamera property.

The default value is "".

See also
setRenderPassCamera(), getRenderPassCamera()
PropertyType<ResourceSharedPtr> kanzi::LegacyRenderPass::RenderPassObjectSourceProperty
static

RenderPassObjectSource property.

The default value is ResourceSharedPtr().

See also
setRenderPassObjectSource(), getRenderPassObjectSource()
PropertyType<ResourceSharedPtr> kanzi::LegacyRenderPass::RenderPassMaterialProperty
static

RenderPassMaterial property.

The default value is ResourceSharedPtr().

See also
setRenderPassMaterial(), getRenderPassMaterial()
PropertyType<int> kanzi::LegacyRenderPass::RenderPassRenderTargetMipmapLevelProperty
static

RenderPassRenderTargetMipmapLevel property.

The default value is 0.

See also
setRenderPassRenderTargetMipmapLevel(), getRenderPassRenderTargetMipmapLevel()
PropertyType<bool> kanzi::LegacyRenderPass::RenderPassRenderTargetResolveProperty
static

RenderPassRenderTargetResolve property.

The default value is false.

See also
setRenderPassRenderTargetResolve(), isRenderPassRenderTargetResolve()
PropertyType<LegacyRenderPass::InvalidateAttachments> kanzi::LegacyRenderPass::RenderPassRenderTargetInvalidateAttachmentsProperty
static
PropertyType<bool> kanzi::LegacyRenderPass::RenderPassRenderTargetGenerateMipmapProperty
static

RenderPassRenderTargetGenerateMipmap property.

The default value is false.

See also
setRenderPassRenderTargetGenerateMipmap(), isRenderPassRenderTargetGenerateMipmap()
PropertyType<bool> kanzi::LegacyRenderPass::FrustumCullingOnProperty
static

FrustumCullingOn property.

The default value is false.

See also
setFrustumCullingOn(), isFrustumCullingOn()
PropertyType<GraphicsCullMode> kanzi::LegacyRenderPass::CullModeProperty
static

CullMode property.

The default value is GraphicsCullModeBack.

See also
setCullMode(), getCullMode()
PropertyType<bool> kanzi::LegacyRenderPass::RenderOnceProperty
static

RenderOnce property.

The default value is false.

See also
setRenderOnce(), isRenderOnce()
PropertyType<Vector4> kanzi::LegacyRenderPass::Color0IntegerClearValueProperty
static

Color0IntegerClearValue property.

The default value is Vector4(0.0f, 0.0f, 0.0f, 0.0f).

See also
setColor0IntegerClearValue(), getColor0IntegerClearValue()
PropertyType<Vector4> kanzi::LegacyRenderPass::Color0FloatClearValueProperty
static

Color0FloatClearValue property.

The default value is Vector4(0.0f, 0.0f, 0.0f, 0.0f).

See also
setColor0FloatClearValue(), getColor0FloatClearValue()
PropertyType<Vector4> kanzi::LegacyRenderPass::Color1IntegerClearValueProperty
static

Color1IntegerClearValue property.

The default value is Vector4(0.0f, 0.0f, 0.0f, 0.0f).

See also
setColor1IntegerClearValue(), getColor1IntegerClearValue()
PropertyType<Vector4> kanzi::LegacyRenderPass::Color1FloatClearValueProperty
static

Color1FloatClearValue property.

The default value is Vector4(0.0f, 0.0f, 0.0f, 0.0f).

See also
setColor1FloatClearValue(), getColor1FloatClearValue()
PropertyType<Vector4> kanzi::LegacyRenderPass::Color2IntegerClearValueProperty
static

Color2IntegerClearValue property.

The default value is Vector4(0.0f, 0.0f, 0.0f, 0.0f).

See also
setColor2IntegerClearValue(), getColor2IntegerClearValue()
PropertyType<Vector4> kanzi::LegacyRenderPass::Color2FloatClearValueProperty
static

Color2FloatClearValue property.

The default value is Vector4(0.0f, 0.0f, 0.0f, 0.0f).

See also
setColor2FloatClearValue(), getColor2FloatClearValue()
PropertyType<Vector4> kanzi::LegacyRenderPass::Color3IntegerClearValueProperty
static

Color3IntegerClearValue property.

The default value is Vector4(0.0f, 0.0f, 0.0f, 0.0f).

See also
setColor3IntegerClearValue(), getColor3IntegerClearValue()
PropertyType<Vector4> kanzi::LegacyRenderPass::Color3FloatClearValueProperty
static

Color3FloatClearValue property.

The default value is Vector4(0.0f, 0.0f, 0.0f, 0.0f).

See also
setColor3FloatClearValue(), getColor3FloatClearValue()
PropertyType<ColorRGBA> kanzi::LegacyRenderPass::ColorBufferClearColorProperty
static

ColorBufferClearColor property.

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

See also
setColorBufferClearColor(), getColorBufferClearColor()
PropertyType<bool> kanzi::LegacyRenderPass::ColorBufferClearEnabledProperty
static

ColorBufferClearEnabled property.

The default value is false.

See also
setColorBufferClearEnabled(), isColorBufferClearEnabled()
PropertyType<ColorRGBA> kanzi::LegacyRenderPass::Color1ColorClearValueProperty
static

Color1ColorClearValue property.

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

See also
setColor1ColorClearValue(), getColor1ColorClearValue()
PropertyType<ColorRGBA> kanzi::LegacyRenderPass::Color2ColorClearValueProperty
static

Color2ColorClearValue property.

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

See also
setColor2ColorClearValue(), getColor2ColorClearValue()
PropertyType<ColorRGBA> kanzi::LegacyRenderPass::Color3ColorClearValueProperty
static

Color3ColorClearValue property.

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

See also
setColor3ColorClearValue(), getColor3ColorClearValue()
PropertyType<GraphicsColorWriteMode> kanzi::LegacyRenderPass::ColorWriteModeProperty
static

ColorWriteMode property.

The default value is GraphicsColorWriteModeRGBA.

See also
setColorWriteMode(), getColorWriteMode()
PropertyType<bool> kanzi::LegacyRenderPass::DepthBufferClearEnabledProperty
static

DepthBufferClearEnabled property.

The default value is true.

See also
setDepthBufferClearEnabled(), isDepthBufferClearEnabled()
PropertyType<float> kanzi::LegacyRenderPass::DepthBufferClearValueProperty
static

DepthBufferClearValue property.

The default value is 1.0f.

See also
setDepthBufferClearValue(), getDepthBufferClearValue()
PropertyType<bool> kanzi::LegacyRenderPass::DepthBufferTestEnabledProperty
static

DepthBufferTestEnabled property.

The default value is true.

See also
setDepthBufferTestEnabled(), isDepthBufferTestEnabled()
PropertyType<bool> kanzi::LegacyRenderPass::DepthBufferWriteEnabledProperty
static

DepthBufferWriteEnabled property.

The default value is true.

See also
setDepthBufferWriteEnabled(), isDepthBufferWriteEnabled()
PropertyType<bool> kanzi::LegacyRenderPass::StencilBufferClearEnabledProperty
static

StencilBufferClearEnabled property.

The default value is false.

See also
setStencilBufferClearEnabled(), isStencilBufferClearEnabled()
PropertyType<int> kanzi::LegacyRenderPass::StencilBufferClearValueProperty
static

StencilBufferClearValue property.

The default value is 0.

See also
setStencilBufferClearValue(), getStencilBufferClearValue()
PropertyType<GraphicsStencilOperation> kanzi::LegacyRenderPass::StencilFailOperationProperty
static

StencilFailOperation property.

The default value is GraphicsStencilOperationKeep.

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

StencilPassDepthFailOperation property.

The default value is GraphicsStencilOperationKeep.

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

StencilPassDepthPassOperation property.

The default value is GraphicsStencilOperationKeep.

See also
setStencilPassDepthPassOperation(), getStencilPassDepthPassOperation()
PropertyType<GraphicsCompareFunction> kanzi::LegacyRenderPass::StencilFunctionProperty
static

StencilFunction property.

The default value is GraphicsCompareFunctionNever.

See also
setStencilFunction(), getStencilFunction()
PropertyType<int> kanzi::LegacyRenderPass::StencilFunctionReferenceValueProperty
static

StencilFunctionReferenceValue property.

The default value is 0.

See also
setStencilFunctionReferenceValue(), getStencilFunctionReferenceValue()
PropertyType<int> kanzi::LegacyRenderPass::StencilFunctionReferenceMaskProperty
static

StencilFunctionReferenceMask property.

The default value is 255.

See also
setStencilFunctionReferenceMask(), getStencilFunctionReferenceMask()
PropertyType<bool> kanzi::LegacyRenderPass::StencilBufferTestEnabledProperty
static

StencilBufferTestEnabled property.

The default value is false.

See also
setStencilBufferTestEnabled(), isStencilBufferTestEnabled()
PropertyType<bool> kanzi::LegacyRenderPass::RenderPassScissorEnabledProperty
static

RenderPassScissorEnabled property.

The default value is false.

See also
setRenderPassScissorEnabled(), isRenderPassScissorEnabled()
PropertyType<float> kanzi::LegacyRenderPass::RenderPassScissorXProperty
static

RenderPassScissorX property.

The default value is 0.0f.

See also
setRenderPassScissorX(), getRenderPassScissorX()
PropertyType<float> kanzi::LegacyRenderPass::RenderPassScissorYProperty
static

RenderPassScissorY property.

The default value is 0.0f.

See also
setRenderPassScissorY(), getRenderPassScissorY()
PropertyType<float> kanzi::LegacyRenderPass::RenderPassScissorWidthProperty
static

RenderPassScissorWidth property.

The default value is 1.0f.

See also
setRenderPassScissorWidth(), getRenderPassScissorWidth()
PropertyType<float> kanzi::LegacyRenderPass::RenderPassScissorHeightProperty
static

RenderPassScissorHeight property.

The default value is 1.0f.

See also
setRenderPassScissorHeight(), getRenderPassScissorHeight()
PropertyType<KzuViewportCoordinateType> kanzi::LegacyRenderPass::RenderPassScissorTypeProperty
static

RenderPassScissorType property.

The default value is KZU_VIEWPORT_COORDINATE_RELATIVE.

See also
setRenderPassScissorType(), getRenderPassScissorType()
PropertyType<bool> kanzi::LegacyRenderPass::ComposerEnabledProperty
static

ComposerEnabled property.

The default value is true.

See also
setComposerEnabled(), isComposerEnabled()

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