Skip to content

Commit

Permalink
Merge pull request #10743 from OSGeo/rouault-patch-1
Browse files Browse the repository at this point in the history
GDALRasterBand::BuildOverviews(): clarify warning
  • Loading branch information
rouault authored Sep 7, 2024
2 parents 113b677 + 76740da commit 9fab616
Showing 1 changed file with 4 additions and 6 deletions.
10 changes: 4 additions & 6 deletions gcore/gdalrasterband.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -3351,12 +3351,10 @@ GDALGetRasterSampleOverviewEx(GDALRasterBandH hBand, GUIntBig nDesiredSamples)
* CE_Failure is returned, and CPLGetLastErrorNo() will return
* CPLE_NotSupported.
*
* WARNING: It is not possible to build overviews for a single band in
* TIFF format, and thus this method does not work for TIFF format, or any
* formats that use the default overview building in TIFF format. Instead
* it is necessary to build overviews on the dataset as a whole using
* GDALDataset::BuildOverviews(). That makes this method pretty useless
* from a practical point of view.
* WARNING: Most formats don't support per-band overview computation, but
* require that overviews are computed for all bands of a dataset, using
* GDALDataset::BuildOverviews(). The only exception for official GDAL drivers
* is the HFA driver which supports this method.
*
* @param pszResampling one of "NEAREST", "GAUSS", "CUBIC", "AVERAGE", "MODE",
* "AVERAGE_MAGPHASE" "RMS" or "NONE" controlling the downsampling method
Expand Down

0 comments on commit 9fab616

Please sign in to comment.