Kanzi  3.9.7
Kanzi Engine API
kanzi::MaskEffect2D Class Reference

Use MaskEffect2D to apply a mask to 2D nodes. More...

#include <kanzi/core.ui/effect/mask_effect2d.hpp>

Inheritance diagram for kanzi::MaskEffect2D:
[legend]

Public Types

enum  Channel {
  Channel::Alpha, Channel::Red, Channel::Green, Channel::Blue,
  Channel::Luminance
}
 Defines the mask texture channels that you can use as the mask. More...
 
enum  HorizontalAlignment {
  HorizontalAlignment::Left, HorizontalAlignment::Right, HorizontalAlignment::Center, HorizontalAlignment::Stretch,
  HorizontalAlignment::Count
}
 Defines the horizontal alignment modes. More...
 
enum  Stretch {
  Stretch::None, Stretch::Fill, Stretch::Uniform, Stretch::UniformToFill,
  Stretch::Repeat, Stretch::Count
}
 Defines the stretch modes. More...
 
enum  VerticalAlignment {
  VerticalAlignment::Bottom, VerticalAlignment::Top, VerticalAlignment::Center, VerticalAlignment::Stretch,
  VerticalAlignment::Count
}
 Defines the vertical alignment modes. 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 Member Functions

Channel getChannel () const
 Gets the value of ChannelProperty. More...
 
float getHeight () const
 Gets the value of HeightProperty. More...
 
HorizontalAlignment getHorizontalAlignment () const
 Gets the value of HorizontalAlignmentProperty. More...
 
bool getInvert () const
 Gets the value of InvertProperty. More...
 
TextureSharedPtr getMask () const
 Gets the value of MaskProperty. More...
 
Vector2 getOffset () const
 Gets the value of OffsetProperty. More...
 
Vector2 getScale () const
 Gets the value of ScaleProperty. More...
 
bool getScreenSpace () const
 Gets the value of ScreenSpaceProperty. More...
 
float getStrength () const
 Gets the value of StrengthProperty. More...
 
Stretch getStretch () const
 Gets the value of StretchProperty. More...
 
VerticalAlignment getVerticalAlignment () const
 Gets the value of VerticalAlignmentProperty. More...
 
float getWidth () const
 Gets the value of WidthProperty. More...
 
void setChannel (Channel value)
 Sets the value of ChannelProperty. More...
 
void setHeight (float value)
 Sets the value of HeightProperty. More...
 
void setHorizontalAlignment (HorizontalAlignment value)
 Sets the value of HorizontalAlignmentProperty. More...
 
void setInvert (bool value)
 Sets the value of InvertProperty. More...
 
void setMask (TextureSharedPtr value)
 Sets the value of MaskProperty. More...
 
void setOffset (Vector2 value)
 Sets the value of OffsetProperty. More...
 
void setScale (Vector2 value)
 Sets the value of ScaleProperty. More...
 
void setScreenSpace (bool value)
 Sets the value of ScreenSpaceProperty. More...
 
void setStrength (float value)
 Sets the value of StrengthProperty. More...
 
void setStretch (Stretch value)
 Sets the value of StretchProperty. More...
 
void setVerticalAlignment (VerticalAlignment value)
 Sets the value of VerticalAlignmentProperty. More...
 
void setWidth (float value)
 Sets the value of WidthProperty. More...
 
- Public Member Functions inherited from kanzi::NodeEffect2D
NodeEffectRenderer2DUniquePtr createRenderer ()
 Creates a renderer instance. More...
 
unsigned int getEffectPaddingChangeCounter () const
 Gets the effect quad change counter. More...
 
Vector4 getEffectQuadPadding () const
 Gets the effect quad padding. More...
 
Vector2 getEffectQuadPaddingOffset () const
 Gets the effect quad offset relative relative to the top-left corner of the node. More...
 
Vector2 getEffectQuadPaddingSize () const
 Gets the effect quad padding size. More...
 
NodeEffectRenderer2DgetRendererInstance () const
 Gets a pointer to NodeEffectRenderer2D instance or null pointer if none exists. More...
 
bool isAlphaRequired () const
 Indicates whether the effect requires alpha channel for the result. More...
 
bool isRenderingRequired ()
 Indicates whether the effect requires rendering. More...
 
void unregisterEffectRenderer (NodeEffectRenderer2D *effectRenderer)
 Unregister effect renderer. More...
 
 ~NodeEffect2D ()
 
- 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 ()
 

Static Public Member Functions

static MaskEffect2DSharedPtr create (Domain *domain, string_view name)
 Creates a mask effect. 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...
 

Static Public Attributes

static PropertyType< ChannelChannelProperty
 Sets the mask texture channel to use as the input for the mask: More...
 
static PropertyType< float > HeightProperty
 Overrides the mask texture height in pixels. More...
 
static PropertyType< HorizontalAlignmentHorizontalAlignmentProperty
 Sets the horizontal alignment of the mask: More...
 
static PropertyType< bool > InvertProperty
 Indicates whether to invert the mask. More...
 
static PropertyType< ResourceSharedPtrMaskProperty
 Sets the mask texture. More...
 
static PropertyType< Vector2OffsetProperty
 Sets the mask offset along the X and Y axes in pixels. More...
 
static PropertyType< Vector2ScaleProperty
 Sets the factor by which to scale the mask. More...
 
static PropertyType< bool > ScreenSpaceProperty
 Indicates whether to layout the mask relative to the screen. More...
 
static PropertyType< float > StrengthProperty
 Sets the strength of the mask effect. More...
 
static PropertyType< StretchStretchProperty
 Sets the stretch mode of the mask: More...
 
static PropertyType< VerticalAlignmentVerticalAlignmentProperty
 Sets the vertical alignment of the mask: More...
 
static PropertyType< float > WidthProperty
 Overrides the mask texture width in pixels. More...
 

Protected Member Functions

NodeEffectRenderer2DUniquePtr createRendererOverride () override
 NodeEffect2D::createRendererOverride implementation. More...
 
void initializeRendererOverride () override
 NodeEffect2D::initializeRendererOverride implementation. More...
 
 MaskEffect2D (Domain *domain, string_view name)
 Constructor. More...
 
virtual void onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) override
 PropertyObject::onPropertyChanged implementation. More...
 
- Protected Member Functions inherited from kanzi::NodeEffect2D
virtual bool isRenderingRequiredOverride ()
 Implementation-dependent check on whether effect rendering is required. More...
 
 NodeEffect2D (Domain *domain, string_view name)
 Constructor. More...
 
void setAlphaRequired (bool required)
 Sets the framebuffer alpha channel requirements of the effect. More...
 
void setEffectQuadPadding (float left, float right, float top, float bottom)
 Sets the padding required by the effect around the node bounds during the rendering of the effect. 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...
 

Additional Inherited Members

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

Detailed Description

Use MaskEffect2D to apply a mask to 2D nodes.

Examples

To create a mask effect:

// Create an effect template for the MaskEffect2D effect prefab.
NodeEffectTemplate2DSharedPtr maskEffectTemplate =
// Create a node effect prefab from the effect template.
NodeEffectPrefab2DSharedPtr maskEffectPrefab =
NodeEffectPrefab2D::create(getDomain(), "MaskEffect prefab", maskEffectTemplate);

To set the mask effect properties:

// Create an effect template.
NodeEffectTemplate2DSharedPtr maskEffectTemplate =
// Set the value of the MaskProperty in the template.
// The MaskProperty defines the mask texture which you must set before you can use the mask effect.
TextureSharedPtr maskTexture = acquireMaskTexture(getDomain());
maskEffectTemplate->addPropertyValue(MaskEffect2D::MaskProperty, Variant(maskTexture));
// Create a mask effect prefab.
NodeEffectPrefab2DSharedPtr maskEffectPrefab =
NodeEffectPrefab2D::create(getDomain(), "MaskEffect prefab", maskEffectTemplate);
// Assign the mask effect to a 2D node.
node2d->setEffectPrefab(maskEffectPrefab);
// Get the node-specific effect instance created from the assigned prefab.
MaskEffect2DSharedPtr maskEffect = dynamic_pointer_cast<MaskEffect2D>(node2d->getEffect());
// Set the mask stretch mode to uniform.
maskEffect->setStretch(MaskEffect2D::Stretch::Uniform);
See also
NodeEffect2D, NodeEffectPrefab2D, NodeEffectTemplate2D, MaskEffectRenderer2D
Since
Kanzi 3.9.0

Member Enumeration Documentation

Defines the vertical alignment modes.

Enumerator
Bottom 

Aligns the bottom edge of the mask with the bottom edge of the node.

Top 

Aligns the top edge of the mask with the top edge of the node.

Center 

Centers the mask vertically in the node.

Stretch 

Stretches the mask vertically to fit the node from the top edge to the bottom edge.

Count 

The number of vertical alignment modes.

Defines the horizontal alignment modes.

Enumerator
Left 

Aligns the left edge of the mask with the left edge of the node.

Right 

Aligns the right edge of the mask with the right edge of the node.

Center 

Centers the mask horizontally in the node.

Stretch 

Stretches the mask horizontally to fit the node from the left edge to the right edge.

Count 

The number of horizontal alignment modes.

Defines the stretch modes.

Enumerator
None 

Does not stretch the mask.

Fill 

Stretches the mask to fill the node.

Uniform 

Stretches the mask using uniform scaling to fill the node in either vertical or horizontal direction, whichever requires smaller scale.

UniformToFill 

Stretches the mask using uniform scaling to fill the node in either vertical or horizontal direction, whichever requires larger scale.

Repeat 

Does not stretch the mask, and allows the mask to repeat outside of its area based on the mask texture wrap mode.

Count 

The number of stretch modes.

Defines the mask texture channels that you can use as the mask.

Enumerator
Alpha 

Uses the alpha channel as the mask.

Red 

Uses the red color channel as the mask.

Green 

Uses the green color channel as the mask.

Blue 

Uses the blue color channel as the mask.

Luminance 

Uses the luminance calculated from the red, green, and blue color channels as the mask.

Constructor & Destructor Documentation

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

Constructor.

Parameters
domainDomain to use.
nameResource name.

Member Function Documentation

TextureSharedPtr kanzi::MaskEffect2D::getMask ( ) const
inline

Gets the value of MaskProperty.

See also
setMask()
void kanzi::MaskEffect2D::setMask ( TextureSharedPtr  value)
inline

Sets the value of MaskProperty.

See also
getMask()
float kanzi::MaskEffect2D::getHeight ( ) const
inline

Gets the value of HeightProperty.

See also
setHeight()
void kanzi::MaskEffect2D::setHeight ( float  value)
inline

Sets the value of HeightProperty.

See also
getHeight()
float kanzi::MaskEffect2D::getWidth ( ) const
inline

Gets the value of WidthProperty.

See also
setWidth()
void kanzi::MaskEffect2D::setWidth ( float  value)
inline

Sets the value of WidthProperty.

See also
getWidth()
Vector2 kanzi::MaskEffect2D::getOffset ( ) const
inline

Gets the value of OffsetProperty.

See also
setOffset()
void kanzi::MaskEffect2D::setOffset ( Vector2  value)
inline

Sets the value of OffsetProperty.

See also
getOffset()
Vector2 kanzi::MaskEffect2D::getScale ( ) const
inline

Gets the value of ScaleProperty.

See also
setScale()
void kanzi::MaskEffect2D::setScale ( Vector2  value)
inline

Sets the value of ScaleProperty.

See also
getScale()
Stretch kanzi::MaskEffect2D::getStretch ( ) const
inline

Gets the value of StretchProperty.

See also
setStretch()
void kanzi::MaskEffect2D::setStretch ( Stretch  value)
inline

Sets the value of StretchProperty.

See also
getStretch()
VerticalAlignment kanzi::MaskEffect2D::getVerticalAlignment ( ) const
inline
void kanzi::MaskEffect2D::setVerticalAlignment ( VerticalAlignment  value)
inline
HorizontalAlignment kanzi::MaskEffect2D::getHorizontalAlignment ( ) const
inline
void kanzi::MaskEffect2D::setHorizontalAlignment ( HorizontalAlignment  value)
inline
bool kanzi::MaskEffect2D::getScreenSpace ( ) const
inline

Gets the value of ScreenSpaceProperty.

See also
setScreenSpace()
void kanzi::MaskEffect2D::setScreenSpace ( bool  value)
inline

Sets the value of ScreenSpaceProperty.

See also
getScreenSpace()
Channel kanzi::MaskEffect2D::getChannel ( ) const
inline

Gets the value of ChannelProperty.

See also
setChannel()
void kanzi::MaskEffect2D::setChannel ( Channel  value)
inline

Sets the value of ChannelProperty.

See also
getChannel()
bool kanzi::MaskEffect2D::getInvert ( ) const
inline

Gets the value of InvertProperty.

See also
setInvert()
void kanzi::MaskEffect2D::setInvert ( bool  value)
inline

Sets the value of InvertProperty.

See also
getInvert()
float kanzi::MaskEffect2D::getStrength ( ) const
inline

Gets the value of StrengthProperty.

See also
setStrength()
void kanzi::MaskEffect2D::setStrength ( float  value)
inline

Sets the value of StrengthProperty.

See also
getStrength()
static PropertyTypeEditorInfoSharedPtr kanzi::MaskEffect2D::makeEditorInfo ( )
static
static MaskEffect2DSharedPtr kanzi::MaskEffect2D::create ( Domain domain,
string_view  name 
)
static

Creates a mask effect.

Parameters
domainDomain to use.
nameResource name.
NodeEffectRenderer2DUniquePtr kanzi::MaskEffect2D::createRendererOverride ( )
overrideprotectedvirtual
void kanzi::MaskEffect2D::initializeRendererOverride ( )
overrideprotectedvirtual
virtual void kanzi::MaskEffect2D::onPropertyChanged ( AbstractPropertyType  propertyType,
PropertyNotificationReason  reason 
)
overrideprotectedvirtual

PropertyObject::onPropertyChanged implementation.

Reimplemented from kanzi::PropertyObject.

Member Data Documentation

PropertyType<ResourceSharedPtr> kanzi::MaskEffect2D::MaskProperty
static

Sets the mask texture.

The default value is no texture.

See also
setMask(), getMask()
PropertyType<float> kanzi::MaskEffect2D::HeightProperty
static

Overrides the mask texture height in pixels.

See also
setHeight(), getHeight()
PropertyType<float> kanzi::MaskEffect2D::WidthProperty
static

Overrides the mask texture width in pixels.

See also
setWidth(), getWidth()
PropertyType<Vector2> kanzi::MaskEffect2D::OffsetProperty
static

Sets the mask offset along the X and Y axes in pixels.

Kanzi applies the mask offset after stretch, alignment, and scale. The default value is Vector2(0, 0).

See also
setOffset(), getOffset()
PropertyType<Vector2> kanzi::MaskEffect2D::ScaleProperty
static

Sets the factor by which to scale the mask.

Kanzi applies the scale after stretch and alignment. The default value is Vector2(1, 1).

See also
setScale(), getScale()
PropertyType<Stretch> kanzi::MaskEffect2D::StretchProperty
static

Sets the stretch mode of the mask:

  • None disables stretching. This is the default.
  • Fill stretches the mask to fill the node.
  • Uniform stretches the mask using uniform scaling to fill the node in either vertical or horizontal direction, whichever requires smaller scale.
  • UniformToFill stretches the mask using uniform scaling to fill the node in either vertical or horizontal direction, whichever requires larger scale.
See also
setStretch(), getStretch()
PropertyType<VerticalAlignment> kanzi::MaskEffect2D::VerticalAlignmentProperty
static

Sets the vertical alignment of the mask:

  • Top aligns the top edge of the mask with the top edge of the node. This is the default.
  • Bottom aligns the bottom edge of the mask with the bottom edge of the node.
  • Center aligns the mask vertically to the center of the node.
  • Stretch stretches the mask vertically to fit the node from the top edge to the bottom edge.
See also
setVerticalAlignment(), getVerticalAlignment()
PropertyType<HorizontalAlignment> kanzi::MaskEffect2D::HorizontalAlignmentProperty
static

Sets the horizontal alignment of the mask:

  • Left aligns the left edge of the mask with the left edge of the node. This is the default.
  • Right aligns the right edge of the mask with the right edge of the node.
  • Center aligns the mask horizontally to the center of the node.
  • Stretch stretches the mask horizontally to fit the node from the left edge to the right edge.
See also
setHorizontalAlignment(), getHorizontalAlignment()
PropertyType<bool> kanzi::MaskEffect2D::ScreenSpaceProperty
static

Indicates whether to layout the mask relative to the screen.

See also
setScreenSpace(), getScreenSpace()
PropertyType<Channel> kanzi::MaskEffect2D::ChannelProperty
static

Sets the mask texture channel to use as the input for the mask:

  • Alpha uses the alpha channel from the texture. This is the default.
  • Red uses the red color channel from the texture.
  • Green uses the green color channel from the texture.
  • Blue uses the blue color channel from the texture.
  • Luminance uses the luminance value calculated from the red, green, and blue color channels.
See also
setChannel(), getChannel()
PropertyType<bool> kanzi::MaskEffect2D::InvertProperty
static

Indicates whether to invert the mask.

The default value is false.

See also
setInvert(), getInvert()
PropertyType<float> kanzi::MaskEffect2D::StrengthProperty
static

Sets the strength of the mask effect.

The range of the property is from 0 to 1 such that:

  • 0 disables the mask effect.
  • 1 applies the mask effect at full strength. This is the default.
  • Any other value between 0 and 1 partially applies the mask as if the non-masked result was blended with the fully masked version.
See also
setStrength(), getStrength()

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