QgsBrightnessContrastFilter class

Brightness/contrast filter pipe for rasters.

Contents

Base classes

class QgsRasterInterface
Base class for processing filters like renderers, reprojector, resampler etc.

Public functions

auto bandCount() const -> int override
Gets number of bands.
auto block(int bandNo, const QgsRectangle& extent, int width, int height, QgsRasterBlockFeedback* feedback = nullptr) -> QgsRasterBlock* override
Read block of data using given extent and size.
auto clone() const -> QgsBrightnessContrastFilter* override
Clone itself, create deep copy.
auto dataType(int bandNo) const -> Qgis::DataType override
Returns data type for the band specified by number.
void readXml(const QDomElement& filterElem) override
Sets base class members from xml. Usually called from create() methods of subclasses.
auto setInput(QgsRasterInterface* input) -> bool override
Set input.
void writeXml(QDomDocument& doc, QDomElement& parentElem) const override
Write base class members to xml.

Function documentation

QgsRasterBlock* QgsBrightnessContrastFilter::block(int bandNo, const QgsRectangle& extent, int width, int height, QgsRasterBlockFeedback* feedback = nullptr) override

Read block of data using given extent and size.

Parameters
bandNo band number
extent extent of block
width pixel width of block
height pixel height of block
feedback optional raster feedback object for cancelation/preview. Added in QGIS 3.0.

Returns pointer to data. Caller is responsible to free the memory returned.

bool QgsBrightnessContrastFilter::setInput(QgsRasterInterface* input) override

Set input.

Returns true if set correctly, false if cannot use that input