DisplacementMapFilter

Scaleform::Render::Filter
    Scaleform::Render::DisplacementMapFilter

Declaration

class DisplacementMapFilter : public Filter;

Description

Represents a displacement map filter.

Data Members

Data Member	Description
ColorValue	The value to use if DisplacementMode_Color is used (alpha channel contains 'alpha' component).
ComponentX	The channel to use for the X displacement.
ComponentY	The channel to use for the Y displacement.
DisplacementMap	The image defining the displacement.
MapPoint	The offset into the displacement image.
Mode	The mode of displacement, when the coordinates are out-of-bounds.
ScaleX	The scaling to apply to the displacement map function.
ScaleY	The scaling to apply to the displacement map function.

Enumerations

Enumeration	Description
DisplacementMode	The mode of displacement.

Methods

Method	Description
CanCacheAcrossTransform	Determines whether filters may be able to cache across transformations.
Clone	Creates a new, un-frozen copy of the filter.
DisplacementMapFilter	DisplacementMapFilter constructor.
IsContributing	Checks if filters are enabled even though they do not produce any visible effect.

File

Render_Filters.h