QgsMultiBandColorRenderer class
Renderer for multiband images with the color components.
Contents
Base classes
- class QgsRasterRenderer
- Raster renderer pipe that applies colors to a raster.
Constructors, destructors, conversion operators
- QgsMultiBandColorRenderer(const QgsMultiBandColorRenderer&) deleted
- QgsMultiBandColorRenderer cannot be copied. Use clone() instead.
Public functions
- 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 -> QgsMultiBandColorRenderer* override
- Clone itself, create deep copy.
- auto operator=(const QgsMultiBandColorRenderer&) -> const QgsMultiBandColorRenderer& deleted
- QgsMultiBandColorRenderer cannot be copied. Use clone() instead.
- void setBlueContrastEnhancement(QgsContrastEnhancement* ce)
- Takes ownership.
- void setGreenContrastEnhancement(QgsContrastEnhancement* ce)
- Takes ownership.
- void setRedContrastEnhancement(QgsContrastEnhancement* ce)
- Takes ownership.
- auto usesBands() const -> QList<int> override
- Returns a list of band numbers used by the renderer.
- void writeXml(QDomDocument& doc, QDomElement& parentElem) const override
- Write base class members to xml.
Function documentation
QgsRasterBlock* QgsMultiBandColorRenderer:: 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.