The raster shade function applies a shader to a pixel at render time - typically used to render grayscale images as false color.
More...
#include <qgsrastershaderfunction.h>
|
| QgsRasterShaderFunction (double minimumValue=0.0, double maximumValue=255.0) |
|
virtual | ~QgsRasterShaderFunction ()=default |
|
virtual void | legendSymbologyItems (QList< QPair< QString, QColor > > &symbolItems) const |
|
double | maximumValue () const |
|
double | minimumMaximumRange () const |
|
double | minimumValue () const |
|
virtual void | setMaximumValue (double) |
| Set the maximum value. More...
|
|
virtual void | setMinimumValue (double) |
| Return the minimum value. More...
|
|
virtual bool | shade (double value, int *returnRedValue, int *returnGreenValue, int *returnBlueValue, int *returnAlpha) |
| generates and new RGBA value based on one input value More...
|
|
virtual bool | shade (double redValue, double greenValue, double blueValue, double alphaValue, int *returnRedValue, int *returnGreenValue, int *returnBlueValue, int *returnAlpha) |
| generates and new RGBA value based on original RGBA value More...
|
|
The raster shade function applies a shader to a pixel at render time - typically used to render grayscale images as false color.
Definition at line 34 of file qgsrastershaderfunction.h.
◆ QgsRasterShaderFunction()
QgsRasterShaderFunction::QgsRasterShaderFunction |
( |
double |
minimumValue = 0.0 , |
|
|
double |
maximumValue = 255.0 |
|
) |
| |
◆ ~QgsRasterShaderFunction()
virtual QgsRasterShaderFunction::~QgsRasterShaderFunction |
( |
| ) |
|
|
virtualdefault |
◆ legendSymbologyItems()
virtual void QgsRasterShaderFunction::legendSymbologyItems |
( |
QList< QPair< QString, QColor > > & |
symbolItems | ) |
const |
|
inlinevirtual |
◆ maximumValue()
double QgsRasterShaderFunction::maximumValue |
( |
| ) |
const |
|
inline |
◆ minimumMaximumRange()
double QgsRasterShaderFunction::minimumMaximumRange |
( |
| ) |
const |
|
inline |
◆ minimumValue()
double QgsRasterShaderFunction::minimumValue |
( |
| ) |
const |
|
inline |
◆ setMaximumValue()
void QgsRasterShaderFunction::setMaximumValue |
( |
double |
value | ) |
|
|
virtual |
Set the maximum value.
Set the maximum value for the raster shader.
- Parameters
-
value | The new maximum value |
Definition at line 35 of file qgsrastershaderfunction.cpp.
◆ setMinimumValue()
void QgsRasterShaderFunction::setMinimumValue |
( |
double |
value | ) |
|
|
virtual |
Return the minimum value.
Set the maximum value for the raster shader.
- Parameters
-
value | The new minimum value |
Definition at line 48 of file qgsrastershaderfunction.cpp.
◆ shade() [1/2]
bool QgsRasterShaderFunction::shade |
( |
double |
value, |
|
|
int * |
returnRedValue, |
|
|
int * |
returnGreenValue, |
|
|
int * |
returnBlueValue, |
|
|
int * |
returnAlphaValue |
|
) |
| |
|
virtual |
generates and new RGBA value based on one input value
Generates and new RGBA value based on one input value.
- Parameters
-
value | The original value to base a new RGBA value on |
returnRedValue | The red component of the new RGBA value |
returnGreenValue | The green component of the new RGBA value |
returnBlueValue | The blue component of the new RGBA value |
returnAlphaValue | The blue component of the new RGBA value |
- Returns
- True if the return values are valid otherwise false
Reimplemented in QgsColorRampShader.
Definition at line 66 of file qgsrastershaderfunction.cpp.
◆ shade() [2/2]
bool QgsRasterShaderFunction::shade |
( |
double |
redValue, |
|
|
double |
greenValue, |
|
|
double |
blueValue, |
|
|
double |
alphaValue, |
|
|
int * |
returnRedValue, |
|
|
int * |
returnGreenValue, |
|
|
int * |
returnBlueValue, |
|
|
int * |
returnAlphaValue |
|
) |
| |
|
virtual |
generates and new RGBA value based on original RGBA value
Generates and new RGBA value based on an original RGBA value.
- Parameters
-
redValue | The red component of the original value to base a new RGBA value on |
greenValue | The green component of the original value to base a new RGBA value on |
blueValue | The blue component of the original value to base a new RGBA value on |
alphaValue | The alpha component of the original value to base a new RGBA value on |
returnRedValue | The red component of the new RGBA value |
returnGreenValue | The green component of the new RGBA value |
returnBlueValue | The blue component of the new RGBA value |
returnAlphaValue | The alpha component of the new RGBA value |
- Returns
- True if the return values are valid otherwise false
Reimplemented in QgsColorRampShader.
Definition at line 92 of file qgsrastershaderfunction.cpp.
◆ mMaximumValue
double QgsRasterShaderFunction::mMaximumValue |
|
protected |
◆ mMinimumMaximumRange
double QgsRasterShaderFunction::mMinimumMaximumRange |
|
protected |
◆ mMinimumValue
double QgsRasterShaderFunction::mMinimumValue |
|
protected |
The documentation for this class was generated from the following files: