QgsRasterPyramid Class Reference

This struct is used to store pyramid info for the raster layer. More...

#include <qgsrasterpyramid.h>

Public Member Functions
bool	getBuild () const
	Returns true if the pyramid layer will be built.
bool	getExists () const
	Returns true if the pyramid layer currently exists.
int	getLevel () const
	Returns the pyramid level.
int	getXDim () const
	Returns the x dimension for this pyramid layer.
int	getYDim () const
	Returns the y dimension for this pyramid layer.
void	setBuild (bool build)
	Sets whether the pyramid layer will be built.
void	setExists (bool exists)
	Sets whether the pyramid layer currently exists.
void	setLevel (int level)
	Sets the pyramid level.
void	setXDim (int dimension)
	Sets the x dimension for this pyramid layer.
void	setYDim (int dimension)
	Sets the y dimension for this pyramid layer.

Detailed Description

This struct is used to store pyramid info for the raster layer.

Definition at line 28 of file qgsrasterpyramid.h.

Member Function Documentation

getBuild()

bool QgsRasterPyramid::getBuild ( ) const

inline

Returns true if the pyramid layer will be built.

When used with QgsRasterDataProvider::buildPyramids() this flag controls whether pyramids will be built for the layer.

Since

QGIS 3.20

Definition at line 121 of file qgsrasterpyramid.h.

getExists()

bool QgsRasterPyramid::getExists ( ) const

inline

Returns true if the pyramid layer currently exists.

Since

QGIS 3.20

Definition at line 100 of file qgsrasterpyramid.h.

getLevel()

int QgsRasterPyramid::getLevel ( ) const

inline

Returns the pyramid level.

Pyramid levels are as defined by GDAL, eg level 2 is half the original raster size.

Since

QGIS 3.20

Definition at line 43 of file qgsrasterpyramid.h.

getXDim()

int QgsRasterPyramid::getXDim ( ) const

inline

Returns the x dimension for this pyramid layer.

Since

QGIS 3.20

Definition at line 71 of file qgsrasterpyramid.h.

getYDim()

int QgsRasterPyramid::getYDim ( ) const

inline

Returns the y dimension for this pyramid layer.

Since

QGIS 3.20

Definition at line 89 of file qgsrasterpyramid.h.

setBuild()

void QgsRasterPyramid::setBuild ( bool  build )

inline

Sets whether the pyramid layer will be built.

When used with QgsRasterDataProvider::buildPyramids() this flag controls whether pyramids will be built for the layer. Set to true to build the pyramids.

Since

QGIS 3.20

Definition at line 132 of file qgsrasterpyramid.h.

setExists()

void QgsRasterPyramid::setExists ( bool  exists )

inline

Sets whether the pyramid layer currently exists.

Since

QGIS 3.20

Definition at line 107 of file qgsrasterpyramid.h.

setLevel()

void QgsRasterPyramid::setLevel ( int  level )

inline

Sets the pyramid level.

Pyramid levels are as defined by GDAL, eg level 2 is half the original raster size.

Since

QGIS 3.20

Definition at line 53 of file qgsrasterpyramid.h.

setXDim()

void QgsRasterPyramid::setXDim ( int  dimension )

inline

Sets the x dimension for this pyramid layer.

Since

QGIS 3.20

Definition at line 64 of file qgsrasterpyramid.h.

setYDim()

void QgsRasterPyramid::setYDim ( int  dimension )

inline

Sets the y dimension for this pyramid layer.

Since

QGIS 3.20

Definition at line 82 of file qgsrasterpyramid.h.

---

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

• /build/qgis-3.41.0+git20241110+fda2aa46e9a+99sid/src/core/raster/qgsrasterpyramid.h