Inkscape::Filters::FilterBlend Class Reference

#include <nr-filter-blend.h>

Inheritance diagram for Inkscape::Filters::FilterBlend:

Public Member Functions
	FilterBlend ()
	~FilterBlend () override
void	render_cairo (FilterSlot &slot) const override
bool	can_handle_affine (Geom::Affine const &) const override
	Indicate whether the filter primitive can handle the given affine.
double	complexity (Geom::Affine const &ctm) const override
bool	uses_background () const override
void	set_input (int slot) override
	Sets the input slot number 'slot' to be used as input in rendering filter primitive 'primitive' For filter primitive types accepting more than one input, this sets the first input.
void	set_input (int input, int slot) override
	Sets the input slot number 'slot' to be user as input number 'input' in rendering filter primitive 'primitive' First input for a filter primitive is number 0.
void	set_mode (SPBlendMode mode)
Glib::ustring	name () const override
Public Member Functions inherited from Inkscape::Filters::FilterPrimitive
	FilterPrimitive ()
virtual	~FilterPrimitive ()
virtual void	update ()
virtual void	area_enlarge (Geom::IntRect &area, Geom::Affine const &m) const
virtual void	set_output (int slot)
	Sets the slot number 'slot' to be used as output from filter primitive 'primitive' If output slot for a filter element is not set, one of the unused image slots is used.
void	set_x (SVGLength const &length)
	Sets the filter primitive subregion.
void	set_y (SVGLength const &length)
void	set_width (SVGLength const &length)
void	set_height (SVGLength const &length)
void	set_subregion (SVGLength const &x, SVGLength const &y, SVGLength const &width, SVGLength const &height)
Geom::Rect	filter_primitive_area (FilterUnits const &units) const
	Returns the filter primitive area in user coordinate system.
void	setStyle (SPStyle const *style)
	Sets style for access to properties used by filter primitives.

Private Attributes
SPBlendMode	_blend_mode
int	_input2

Static Private Attributes
static const std::set< SPBlendMode >	_valid_modes

Additional Inherited Members
Protected Attributes inherited from Inkscape::Filters::FilterPrimitive
int	_input
int	_output
SVGLength	_subregion_x
SVGLength	_subregion_y
SVGLength	_subregion_width
SVGLength	_subregion_height
SPColorInterpolation	color_interpolation

Detailed Description

Definition at line 27 of file nr-filter-blend.h.

Constructor & Destructor Documentation

FilterBlend()

Inkscape::Filters::FilterBlend::FilterBlend

(

)

Definition at line 44 of file nr-filter-blend.cpp.

~FilterBlend()

Inkscape::Filters::FilterBlend::~FilterBlend ( )

overridedefault

Member Function Documentation

can_handle_affine()

bool Inkscape::Filters::FilterBlend::can_handle_affine ( Geom::Affine const &  ) const

overridevirtual

Indicate whether the filter primitive can handle the given affine.

Results of some filter primitives depend on the coordinate system used when rendering. A gaussian blur with equal x and y deviation will remain unchanged by rotations. Per-pixel filters like color matrix and blend will not change regardless of the transformation.

When any filter returns false, filter rendering is performed on an intermediate surface with edges parallel to the axes of the user coordinate system. This means the matrices from FilterUnits will contain at most a (possibly non-uniform) scale and a translation. When all primitives of the filter return true, the rendering is performed in display coordinate space and no intermediate surface is used.

Reimplemented from Inkscape::Filters::FilterPrimitive.

Definition at line 125 of file nr-filter-blend.cpp.

complexity()

double Inkscape::Filters::FilterBlend::complexity ( Geom::Affine const &  ctm ) const

overridevirtual

Reimplemented from Inkscape::Filters::FilterPrimitive.

Definition at line 131 of file nr-filter-blend.cpp.

name()

Glib::ustring Inkscape::Filters::FilterBlend::name ( ) const

inlineoverridevirtual

Reimplemented from Inkscape::Filters::FilterPrimitive.

Definition at line 42 of file nr-filter-blend.h.

render_cairo()

void Inkscape::Filters::FilterBlend::render_cairo ( FilterSlot &  slot ) const

overridevirtual

Reimplemented from Inkscape::Filters::FilterPrimitive.

Definition at line 93 of file nr-filter-blend.cpp.

References _blend_mode, Inkscape::Filters::FilterPrimitive::_input, _input2, Inkscape::Filters::FilterPrimitive::_output, Inkscape::Filters::FilterPrimitive::color_interpolation, Inkscape::Filters::get_cairo_op(), Inkscape::Filters::FilterSlot::getcairo(), ink_cairo_surface_blit(), ink_cairo_surface_create_output(), Inkscape::Filters::FilterSlot::set(), and set_cairo_surface_ci().

set_input() [1/2]

void Inkscape::Filters::FilterBlend::set_input ( int  input, int  slot  )

overridevirtual

Sets the input slot number 'slot' to be user as input number 'input' in rendering filter primitive 'primitive' First input for a filter primitive is number 0.

For primitives with attributes 'in' and 'in2', these are numbered 0 and 1, respectively. If any of required input slots for a filter is not set, the output of previous filter primitive is used, or SourceGraphic if this is the first filter primitive for this filter.

Reimplemented from Inkscape::Filters::FilterPrimitive.

Definition at line 147 of file nr-filter-blend.cpp.

References Inkscape::Filters::FilterPrimitive::_input, and _input2.

set_input() [2/2]

void Inkscape::Filters::FilterBlend::set_input ( int  slot )

overridevirtual

Sets the input slot number 'slot' to be used as input in rendering filter primitive 'primitive' For filter primitive types accepting more than one input, this sets the first input.

If any of the required input slots is not set, the output of previous filter primitive is used, or SourceGraphic if this is the first primitive for this filter.

Reimplemented from Inkscape::Filters::FilterPrimitive.

Definition at line 142 of file nr-filter-blend.cpp.

References Inkscape::Filters::FilterPrimitive::_input.

set_mode()

void Inkscape::Filters::FilterBlend::set_mode

(

SPBlendMode

mode

)

Definition at line 153 of file nr-filter-blend.cpp.

References _blend_mode, _valid_modes, and mode.

uses_background()

bool Inkscape::Filters::FilterBlend::uses_background ( ) const

overridevirtual

Reimplemented from Inkscape::Filters::FilterPrimitive.

Definition at line 136 of file nr-filter-blend.cpp.

References Inkscape::Filters::FilterPrimitive::_input, _input2, Inkscape::Filters::NR_FILTER_BACKGROUNDALPHA, and Inkscape::Filters::NR_FILTER_BACKGROUNDIMAGE.

Member Data Documentation

_blend_mode

SPBlendMode Inkscape::Filters::FilterBlend::_blend_mode

private

Definition at line 46 of file nr-filter-blend.h.

Referenced by render_cairo(), and set_mode().

_input2

int Inkscape::Filters::FilterBlend::_input2

private

Definition at line 47 of file nr-filter-blend.h.

Referenced by render_cairo(), set_input(), and uses_background().

_valid_modes

std::set< SPBlendMode > const Inkscape::Filters::FilterBlend::_valid_modes

staticprivate

Initial value:

{
    
    SP_CSS_BLEND_NORMAL,      SP_CSS_BLEND_MULTIPLY,
    SP_CSS_BLEND_SCREEN,      SP_CSS_BLEND_DARKEN,
    SP_CSS_BLEND_LIGHTEN,     SP_CSS_BLEND_OVERLAY,
    SP_CSS_BLEND_COLORDODGE,  SP_CSS_BLEND_COLORBURN,
    SP_CSS_BLEND_HARDLIGHT,   SP_CSS_BLEND_SOFTLIGHT,
    SP_CSS_BLEND_DIFFERENCE,  SP_CSS_BLEND_EXCLUSION,
    SP_CSS_BLEND_HUE,         SP_CSS_BLEND_SATURATION,
    SP_CSS_BLEND_COLOR,       SP_CSS_BLEND_LUMINOSITY
    
        }

Definition at line 45 of file nr-filter-blend.h.

Referenced by set_mode().

---

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

• /builds/inkscape/inkscape/src/display/nr-filter-blend.h
• /builds/inkscape/inkscape/src/display/nr-filter-blend.cpp