FilterSet

Scaleform::Render::FilterSet

Declaration

class FilterSet : public RefCountBase<FilterSet, Stat_Default_Mem>;

Description

FilterSet describes an array of filters that can be stored within a FilterState. Filters within a FilterSet can be modified, added and/or removed until the FilterSet is frozen, at which point is becomes read-only for thread safety reasons.

Methods

Method	Description
AddFilter	Adds a filter to the render tree node.
CanCacheAcrossTransform	Determines whether the filter can cache itself across translation.
Clone	Clones a filter set. If deepcopy == true, individual filters are also cloned.
FilterSet	FilterSet constructor.
Freeze	Freezes the filter so that it can no longer be modified.
GetCacheAsBitmap	Gets whether the FilterSet has cacheAsBitmap enabled.
GetFilter	Returns the filter from the filter array set on the render tree node.
GetFilterCount	Returns the number of filters set for the render tree.
GetFilters	Returns the array of filters.
InsertFilterAt	Inserts the filter at the specified place in the filter array.
IsContributing	Returns true if any filter within the set contributes.
IsFrozen	Determine if the filter was frozen for thread safety reasons.
RemoveFilter	Removes all copies of the filter from the set.
RemoveFilterAt	Removes the filter from the specified position in the filter array.
SetCacheAsBitmap	Sets whether the FilterSet has cacheAsBitmap enabled.
SetFilter	Sets the filter in the filter array.

File

Render_Filters.h