Build from Filter.h

＋Krita 4.0.0

Filter: represents a filter and its configuration. A filter is identified by an internal name. The configuration for each filter is defined as an InfoObject: a map of name and value pairs.

Currently available filters are:

'autocontrast', 'blur', 'bottom edge detections', 'brightnesscontrast', 'burn', 'colorbalance', 'colortoalpha', 'colortransfer', 'desaturate', 'dodge', 'emboss', 'emboss all directions', 'emboss horizontal and vertical', 'emboss horizontal only', 'emboss laplascian', 'emboss vertical only', 'gaussian blur', 'gaussiannoisereducer', 'gradientmap', 'halftone', 'hsvadjustment', 'indexcolors', 'invert', 'left edge detections', 'lens blur', 'levels', 'maximize', 'mean removal', 'minimize', 'motion blur', 'noise', 'normalize', 'oilpaint', 'perchannel', 'phongbumpmap', 'pixelize', 'posterize', 'raindrops', 'randompick', 'right edge detections', 'roundcorners', 'sharpen', 'smalltiles', 'sobel', 'threshold', 'top edge detections', 'unsharp', 'wave', 'waveletnoisereducer']

Methods

apply(node: Node, x: int, y: int, w: int, h: int) ➞ bool configuration() ➞ InfoObject name() ➞ str setConfiguration(value: InfoObject) setName(name: str) startFilter(node: Node, x: int, y: int, w: int, h: int) ➞ bool

Member documentation

apply(node: Node, x: int, y: int, w: int, h: int) ➞ bool

＋Krita 4.0.0↻Krita 4.2.0

Apply the filter to the given node.

Parameters

node	the node to apply the filter to
x	(no description provided)
y	(no description provided)
w	(no description provided)
h	describe the rectangle the filter should be apply. This is always in image pixel coordinates and not relative to the x, y of the node.

Return

true if the filter was applied successfully, or false if the filter could not be applied because the node is locked or does not have an editable paint device.

configuration() ➞ InfoObject

＋Krita 4.0.0

Return

the configuration object for the filter

name() ➞ str

＋Krita 4.0.0

the internal name of this filter.

Return

the name.

setConfiguration(value: InfoObject)

＋Krita 4.0.0

set the configuration object for the filter

Parameters

value (no description provided)

setName(name: str)

＋Krita 4.0.0

set the filter's name to the given name.

Parameters

name	(no description provided)

startFilter(node: Node, x: int, y: int, w: int, h: int) ➞ bool

＋Krita 4.0.0↻Krita 4.2.0

starts the given filter on the given node.

Parameters

node	the node to apply the filter to
x	(no description provided)
y	(no description provided)
w	(no description provided)
h	describe the rectangle the filter should be apply. This is always in image pixel coordinates and not relative to the x, y of the node.

Return

(no description provided)