QGIS API Documentation  3.20.0-Odense (decaadbb31)
Public Member Functions | List of all members
QgsRasterResampler Class Referenceabstract

Interface for resampling rasters (e.g. More...

#include <qgsrasterresampler.h>

Inheritance diagram for QgsRasterResampler:
Inheritance graph
[legend]

Public Member Functions

virtual ~QgsRasterResampler ()=default
 
virtual QgsRasterResamplerclone () const =0
 Gets a deep copy of this object. More...
 
virtual Q_DECL_DEPRECATED void resample (const QImage &srcImage, QImage &dstImage)=0
 Resamples a source image to a destination image. More...
 
virtual int tileBufferPixels () const
 Returns the optional tile buffer size in pixels. More...
 
virtual QString type () const =0
 Gets a descriptive type identifier for this raster resampler. More...
 

Detailed Description

Interface for resampling rasters (e.g.

to have a smoother appearance)

Definition at line 33 of file qgsrasterresampler.h.

Constructor & Destructor Documentation

◆ ~QgsRasterResampler()

virtual QgsRasterResampler::~QgsRasterResampler ( )
virtualdefault

Member Function Documentation

◆ clone()

virtual QgsRasterResampler* QgsRasterResampler::clone ( ) const
pure virtual

Gets a deep copy of this object.

Needs to be reimplemented by subclasses. Ownership is transferred to the caller.

Implemented in QgsCubicRasterResampler, and QgsBilinearRasterResampler.

◆ resample()

virtual Q_DECL_DEPRECATED void QgsRasterResampler::resample ( const QImage &  srcImage,
QImage &  dstImage 
)
pure virtual

Resamples a source image to a destination image.

The size of the passed destination image should be respected during the resampling process.

Deprecated:
since QGIS 3.10.1, use the more efficient QgsRasterResamplerV2 interface instead.

Implemented in QgsCubicRasterResampler, and QgsBilinearRasterResampler.

◆ tileBufferPixels()

virtual int QgsRasterResampler::tileBufferPixels ( ) const
inlinevirtual

Returns the optional tile buffer size in pixels.

This represents the size to buffer individual resampled tile requests prior to resampling, in order to avoid rendering artifacts at the edges of raster tile boundaries.

Since
QGIS 3.10.1

Reimplemented in QgsCubicRasterResampler, and QgsBilinearRasterResampler.

Definition at line 85 of file qgsrasterresampler.h.

◆ type()

virtual QString QgsRasterResampler::type ( ) const
pure virtual

Gets a descriptive type identifier for this raster resampler.

Needs to be implemented by subclasses.

Implemented in QgsCubicRasterResampler, and QgsBilinearRasterResampler.


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