QgsRasterShader Class Reference

Interface for all raster shaders. More...

#include <qgsrastershader.h>

Public Member Functions
	QgsRasterShader (const QgsRasterShader &rh)=delete
	QgsRasterShader cannot be copied. More...
	QgsRasterShader (double minimumValue=0.0, double maximumValue=255.0)
double	maximumValue () const
	Returns the maximum value for the raster shader. More...
double	minimumValue () const
	Returns the minimum value for the raster shader. More...
QgsRasterShader &	operator= (const QgsRasterShader &rh)=delete
	QgsRasterShader cannot be copied. More...
QgsRasterShaderFunction *	rasterShaderFunction ()
const QgsRasterShaderFunction *	rasterShaderFunction () const
void	readXml (const QDomElement &elem)
	Reads shader state from an XML element. More...
void	setMaximumValue (double value)
	Sets the maximum value for the raster shader. More...
void	setMinimumValue (double value)
	Sets the minimum value for the raster shader. More...
void	setRasterShaderFunction (QgsRasterShaderFunction *function)
	A public method that allows the user to set their own shader function. More...
bool	shade (double redValue, double greenValue, double blueValue, double alphaValue, int *returnRedValue, int *returnGreenValue, int *returnBlueValue, int *returnAlpha)
	Generates a new RGBA value based on an original RGBA value. More...
bool	shade (double value, int *returnRedValue, int *returnGreenValue, int *returnBlueValue, int *returnAlpha)
	Generates a new RGBA value based on one input value. More...
void	writeXml (QDomDocument &doc, QDomElement &parent) const
	Writes shader state to an XML element. More...

Detailed Description

Interface for all raster shaders.

Definition at line 34 of file qgsrastershader.h.

Constructor & Destructor Documentation

QgsRasterShader() [1/2]

QgsRasterShader::QgsRasterShader	(	double	minimumValue = 0.0,
		double	maximumValue = 255.0
	)

Definition at line 28 of file qgsrastershader.cpp.

QgsRasterShader() [2/2]

QgsRasterShader::QgsRasterShader ( const QgsRasterShader &  rh )

delete

QgsRasterShader cannot be copied.

Member Function Documentation

maximumValue()

double QgsRasterShader::maximumValue ( ) const

inline

Returns the maximum value for the raster shader.

See also

setMaximumValue()

minimumValue()

Definition at line 56 of file qgsrastershader.h.

minimumValue()

double QgsRasterShader::minimumValue ( ) const

inline

Returns the minimum value for the raster shader.

See also

setMinimumValue()

maximumValue()

Definition at line 63 of file qgsrastershader.h.

operator=()

QgsRasterShader& QgsRasterShader::operator= ( const QgsRasterShader &  rh )

delete

QgsRasterShader cannot be copied.

rasterShaderFunction() [1/2]

QgsRasterShaderFunction* QgsRasterShader::rasterShaderFunction ( )

inline

Definition at line 65 of file qgsrastershader.h.

rasterShaderFunction() [2/2]

const QgsRasterShaderFunction* QgsRasterShader::rasterShaderFunction ( ) const

inline

Definition at line 66 of file qgsrastershader.h.

readXml()

void QgsRasterShader::readXml

(

const QDomElement &

elem

)

Reads shader state from an XML element.

Definition at line 107 of file qgsrastershader.cpp.

setMaximumValue()

void QgsRasterShader::setMaximumValue

(

double

value

)

Sets the maximum value for the raster shader.

See also

setMinimumValue()

maximumValue()

Definition at line 69 of file qgsrastershader.cpp.

setMinimumValue()

void QgsRasterShader::setMinimumValue

(

double

value

)

Sets the minimum value for the raster shader.

See also

setMaximumValue()

minimumValue()

Definition at line 80 of file qgsrastershader.cpp.

setRasterShaderFunction()

void QgsRasterShader::setRasterShaderFunction

(

QgsRasterShaderFunction *

function

)

A public method that allows the user to set their own shader function.

Note

Raster shader takes ownership of the shader function instance

Definition at line 56 of file qgsrastershader.cpp.

shade() [1/2]

bool QgsRasterShader::shade	(	double	redValue,
		double	greenValue,
		double	blueValue,
		double	alphaValue,
		int *	returnRedValue,
		int *	returnGreenValue,
		int *	returnBlueValue,
		int *	returnAlpha
	)

Generates a 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
returnAlpha	The alpha component of the new RGBA value

Returns

true if the return values are valid otherwise false

Definition at line 46 of file qgsrastershader.cpp.

shade() [2/2]

bool QgsRasterShader::shade	(	double	value,
		int *	returnRedValue,
		int *	returnGreenValue,
		int *	returnBlueValue,
		int *	returnAlpha
	)

Generates a 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
returnAlpha	The alpha component of the new RGBA value

Returns

true if the return values are valid otherwise false

Definition at line 36 of file qgsrastershader.cpp.

writeXml()

void QgsRasterShader::writeXml	(	QDomDocument &	doc,
		QDomElement &	parent
	)		const

Writes shader state to an XML element.

Definition at line 91 of file qgsrastershader.cpp.

---

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

• /build/qgis-3.16.0+99unstable/src/core/raster/qgsrastershader.h
• /build/qgis-3.16.0+99unstable/src/core/raster/qgsrastershader.cpp