Line data Source code
1 : /******************************************************************************
2 : *
3 : * Project: GDAL Core
4 : * Purpose: GDAL Core C/Public declarations.
5 : * Author: Frank Warmerdam, warmerdam@pobox.com
6 : *
7 : ******************************************************************************
8 : * Copyright (c) 1998, 2002 Frank Warmerdam
9 : * Copyright (c) 2007-2014, Even Rouault <even dot rouault at spatialys.com>
10 : *
11 : * SPDX-License-Identifier: MIT
12 : ****************************************************************************/
13 :
14 : #ifndef GDAL_H_INCLUDED
15 : #define GDAL_H_INCLUDED
16 :
17 : /**
18 : * \file gdal.h
19 : *
20 : * Public (C callable) GDAL entry points.
21 : */
22 :
23 : #ifndef DOXYGEN_SKIP
24 : #if defined(GDAL_COMPILATION)
25 : #define DO_NOT_DEFINE_GDAL_DATE_NAME
26 : #endif
27 : #include "gdal_fwd.h"
28 : #include "gdal_version.h"
29 : #include "cpl_port.h"
30 : #include "cpl_error.h"
31 : #include "cpl_progress.h"
32 : #include "cpl_virtualmem.h"
33 : #include "cpl_minixml.h"
34 : #include "ogr_api.h"
35 : #endif
36 :
37 : #include <stdbool.h>
38 : #include <stdint.h>
39 :
40 : /* -------------------------------------------------------------------- */
41 : /* Significant constants. */
42 : /* -------------------------------------------------------------------- */
43 :
44 : CPL_C_START
45 :
46 : /*! Pixel data types */
47 : typedef enum
48 : {
49 : /*! Unknown or unspecified type */ GDT_Unknown = 0,
50 : /*! 8-bit unsigned integer (GDT_Byte in GDAL < 3.13) */ GDT_UInt8 = 1,
51 : /*! 8-bit signed integer (GDAL >= 3.7) */ GDT_Int8 = 14,
52 : /*! 16-bit unsigned integer */ GDT_UInt16 = 2,
53 : /*! 16-bit signed integer */ GDT_Int16 = 3,
54 : /*! 32-bit unsigned integer */ GDT_UInt32 = 4,
55 : /*! 32-bit signed integer */ GDT_Int32 = 5,
56 : /*! 64 bit unsigned integer (GDAL >= 3.5)*/ GDT_UInt64 = 12,
57 : /*! 64 bit signed integer (GDAL >= 3.5)*/ GDT_Int64 = 13,
58 : /*! 16-bit floating point */ GDT_Float16 = 15,
59 : /*! 32-bit floating point */ GDT_Float32 = 6,
60 : /*! 64-bit floating point */ GDT_Float64 = 7,
61 : /*! Complex Int16 */ GDT_CInt16 = 8,
62 : /*! Complex Int32 */ GDT_CInt32 = 9,
63 : /*! Complex Float16 */ GDT_CFloat16 = 16,
64 : /*! Complex Float32 */ GDT_CFloat32 = 10,
65 : /*! Complex Float64 */ GDT_CFloat64 = 11,
66 : GDT_TypeCount = 17 /* maximum type # + 1 */
67 : } GDALDataType;
68 :
69 : /** GDT_Byte is the name used before GDAL 3.13 for GDT_UInt8 */
70 : #define GDT_Byte GDT_UInt8
71 :
72 : int CPL_DLL CPL_STDCALL GDALGetDataTypeSize(GDALDataType)
73 : /*! @cond Doxygen_Suppress */
74 : CPL_WARN_DEPRECATED("Use GDALGetDataTypeSizeBits() or "
75 : "GDALGetDataTypeSizeBytes() * 8 instead")
76 : /*! @endcond */
77 : ;
78 : int CPL_DLL CPL_STDCALL GDALGetDataTypeSizeBits(GDALDataType eDataType);
79 : int CPL_DLL CPL_STDCALL GDALGetDataTypeSizeBytes(GDALDataType);
80 : int CPL_DLL CPL_STDCALL GDALDataTypeIsComplex(GDALDataType);
81 : int CPL_DLL CPL_STDCALL GDALDataTypeIsInteger(GDALDataType);
82 : int CPL_DLL CPL_STDCALL GDALDataTypeIsFloating(GDALDataType);
83 : int CPL_DLL CPL_STDCALL GDALDataTypeIsSigned(GDALDataType);
84 : const char CPL_DLL *CPL_STDCALL GDALGetDataTypeName(GDALDataType);
85 : GDALDataType CPL_DLL CPL_STDCALL GDALGetDataTypeByName(const char *);
86 : GDALDataType CPL_DLL CPL_STDCALL GDALDataTypeUnion(GDALDataType, GDALDataType);
87 : GDALDataType CPL_DLL CPL_STDCALL GDALDataTypeUnionWithValue(GDALDataType eDT,
88 : double dValue,
89 : int bComplex);
90 : GDALDataType CPL_DLL CPL_STDCALL GDALFindDataType(int nBits, int bSigned,
91 : int bFloating, int bComplex);
92 : GDALDataType CPL_DLL CPL_STDCALL GDALFindDataTypeForValue(double dValue,
93 : int bComplex);
94 : double CPL_DLL GDALAdjustValueToDataType(GDALDataType eDT, double dfValue,
95 : int *pbClamped, int *pbRounded);
96 : bool CPL_DLL GDALIsValueExactAs(double dfValue, GDALDataType eDT);
97 : bool CPL_DLL GDALIsValueInRangeOf(double dfValue, GDALDataType eDT);
98 : GDALDataType CPL_DLL CPL_STDCALL GDALGetNonComplexDataType(GDALDataType);
99 : int CPL_DLL CPL_STDCALL GDALDataTypeIsConversionLossy(GDALDataType eTypeFrom,
100 : GDALDataType eTypeTo);
101 :
102 : /**
103 : * status of the asynchronous stream
104 : */
105 : typedef enum
106 : {
107 : GARIO_PENDING = 0,
108 : GARIO_UPDATE = 1,
109 : GARIO_ERROR = 2,
110 : GARIO_COMPLETE = 3,
111 : GARIO_TypeCount = 4
112 : } GDALAsyncStatusType;
113 :
114 : const char CPL_DLL *CPL_STDCALL GDALGetAsyncStatusTypeName(GDALAsyncStatusType);
115 : GDALAsyncStatusType CPL_DLL CPL_STDCALL
116 : GDALGetAsyncStatusTypeByName(const char *);
117 :
118 : /*! Flag indicating read/write, or read-only access to data. */
119 : typedef enum
120 : {
121 : /*! Read only (no update) access */ GA_ReadOnly = 0,
122 : /*! Read/write access. */ GA_Update = 1
123 : } GDALAccess;
124 :
125 : /*! Read/Write flag for RasterIO() method */
126 : typedef enum
127 : {
128 : /*! Read data */ GF_Read = 0,
129 : /*! Write data */ GF_Write = 1
130 : } GDALRWFlag;
131 :
132 : /* NOTE: values are selected to be consistent with GDALResampleAlg of
133 : * alg/gdalwarper.h */
134 : /** RasterIO() resampling method.
135 : */
136 : typedef enum
137 : {
138 : /*! Nearest neighbour */ GRIORA_NearestNeighbour = 0,
139 : /*! Bilinear (2x2 kernel) */ GRIORA_Bilinear = 1,
140 : /*! Cubic Convolution Approximation (4x4 kernel) */ GRIORA_Cubic = 2,
141 : /*! Cubic B-Spline Approximation (4x4 kernel) */ GRIORA_CubicSpline = 3,
142 : /*! Lanczos windowed sinc interpolation (6x6 kernel) */ GRIORA_Lanczos = 4,
143 : /*! Average */ GRIORA_Average = 5,
144 : /*! Mode (selects the value which appears most often of all the sampled
145 : points) */
146 : GRIORA_Mode = 6,
147 : /*! Gauss blurring */ GRIORA_Gauss = 7,
148 : /* NOTE: values 8 to 13 are reserved for max,min,med,Q1,Q3,sum */
149 : /*! @cond Doxygen_Suppress */
150 : GRIORA_RESERVED_START = 8,
151 : GRIORA_RESERVED_END = 13,
152 : /*! @endcond */
153 : /** RMS: Root Mean Square / Quadratic Mean.
154 : * For complex numbers, applies on the real and imaginary part
155 : * independently.
156 : */
157 : GRIORA_RMS = 14,
158 : /*! @cond Doxygen_Suppress */
159 : GRIORA_LAST = GRIORA_RMS
160 : /*! @endcond */
161 : } GDALRIOResampleAlg;
162 :
163 : /* NOTE to developers: if required, only add members at the end of the
164 : * structure, and when doing so increase RASTERIO_EXTRA_ARG_CURRENT_VERSION
165 : */
166 : /** Structure to pass extra arguments to RasterIO() method,
167 : * must be initialized with INIT_RASTERIO_EXTRA_ARG
168 : */
169 : typedef struct
170 : {
171 : /*! Version of structure (to allow future extensions of the structure) */
172 : int nVersion;
173 :
174 : /*! Resampling algorithm */
175 : GDALRIOResampleAlg eResampleAlg;
176 :
177 : /*! Progress callback */
178 : GDALProgressFunc pfnProgress;
179 : /*! Progress callback user data */
180 : void *pProgressData;
181 :
182 : /*! Indicate if dfXOff, dfYOff, dfXSize and dfYSize are set.
183 : Mostly reserved from the VRT driver to communicate a more precise
184 : source window. Must be such that dfXOff - nXOff < 1.0 and
185 : dfYOff - nYOff < 1.0 and nXSize - dfXSize < 1.0 and nYSize - dfYSize
186 : < 1.0 */
187 : int bFloatingPointWindowValidity;
188 : /*! Pixel offset to the top left corner. Only valid if
189 : * bFloatingPointWindowValidity = TRUE */
190 : double dfXOff;
191 : /*! Line offset to the top left corner. Only valid if
192 : * bFloatingPointWindowValidity = TRUE */
193 : double dfYOff;
194 : /*! Width in pixels of the area of interest. Only valid if
195 : * bFloatingPointWindowValidity = TRUE */
196 : double dfXSize;
197 : /*! Height in pixels of the area of interest. Only valid if
198 : * bFloatingPointWindowValidity = TRUE */
199 : double dfYSize;
200 : /*! Indicate if overviews should be considered. Tested in
201 : GDALBandGetBestOverviewLevel(), mostly reserved for use by
202 : GDALRegenerateOverviewsMultiBand()
203 : Only available if RASTERIO_EXTRA_ARG_CURRENT_VERSION >= 2
204 : */
205 : int bUseOnlyThisScale;
206 : } GDALRasterIOExtraArg;
207 :
208 : #ifndef DOXYGEN_SKIP
209 : #define RASTERIO_EXTRA_ARG_CURRENT_VERSION 2
210 : #endif
211 :
212 : /** Macro to initialize an instance of GDALRasterIOExtraArg structure.
213 : */
214 : #define INIT_RASTERIO_EXTRA_ARG(s) \
215 : do \
216 : { \
217 : (s).nVersion = RASTERIO_EXTRA_ARG_CURRENT_VERSION; \
218 : (s).eResampleAlg = GRIORA_NearestNeighbour; \
219 : (s).pfnProgress = CPL_NULLPTR; \
220 : (s).pProgressData = CPL_NULLPTR; \
221 : (s).bFloatingPointWindowValidity = FALSE; \
222 : (s).bUseOnlyThisScale = FALSE; \
223 : } while (0)
224 :
225 : /** Value indicating the start of the range for color interpretations belonging
226 : * to the InfraRed (IR) domain. All constants of the GDALColorInterp enumeration
227 : * in the IR domain are in the [GCI_IR_Start, GCI_IR_End] range.
228 : *
229 : * @since 3.10
230 : */
231 : #define GCI_IR_Start 20
232 :
233 : /** Value indicating the end of the range for color interpretations belonging
234 : * to the InfraRed (IR) domain. All constants of the GDALColorInterp enumeration
235 : * in the IR domain are in the [GCI_IR_Start, GCI_IR_End] range.
236 : *
237 : * @since 3.10
238 : */
239 : #define GCI_IR_End 29
240 :
241 : /** Value indicating the start of the range for color interpretations belonging
242 : * to the Synthetic Aperture Radar (SAR) domain.
243 : * All constants of the GDALColorInterp enumeration
244 : * in the SAR domain are in the [GCI_SAR_Start, GCI_SAR_End] range.
245 : *
246 : * @since 3.10
247 : */
248 : #define GCI_SAR_Start 30
249 :
250 : /** Value indicating the end of the range for color interpretations belonging
251 : * to the Synthetic Aperture Radar (SAR) domain.
252 : * All constants of the GDALColorInterp enumeration
253 : * in the SAR domain are in the [GCI_SAR_Start, GCI_SAR_End] range.
254 : *
255 : * @since 3.10
256 : */
257 : #define GCI_SAR_End 39
258 :
259 : /** Types of color interpretation for raster bands.
260 : *
261 : * For spectral bands, the wavelength ranges are indicative only, and may vary
262 : * depending on sensors. The CENTRAL_WAVELENGTH_UM and FWHM_UM metadata
263 : * items in the IMAGERY metadata domain of the raster band, when present, will
264 : * give more accurate characteristics.
265 : *
266 : * Values belonging to the IR domain are in the [GCI_IR_Start, GCI_IR_End] range.
267 : * Values belonging to the SAR domain are in the [GCI_SAR_Start, GCI_SAR_End] range.
268 : *
269 : * Values between GCI_PanBand to GCI_SAR_Reserved_2 have been added in GDAL 3.10.
270 : */
271 : typedef enum
272 : {
273 : /*! Undefined */ GCI_Undefined = 0,
274 : /*! Greyscale */ GCI_GrayIndex = 1,
275 : /*! Paletted (see associated color table) */ GCI_PaletteIndex = 2,
276 : /*! Red band of RGBA image, or red spectral band [0.62 - 0.69 um]*/
277 : GCI_RedBand = 3,
278 : /*! Green band of RGBA image, or green spectral band [0.51 - 0.60 um]*/
279 : GCI_GreenBand = 4,
280 : /*! Blue band of RGBA image, or blue spectral band [0.45 - 0.53 um] */
281 : GCI_BlueBand = 5,
282 : /*! Alpha (0=transparent, 255=opaque) */ GCI_AlphaBand = 6,
283 : /*! Hue band of HLS image */ GCI_HueBand = 7,
284 : /*! Saturation band of HLS image */ GCI_SaturationBand = 8,
285 : /*! Lightness band of HLS image */ GCI_LightnessBand = 9,
286 : /*! Cyan band of CMYK image */ GCI_CyanBand = 10,
287 : /*! Magenta band of CMYK image */ GCI_MagentaBand = 11,
288 : /*! Yellow band of CMYK image, or yellow spectral band [0.58 - 0.62 um] */
289 : GCI_YellowBand = 12,
290 : /*! Black band of CMYK image */ GCI_BlackBand = 13,
291 : /*! Y Luminance */ GCI_YCbCr_YBand = 14,
292 : /*! Cb Chroma */ GCI_YCbCr_CbBand = 15,
293 : /*! Cr Chroma */ GCI_YCbCr_CrBand = 16,
294 :
295 : /* GDAL 3.10 addition: begin */
296 : /*! Panchromatic band [0.40 - 1.00 um] */ GCI_PanBand = 17,
297 : /*! Coastal band [0.40 - 0.45 um] */ GCI_CoastalBand = 18,
298 : /*! Red-edge band [0.69 - 0.79 um] */ GCI_RedEdgeBand = 19,
299 :
300 : /*! Near-InfraRed (NIR) band [0.75 - 1.40 um] */ GCI_NIRBand =
301 : GCI_IR_Start + 0,
302 : /*! Short-Wavelength InfraRed (SWIR) band [1.40 - 3.00 um] */ GCI_SWIRBand =
303 : GCI_IR_Start + 1,
304 : /*! Mid-Wavelength InfraRed (MWIR) band [3.00 - 8.00 um] */ GCI_MWIRBand =
305 : GCI_IR_Start + 2,
306 : /*! Long-Wavelength InfraRed (LWIR) band [8.00 - 15 um] */ GCI_LWIRBand =
307 : GCI_IR_Start + 3,
308 : /*! Thermal InfraRed (TIR) band (MWIR or LWIR) [3 - 15 um] */ GCI_TIRBand =
309 : GCI_IR_Start + 4,
310 : /*! Other infrared band [0.75 - 1000 um] */ GCI_OtherIRBand =
311 : GCI_IR_Start + 5,
312 : /*! Reserved value. Do not set it ! */
313 : GCI_IR_Reserved_1 = GCI_IR_Start + 6,
314 : /*! Reserved value. Do not set it ! */
315 : GCI_IR_Reserved_2 = GCI_IR_Start + 7,
316 : /*! Reserved value. Do not set it ! */
317 : GCI_IR_Reserved_3 = GCI_IR_Start + 8,
318 : /*! Reserved value. Do not set it ! */
319 : GCI_IR_Reserved_4 = GCI_IR_Start + 9,
320 :
321 : /*! Synthetic Aperture Radar (SAR) Ka band [0.8 - 1.1 cm / 27 - 40 GHz] */
322 : GCI_SAR_Ka_Band = GCI_SAR_Start + 0,
323 : /*! Synthetic Aperture Radar (SAR) K band [1.1 - 1.7 cm / 18 - 27 GHz] */
324 : GCI_SAR_K_Band = GCI_SAR_Start + 1,
325 : /*! Synthetic Aperture Radar (SAR) Ku band [1.7 - 2.4 cm / 12 - 18 GHz] */
326 : GCI_SAR_Ku_Band = GCI_SAR_Start + 2,
327 : /*! Synthetic Aperture Radar (SAR) X band [2.4 - 3.8 cm / 8 - 12 GHz] */
328 : GCI_SAR_X_Band = GCI_SAR_Start + 3,
329 : /*! Synthetic Aperture Radar (SAR) C band [3.8 - 7.5 cm / 4 - 8 GHz] */
330 : GCI_SAR_C_Band = GCI_SAR_Start + 4,
331 : /*! Synthetic Aperture Radar (SAR) S band [7.5 - 15 cm / 2 - 4 GHz] */
332 : GCI_SAR_S_Band = GCI_SAR_Start + 5,
333 : /*! Synthetic Aperture Radar (SAR) L band [15 - 30 cm / 1 - 2 GHz] */
334 : GCI_SAR_L_Band = GCI_SAR_Start + 6,
335 : /*! Synthetic Aperture Radar (SAR) P band [30 - 100 cm / 0.3 - 1 GHz] */
336 : GCI_SAR_P_Band = GCI_SAR_Start + 7,
337 : /*! Reserved value. Do not set it ! */
338 : GCI_SAR_Reserved_1 = GCI_SAR_Start + 8,
339 : /*! Reserved value. Do not set it ! */
340 : GCI_SAR_Reserved_2 = GCI_SAR_Start + 9,
341 :
342 : /* GDAL 3.10 addition: end */
343 :
344 : /*! Max current value (equals to GCI_SAR_Reserved_2 currently) */ GCI_Max =
345 : GCI_SAR_Reserved_2
346 : } GDALColorInterp;
347 :
348 : const char CPL_DLL *GDALGetColorInterpretationName(GDALColorInterp);
349 : GDALColorInterp CPL_DLL GDALGetColorInterpretationByName(const char *pszName);
350 :
351 : /*! Types of color interpretations for a GDALColorTable. */
352 : typedef enum
353 : {
354 : /*! Grayscale (in GDALColorEntry.c1) */ GPI_Gray = 0,
355 : /*! Red, Green, Blue and Alpha in (in c1, c2, c3 and c4) */ GPI_RGB = 1,
356 : /*! Cyan, Magenta, Yellow and Black (in c1, c2, c3 and c4)*/ GPI_CMYK = 2,
357 : /*! Hue, Lightness and Saturation (in c1, c2, and c3) */ GPI_HLS = 3
358 : } GDALPaletteInterp;
359 :
360 : const char CPL_DLL *GDALGetPaletteInterpretationName(GDALPaletteInterp);
361 :
362 : /* "well known" metadata items. */
363 :
364 : /** Metadata item for dataset that indicates the spatial interpretation of a
365 : * pixel */
366 : #define GDALMD_AREA_OR_POINT "AREA_OR_POINT"
367 : /** Value for GDALMD_AREA_OR_POINT that indicates that a pixel represents an
368 : * area */
369 : #define GDALMD_AOP_AREA "Area"
370 : /** Value for GDALMD_AREA_OR_POINT that indicates that a pixel represents a
371 : * point */
372 : #define GDALMD_AOP_POINT "Point"
373 :
374 : /* -------------------------------------------------------------------- */
375 : /* GDAL Specific error codes. */
376 : /* */
377 : /* error codes 100 to 299 reserved for GDAL. */
378 : /* -------------------------------------------------------------------- */
379 : #ifndef DOXYGEN_SKIP
380 : #define CPLE_WrongFormat CPL_STATIC_CAST(CPLErrorNum, 200)
381 : #endif
382 :
383 : /* -------------------------------------------------------------------- */
384 : /* Types, enumerations. */
385 : /* -------------------------------------------------------------------- */
386 :
387 : /** Type to express pixel, line or band spacing. Signed 64 bit integer. */
388 : typedef GIntBig GSpacing;
389 :
390 : /** Enumeration giving the class of a GDALExtendedDataType.
391 : * @since GDAL 3.1
392 : */
393 : typedef enum
394 : {
395 : /** Numeric value. Based on GDALDataType enumeration */
396 : GEDTC_NUMERIC,
397 : /** String value. */
398 : GEDTC_STRING,
399 : /** Compound data type. */
400 : GEDTC_COMPOUND
401 : } GDALExtendedDataTypeClass;
402 :
403 : /** Enumeration giving the subtype of a GDALExtendedDataType.
404 : * @since GDAL 3.4
405 : */
406 : typedef enum
407 : {
408 : /** None. */
409 : GEDTST_NONE,
410 : /** JSon. Only applies to GEDTC_STRING */
411 : GEDTST_JSON
412 : } GDALExtendedDataTypeSubType;
413 :
414 : /* ==================================================================== */
415 : /* Registration/driver related. */
416 : /* ==================================================================== */
417 :
418 : /** Long name of the driver */
419 : #define GDAL_DMD_LONGNAME "DMD_LONGNAME"
420 :
421 : /** URL (relative to http://gdal.org/) to the help page of the driver */
422 : #define GDAL_DMD_HELPTOPIC "DMD_HELPTOPIC"
423 :
424 : /** MIME type handled by the driver. */
425 : #define GDAL_DMD_MIMETYPE "DMD_MIMETYPE"
426 :
427 : /** Extension handled by the driver. */
428 : #define GDAL_DMD_EXTENSION "DMD_EXTENSION"
429 :
430 : /** Connection prefix to provide as the file name of the open function.
431 : * Typically set for non-file based drivers. Generally used with open options.
432 : */
433 : #define GDAL_DMD_CONNECTION_PREFIX "DMD_CONNECTION_PREFIX"
434 :
435 : /** List of (space separated) extensions handled by the driver.
436 : */
437 : #define GDAL_DMD_EXTENSIONS "DMD_EXTENSIONS"
438 :
439 : /** XML snippet with creation options. */
440 : #define GDAL_DMD_CREATIONOPTIONLIST "DMD_CREATIONOPTIONLIST"
441 :
442 : /** XML snippet with overview creation options.
443 : * @since GDAL 3.12
444 : */
445 : #define GDAL_DMD_OVERVIEW_CREATIONOPTIONLIST "DMD_OVERVIEW_CREATIONOPTIONLIST"
446 :
447 : /** XML snippet with multidimensional dataset creation options.
448 : * @since GDAL 3.1
449 : */
450 : #define GDAL_DMD_MULTIDIM_DATASET_CREATIONOPTIONLIST \
451 : "DMD_MULTIDIM_DATASET_CREATIONOPTIONLIST"
452 :
453 : /** XML snippet with multidimensional group creation options.
454 : * @since GDAL 3.1
455 : */
456 : #define GDAL_DMD_MULTIDIM_GROUP_CREATIONOPTIONLIST \
457 : "DMD_MULTIDIM_GROUP_CREATIONOPTIONLIST"
458 :
459 : /** XML snippet with multidimensional dimension creation options.
460 : * @since GDAL 3.1
461 : */
462 : #define GDAL_DMD_MULTIDIM_DIMENSION_CREATIONOPTIONLIST \
463 : "DMD_MULTIDIM_DIMENSION_CREATIONOPTIONLIST"
464 :
465 : /** XML snippet with multidimensional array creation options.
466 : * @since GDAL 3.1
467 : */
468 : #define GDAL_DMD_MULTIDIM_ARRAY_CREATIONOPTIONLIST \
469 : "DMD_MULTIDIM_ARRAY_CREATIONOPTIONLIST"
470 :
471 : /** XML snippet with multidimensional array open options.
472 : * @since GDAL 3.6
473 : */
474 : #define GDAL_DMD_MULTIDIM_ARRAY_OPENOPTIONLIST \
475 : "DMD_MULTIDIM_ARRAY_OPENOPTIONLIST"
476 :
477 : /** XML snippet with multidimensional attribute creation options.
478 : * @since GDAL 3.1
479 : */
480 : #define GDAL_DMD_MULTIDIM_ATTRIBUTE_CREATIONOPTIONLIST \
481 : "DMD_MULTIDIM_ATTRIBUTE_CREATIONOPTIONLIST"
482 :
483 : /** XML snippet with open options.
484 : */
485 : #define GDAL_DMD_OPENOPTIONLIST "DMD_OPENOPTIONLIST"
486 :
487 : /** List of (space separated) raster data types supported by the
488 : * Create()/CreateCopy() API. */
489 : #define GDAL_DMD_CREATIONDATATYPES "DMD_CREATIONDATATYPES"
490 :
491 : /** List of (space separated) vector field types supported by the CreateField()
492 : * API.
493 : * */
494 : #define GDAL_DMD_CREATIONFIELDDATATYPES "DMD_CREATIONFIELDDATATYPES"
495 :
496 : /** List of (space separated) vector field sub-types supported by the
497 : * CreateField() API.
498 : * */
499 : #define GDAL_DMD_CREATIONFIELDDATASUBTYPES "DMD_CREATIONFIELDDATASUBTYPES"
500 :
501 : /** Maximum size of a String field that can be created (OGRFieldDefn.GetWidth()).
502 : *
503 : * It is undefined whether this is a number of bytes or Unicode character count.
504 : * Most of the time, this will be a number of bytes, so a Unicode string whose
505 : * character count is the maximum size could not fit.
506 : *
507 : * This metadata item is set only on a small number of drivers, in particular
508 : * "ESRI Shapefile" and "MapInfo File", which use fixed-width storage of strings.
509 : *
510 : * @since GDAL 3.12
511 : */
512 : #define GDAL_DMD_MAX_STRING_LENGTH "DMD_MAX_STRING_LENGTH"
513 :
514 : /** List of (space separated) capability flags supported by the CreateField() API.
515 : *
516 : * Supported values are:
517 : *
518 : * - "WidthPrecision": field width and precision is supported.
519 : * - "Nullable": field (non-)nullable status is supported.
520 : * - "Unique": field unique constraint is supported.
521 : * - "Default": field default value is supported.
522 : * - "AlternativeName": field alternative name is supported.
523 : * - "Comment": field comment is supported.
524 : * - "Domain": field can be associated with a domain.
525 : *
526 : * @see GDAL_DMD_ALTER_FIELD_DEFN_FLAGS for capabilities supported when altering
527 : * existing fields.
528 : *
529 : * @since GDAL 3.7
530 : */
531 : #define GDAL_DMD_CREATION_FIELD_DEFN_FLAGS "DMD_CREATION_FIELD_DEFN_FLAGS"
532 :
533 : /** Capability set by a driver that exposes Subdatasets.
534 : *
535 : * This capability reflects that a raster driver supports child layers, such as
536 : * NetCDF or multi-table raster Geopackages.
537 : *
538 : * See GDAL_DCAP_MULTIPLE_VECTOR_LAYERS for a similar capability flag
539 : * for vector drivers.
540 : */
541 : #define GDAL_DMD_SUBDATASETS "DMD_SUBDATASETS"
542 :
543 : /** Capability set by a driver that can create subdatasets with the
544 : * APPEND_SUBDATASET=YES creation option.
545 : *
546 : * @since 3.11
547 : */
548 : #define GDAL_DCAP_CREATE_SUBDATASETS "DCAP_CREATE_SUBDATASETS"
549 :
550 : /** Capability set by a vector driver that supports field width and precision.
551 : *
552 : * This capability reflects that a vector driver includes the decimal separator
553 : * in the field width of fields of type OFTReal.
554 : *
555 : * See GDAL_DMD_NUMERIC_FIELD_WIDTH_INCLUDES_SIGN for a related capability flag.
556 : * @since GDAL 3.7
557 : */
558 : #define GDAL_DMD_NUMERIC_FIELD_WIDTH_INCLUDES_DECIMAL_SEPARATOR \
559 : "DMD_NUMERIC_FIELD_WIDTH_INCLUDES_DECIMAL_SEPARATOR"
560 :
561 : /** Capability set by a vector driver that supports field width and precision.
562 : *
563 : * This capability reflects that a vector driver includes the sign
564 : * in the field width of fields of type OFTReal.
565 : *
566 : * See GDAL_DMD_NUMERIC_FIELD_WIDTH_INCLUDES_DECIMAL_SEPARATOR for a related capability flag.
567 : * @since GDAL 3.7
568 : */
569 : #define GDAL_DMD_NUMERIC_FIELD_WIDTH_INCLUDES_SIGN \
570 : "DMD_NUMERIC_FIELD_WIDTH_INCLUDES_SIGN"
571 :
572 : /** Capability set by a driver that implements the Open() API. */
573 : #define GDAL_DCAP_OPEN "DCAP_OPEN"
574 :
575 : /** Capability set by a driver that implements the Create() API.
576 : *
577 : * If GDAL_DCAP_CREATE is set, but GDAL_DCAP_CREATECOPY not, a generic
578 : * CreateCopy() implementation is available and will use the Create() API of
579 : * the driver.
580 : * So to test if some CreateCopy() implementation is available, generic or
581 : * specialize, test for both GDAL_DCAP_CREATE and GDAL_DCAP_CREATECOPY.
582 : */
583 : #define GDAL_DCAP_CREATE "DCAP_CREATE"
584 :
585 : /** Capability set by a driver that implements the CreateMultiDimensional() API.
586 : *
587 : * @since GDAL 3.1
588 : */
589 : #define GDAL_DCAP_CREATE_MULTIDIMENSIONAL "DCAP_CREATE_MULTIDIMENSIONAL"
590 :
591 : /** Capability set by a driver that implements the CreateCopy() API.
592 : *
593 : * If GDAL_DCAP_CREATECOPY is not defined, but GDAL_DCAP_CREATE is set, a
594 : * generic CreateCopy() implementation is available and will use the Create()
595 : * API of the driver. So to test if some CreateCopy() implementation is
596 : * available, generic or specialize, test for both GDAL_DCAP_CREATE and
597 : * GDAL_DCAP_CREATECOPY.
598 : */
599 : #define GDAL_DCAP_CREATECOPY "DCAP_CREATECOPY"
600 :
601 : /** Capability set by a driver that supports the \@CREATE_ONLY_VISIBLE_AT_CLOSE_TIME
602 : * hidden creation option.
603 : *
604 : * @since GDAL 3.12
605 : */
606 : #define GDAL_DCAP_CREATE_ONLY_VISIBLE_AT_CLOSE_TIME \
607 : "DCAP_CREATE_ONLY_VISIBLE_AT_CLOSE_TIME"
608 :
609 : /** Capability set by a driver that implements the VectorTranslateFrom() API.
610 : *
611 : * @since GDAL 3.8
612 : */
613 : #define GDAL_DCAP_VECTOR_TRANSLATE_FROM "DCAP_VECTOR_TRANSLATE_FROM"
614 :
615 : /** Capability set by a driver that implements the CreateCopy() API, but with
616 : * multidimensional raster as input and output.
617 : *
618 : * @since GDAL 3.1
619 : */
620 : #define GDAL_DCAP_CREATECOPY_MULTIDIMENSIONAL "DCAP_CREATECOPY_MULTIDIMENSIONAL"
621 :
622 : /** Capability set by a driver that supports multidimensional data.
623 : * @since GDAL 3.1
624 : */
625 : #define GDAL_DCAP_MULTIDIM_RASTER "DCAP_MULTIDIM_RASTER"
626 :
627 : /** Capability set by a driver that can copy over subdatasets. */
628 : #define GDAL_DCAP_SUBCREATECOPY "DCAP_SUBCREATECOPY"
629 :
630 : /** Capability set by a driver that supports the GDAL_OF_UPDATE flag and offers
631 : * feature appending capabilities.
632 : *
633 : * Note: feature appending capability is also implied if GDAL_DCAP_UPDATE or
634 : * GDAL_DCAP_CREATE_LAYER is set, in which case GDAL_DCAP_APPEND is not set.
635 : *
636 : * @since GDAL 3.12.
637 : */
638 : #define GDAL_DCAP_APPEND "DCAP_APPEND"
639 :
640 : /** Capability set by a driver that supports the GDAL_OF_UPDATE flag and offers
641 : * at least some update capabilities.
642 : * Exact update capabilities can be determined by the GDAL_DMD_UPDATE_ITEMS
643 : * metadata item
644 : * @since GDAL 3.11
645 : */
646 : #define GDAL_DCAP_UPDATE "DCAP_UPDATE"
647 :
648 : /** Capability set by a driver that can read/create datasets through the VSI*L
649 : * API. */
650 : #define GDAL_DCAP_VIRTUALIO "DCAP_VIRTUALIO"
651 :
652 : /** Capability set by a driver having raster capability.
653 : */
654 : #define GDAL_DCAP_RASTER "DCAP_RASTER"
655 :
656 : /** Capability set by a driver having vector capability.
657 : */
658 : #define GDAL_DCAP_VECTOR "DCAP_VECTOR"
659 :
660 : /** Capability set by a driver having geographical network model capability.
661 : */
662 : #define GDAL_DCAP_GNM "DCAP_GNM"
663 :
664 : /** Capability set by a driver that can create layers.
665 : * @since GDAL 3.6
666 : */
667 : #define GDAL_DCAP_CREATE_LAYER "DCAP_CREATE_LAYER"
668 :
669 : /** Capability set by a driver that can delete layers.
670 : * @since GDAL 3.6
671 : */
672 : #define GDAL_DCAP_DELETE_LAYER "DCAP_DELETE_LAYER"
673 :
674 : /** Capability set by a driver that can create fields.
675 : * @since GDAL 3.6
676 : */
677 : #define GDAL_DCAP_CREATE_FIELD "DCAP_CREATE_FIELD"
678 :
679 : /** Capability set by a driver that can delete fields.
680 : * @since GDAL 3.6
681 : */
682 : #define GDAL_DCAP_DELETE_FIELD "DCAP_DELETE_FIELD"
683 :
684 : /** Capability set by a driver that can reorder fields.
685 : * @since GDAL 3.6
686 : */
687 : #define GDAL_DCAP_REORDER_FIELDS "DCAP_REORDER_FIELDS"
688 :
689 : /** List of (space separated) flags supported by the OGRLayer::AlterFieldDefn()
690 : * API.
691 : *
692 : * Supported values are "Name", "Type", "WidthPrecision", "Nullable", "Default",
693 : * "Unique", "Domain", "AlternativeName" and "Comment", corresponding respectively
694 : * to the ALTER_NAME_FLAG, ALTER_TYPE_FLAG, ALTER_WIDTH_PRECISION_FLAG, ALTER_NULLABLE_FLAG,
695 : * ALTER_DEFAULT_FLAG, ALTER_UNIQUE_FLAG, ALTER_DOMAIN_FLAG,
696 : * ALTER_ALTERNATIVE_NAME_FLAG and ALTER_COMMENT_FLAG flags.
697 : *
698 : * Note that advertizing one of these flags doesn't necessarily mean that
699 : * all modifications of the corresponding property can be made. For example,
700 : * altering the field type may be restricted by the current type of the field,
701 : * etc.
702 : *
703 : * @see GDAL_DMD_CREATION_FIELD_DEFN_FLAGS for capabilities supported
704 : * when creating new fields.
705 : *
706 : * @since GDAL 3.6
707 : */
708 : #define GDAL_DMD_ALTER_FIELD_DEFN_FLAGS "GDAL_DMD_ALTER_FIELD_DEFN_FLAGS"
709 :
710 : /** List of (space separated) field names which are considered illegal by the
711 : * driver and should not be used when creating/altering fields.
712 : *
713 : * @since GDAL 3.7
714 : */
715 : #define GDAL_DMD_ILLEGAL_FIELD_NAMES "GDAL_DMD_ILLEGAL_FIELD_NAMES"
716 :
717 : /** Capability set by a driver that can create fields with NOT NULL constraint.
718 : */
719 : #define GDAL_DCAP_NOTNULL_FIELDS "DCAP_NOTNULL_FIELDS"
720 :
721 : /** Capability set by a driver that can create fields with UNIQUE constraint.
722 : * @since GDAL 3.2
723 : */
724 : #define GDAL_DCAP_UNIQUE_FIELDS "DCAP_UNIQUE_FIELDS"
725 :
726 : /** Capability set by a driver that can create fields with DEFAULT values.
727 : */
728 : #define GDAL_DCAP_DEFAULT_FIELDS "DCAP_DEFAULT_FIELDS"
729 :
730 : /** Capability set by a driver that can create geometry fields with NOT NULL
731 : * constraint.
732 : */
733 : #define GDAL_DCAP_NOTNULL_GEOMFIELDS "DCAP_NOTNULL_GEOMFIELDS"
734 :
735 : /** Capability set by a non-spatial driver having no support for geometries.
736 : * E.g. non-spatial vector drivers (e.g. spreadsheet format drivers) do not
737 : * support geometries, and accordingly will have this capability present.
738 : */
739 : #define GDAL_DCAP_NONSPATIAL "DCAP_NONSPATIAL"
740 :
741 : /** Capability set by a driver that can support curved geometries.
742 : * @since GDAL 3.6
743 : */
744 : #define GDAL_DCAP_CURVE_GEOMETRIES "DCAP_CURVE_GEOMETRIES"
745 :
746 : /** Capability set by a driver that can support measured geometries.
747 : *
748 : * @since GDAL 3.6
749 : */
750 : #define GDAL_DCAP_MEASURED_GEOMETRIES "DCAP_MEASURED_GEOMETRIES"
751 :
752 : /** Capability set by a driver that can support the Z dimension for geometries.
753 : *
754 : * @since GDAL 3.6
755 : */
756 : #define GDAL_DCAP_Z_GEOMETRIES "DCAP_Z_GEOMETRIES"
757 :
758 : /** List of (space separated) flags which reflect the geometry handling behavior
759 : * of a driver.
760 : *
761 : * Supported values are currently:
762 : *
763 : * - "EquatesMultiAndSingleLineStringDuringWrite" and
764 : * "EquatesMultiAndSinglePolygonDuringWrite". These flags indicate that the
765 : * driver does not differentiate between single-part and multi-part linestring
766 : * and polygon geometries when writing features respectively.
767 : *
768 : * @since GDAL 3.6
769 : */
770 : #define GDAL_DMD_GEOMETRY_FLAGS "GDAL_DMD_GEOMETRY_FLAGS"
771 :
772 : /** Capability set by drivers which support either reading or writing feature
773 : * styles.
774 : *
775 : * Consider using the more granular GDAL_DCAP_FEATURE_STYLES_READ or
776 : * GDAL_DCAP_FEATURE_STYLES_WRITE capabilities instead.
777 : *
778 : */
779 : #define GDAL_DCAP_FEATURE_STYLES "DCAP_FEATURE_STYLES"
780 :
781 : /** Capability set by drivers which support reading feature styles.
782 : * @since GDAL 3.7
783 : */
784 : #define GDAL_DCAP_FEATURE_STYLES_READ "DCAP_FEATURE_STYLES_READ"
785 :
786 : /** Capability set by drivers which support writing feature styles.
787 : * @since GDAL 3.7
788 : */
789 : #define GDAL_DCAP_FEATURE_STYLES_WRITE "DCAP_FEATURE_STYLES_WRITE"
790 :
791 : /** Capability set by drivers which support storing/retrieving coordinate epoch
792 : * for dynamic CRS
793 : * @since GDAL 3.4
794 : */
795 : #define GDAL_DCAP_COORDINATE_EPOCH "DCAP_COORDINATE_EPOCH"
796 :
797 : /** Capability set by drivers for formats which support multiple vector layers.
798 : *
799 : * Note: some GDAL drivers expose "virtual" layer support while the underlying
800 : * formats themselves do not. This capability is only set for drivers of formats
801 : * which have a native concept of multiple vector layers (such as GeoPackage).
802 : *
803 : * @since GDAL 3.4
804 : */
805 : #define GDAL_DCAP_MULTIPLE_VECTOR_LAYERS "DCAP_MULTIPLE_VECTOR_LAYERS"
806 :
807 : /** Capability set by drivers for formats which support reading field domains.
808 : *
809 : * @since GDAL 3.5
810 : */
811 : #define GDAL_DCAP_FIELD_DOMAINS "DCAP_FIELD_DOMAINS"
812 :
813 : /** Capability set by drivers for formats which support reading table
814 : * relationships.
815 : *
816 : * @since GDAL 3.6
817 : */
818 : #define GDAL_DCAP_RELATIONSHIPS "DCAP_RELATIONSHIPS"
819 :
820 : /** Capability set by drivers for formats which support creating table
821 : * relationships.
822 : * @since GDAL 3.6
823 : */
824 : #define GDAL_DCAP_CREATE_RELATIONSHIP "DCAP_CREATE_RELATIONSHIP"
825 :
826 : /** Capability set by drivers for formats which support deleting table
827 : * relationships.
828 : * @since GDAL 3.6
829 : */
830 : #define GDAL_DCAP_DELETE_RELATIONSHIP "DCAP_DELETE_RELATIONSHIP"
831 :
832 : /** Capability set by drivers for formats which support updating existing table
833 : * relationships.
834 : * @since GDAL 3.6
835 : */
836 : #define GDAL_DCAP_UPDATE_RELATIONSHIP "DCAP_UPDATE_RELATIONSHIP"
837 :
838 : /** Capability set by drivers whose FlushCache() implementation returns a
839 : * dataset that can be opened afterwards and seen in a consistent state, without
840 : * requiring the dataset on which FlushCache() has been called to be closed.
841 : * @since GDAL 3.8
842 : */
843 : #define GDAL_DCAP_FLUSHCACHE_CONSISTENT_STATE "DCAP_FLUSHCACHE_CONSISTENT_STATE"
844 :
845 : /** Capability set by drivers which honor the OGRCoordinatePrecision settings
846 : * of geometry fields at layer creation and/or for OGRLayer::CreateGeomField().
847 : * Note that while those drivers honor the settings at feature writing time,
848 : * they might not be able to store the precision settings in layer metadata,
849 : * hence on reading it might not be possible to recover the precision with
850 : * which coordinates have been written.
851 : * @since GDAL 3.9
852 : */
853 : #define GDAL_DCAP_HONOR_GEOM_COORDINATE_PRECISION \
854 : "DCAP_HONOR_GEOM_COORDINATE_PRECISION"
855 :
856 : /** Capability set by drivers that implements OGRLayer::UpsertTeature().
857 : * @since GDAL 3.12
858 : */
859 : #define GDAL_DCAP_UPSERT "DCAP_UPSERT"
860 :
861 : /** List of (space separated) flags indicating the features of relationships are
862 : * supported by the driver.
863 : *
864 : * Supported values are:
865 : *
866 : * - "OneToOne": supports one-to-one relationships, see
867 : * GDALRelationshipCardinality::GRC_ONE_TO_ONE
868 : * - "OneToMany": supports one-to-many relationships, see
869 : * GDALRelationshipCardinality::GRC_ONE_TO_MANY
870 : * - "ManyToOne": supports many-to-one relationships, see
871 : * GDALRelationshipCardinality::GRC_MANY_TO_ONE
872 : * - "ManyToMany": supports many-to-many relationships, see
873 : * GDALRelationshipCardinality::GRC_MANY_TO_MANY
874 : * - "Composite": supports composite relationship types, see
875 : * GDALRelationshipType::GRT_COMPOSITE
876 : * - "Association": supports association relationship types, see
877 : * GDALRelationshipType::GRT_ASSOCIATION
878 : * - "Aggregation": supports aggregation relationship types, see
879 : * GDALRelationshipType::GRT_AGGREGATION
880 : * - "MultipleFieldKeys": multiple fields can be used for relationship keys. If
881 : * not present then only a single field name can be used.
882 : * - "ForwardPathLabel": supports forward path labels
883 : * - "BackwardPathLabel": supports backward path labels
884 : *
885 : * @since GDAL 3.6
886 : */
887 : #define GDAL_DMD_RELATIONSHIP_FLAGS "GDAL_DMD_RELATIONSHIP_FLAGS"
888 :
889 : /** List of (space separated) standard related table types which are recognised
890 : * by the driver.
891 : *
892 : * See GDALRelationshipGetRelatedTableType/GDALRelationshipSetRelatedTableType
893 : *
894 : * @since GDAL 3.7
895 : */
896 : #define GDAL_DMD_RELATIONSHIP_RELATED_TABLE_TYPES \
897 : "GDAL_DMD_RELATIONSHIP_RELATED_TABLE_TYPES"
898 :
899 : /** Capability set by drivers for formats which support renaming vector layers.
900 : *
901 : * @since GDAL 3.5
902 : */
903 : #define GDAL_DCAP_RENAME_LAYERS "DCAP_RENAME_LAYERS"
904 :
905 : /** List of (space separated) field domain types supported by the AddFieldDomain()
906 : * API.
907 : *
908 : * Supported values are Coded, Range and Glob, corresponding to the
909 : * OGRFieldDomainType::OFDT_CODED, OGRFieldDomainType::OFDT_RANGE, and
910 : * OGRFieldDomainType::OFDT_GLOB field domain types respectively.
911 : *
912 : * @since GDAL 3.5
913 : */
914 : #define GDAL_DMD_CREATION_FIELD_DOMAIN_TYPES "DMD_CREATION_FIELD_DOMAIN_TYPES"
915 :
916 : /** List of (space separated) flags supported by the
917 : * OGRLayer::AlterGeomFieldDefn() API.
918 : *
919 : * Supported values are "Name", "Type", "Nullable", "SRS", "CoordinateEpoch",
920 : * corresponding respectively to the ALTER_GEOM_FIELD_DEFN_NAME_FLAG,
921 : * ALTER_GEOM_FIELD_DEFN_TYPE_FLAG, ALTER_GEOM_FIELD_DEFN_NULLABLE_FLAG,
922 : * ALTER_GEOM_FIELD_DEFN_SRS_FLAG, ALTER_GEOM_FIELD_DEFN_SRS_COORD_EPOCH_FLAG
923 : * flags. Note that advertizing one of these flags doesn't necessarily mean that
924 : * all modifications of the corresponding property can be made. For example,
925 : * altering the geometry type may be restricted by the type of the geometries in
926 : * the field, or changing the nullable state to non-nullable is not possible if
927 : * null geometries are present, etc.
928 : *
929 : * @since GDAL 3.6
930 : */
931 : #define GDAL_DMD_ALTER_GEOM_FIELD_DEFN_FLAGS "DMD_ALTER_GEOM_FIELD_DEFN_FLAGS"
932 :
933 : /** List of (space separated) SQL dialects supported by the driver.
934 : *
935 : * The default SQL dialect for the driver will always be the first listed value.
936 : *
937 : * Standard values are:
938 : *
939 : * - "OGRSQL": the OGR SQL dialect, see
940 : * https://gdal.org/user/ogr_sql_dialect.html
941 : * - "SQLITE": the SQLite dialect, see
942 : * https://gdal.org/user/sql_sqlite_dialect.html
943 : * - "NATIVE": for drivers with an RDBMS backend this value indicates that the
944 : * SQL will be passed directly to that database backend, and therefore the
945 : * RDBMS' native dialect will be used
946 : *
947 : * Other dialect values may also be present for some drivers (for some of them,
948 : * the query string to use might not even by SQL but a dedicated query
949 : * language). For further details on their interpretation, see the documentation
950 : * for the respective driver.
951 : *
952 : * @since GDAL 3.6
953 : */
954 : #define GDAL_DMD_SUPPORTED_SQL_DIALECTS "DMD_SUPPORTED_SQL_DIALECTS"
955 :
956 : /*! @cond Doxygen_Suppress */
957 : #define GDAL_DMD_PLUGIN_INSTALLATION_MESSAGE "DMD_PLUGIN_INSTALLATION_MESSAGE"
958 : /*! @endcond */
959 :
960 : /** List of (space separated) items that a dataset opened in update mode supports
961 : * updating. Possible values are:
962 : * - for raster: "GeoTransform" (through GDALDataset::SetGeoTransform),
963 : * "SRS" (GDALDataset::SetSpatialRef), "GCPs" (GDALDataset::SetGCPs()),
964 : * "NoData" (GDALRasterBand::SetNoDataValue),
965 : * "ColorInterpretation" (GDALRasterBand::SetColorInterpretation()),
966 : * "RasterValues" (GF_Write flag of GDALDataset::RasterIO() and GDALRasterBand::RasterIO()),
967 : * "DatasetMetadata" (GDALDataset::SetMetadata/SetMetadataItem), "BandMetadata"
968 : * (GDALRasterBand::SetMetadata/SetMetadataItem)
969 : * - for vector: "Features" (OGRLayer::SetFeature()), "DatasetMetadata",
970 : * "LayerMetadata"
971 : *
972 : * No distinction is made if the update is done in the native format,
973 : * or in a Persistent Auxiliary Metadata .aux.xml side car file.
974 : *
975 : * @since GDAL 3.11
976 : */
977 : #define GDAL_DMD_UPDATE_ITEMS "DMD_UPDATE_ITEMS"
978 :
979 : /** Value for GDALDimension::GetType() specifying the X axis of a horizontal
980 : * CRS.
981 : * @since GDAL 3.1
982 : */
983 : #define GDAL_DIM_TYPE_HORIZONTAL_X "HORIZONTAL_X"
984 :
985 : /** Value for GDALDimension::GetType() specifying the Y axis of a horizontal
986 : * CRS.
987 : * @since GDAL 3.1
988 : */
989 : #define GDAL_DIM_TYPE_HORIZONTAL_Y "HORIZONTAL_Y"
990 :
991 : /** Value for GDALDimension::GetType() specifying a vertical axis.
992 : * @since GDAL 3.1
993 : */
994 : #define GDAL_DIM_TYPE_VERTICAL "VERTICAL"
995 :
996 : /** Value for GDALDimension::GetType() specifying a temporal axis.
997 : * @since GDAL 3.1
998 : */
999 : #define GDAL_DIM_TYPE_TEMPORAL "TEMPORAL"
1000 :
1001 : /** Value for GDALDimension::GetType() specifying a parametric axis.
1002 : * @since GDAL 3.1
1003 : */
1004 : #define GDAL_DIM_TYPE_PARAMETRIC "PARAMETRIC"
1005 :
1006 : /** "Capability" set by drivers that require re-opening the dataset to be able
1007 : * to read its content if it has just been created previously
1008 : *
1009 : * @since GDAL 3.12
1010 : */
1011 : #define GDAL_DCAP_REOPEN_AFTER_WRITE_REQUIRED "DCAP_REOPEN_AFTER_WRITE_REQUIRED"
1012 :
1013 : /** Capability set by drivers that can read from a dataset, even if it deleted
1014 : * from disk after it has been opened (i.e. such drivers do not need to reopen
1015 : * or test the existence of the file at that point)
1016 : *
1017 : * @since GDAL 3.12
1018 : */
1019 : #define GDAL_DCAP_CAN_READ_AFTER_DELETE "DCAP_CAN_READ_AFTER_DELETE"
1020 :
1021 : #define GDsCAddRelationship \
1022 : "AddRelationship" /**< Dataset capability for supporting AddRelationship() \
1023 : (at least partially) */
1024 : #define GDsCDeleteRelationship \
1025 : "DeleteRelationship" /**< Dataset capability for supporting \
1026 : DeleteRelationship()*/
1027 : #define GDsCUpdateRelationship \
1028 : "UpdateRelationship" /**< Dataset capability for supporting \
1029 : UpdateRelationship()*/
1030 :
1031 : /** Dataset capability if GDALDataset::GetExtent() is fast.
1032 : *
1033 : * @since 3.12
1034 : */
1035 : #define GDsCFastGetExtent "FastGetExtent"
1036 :
1037 : /** Dataset capability if GDALDataset::GetExtentWGS84LongLat() is fast.
1038 : *
1039 : * @since 3.12
1040 : */
1041 : #define GDsCFastGetExtentWGS84LongLat "FastGetExtentWGS84LongLat"
1042 :
1043 : void CPL_DLL CPL_STDCALL GDALAllRegister(void);
1044 : void CPL_DLL GDALRegisterPlugins(void);
1045 : CPLErr CPL_DLL GDALRegisterPlugin(const char *name);
1046 :
1047 : GDALDatasetH CPL_DLL CPL_STDCALL
1048 : GDALCreate(GDALDriverH hDriver, const char *, int, int, int, GDALDataType,
1049 : CSLConstList) CPL_WARN_UNUSED_RESULT;
1050 : GDALDatasetH CPL_DLL CPL_STDCALL GDALCreateCopy(GDALDriverH, const char *,
1051 : GDALDatasetH, int, CSLConstList,
1052 : GDALProgressFunc,
1053 : void *) CPL_WARN_UNUSED_RESULT;
1054 :
1055 : GDALDriverH CPL_DLL CPL_STDCALL GDALIdentifyDriver(const char *pszFilename,
1056 : CSLConstList papszFileList);
1057 :
1058 : GDALDriverH CPL_DLL CPL_STDCALL GDALIdentifyDriverEx(
1059 : const char *pszFilename, unsigned int nIdentifyFlags,
1060 : const char *const *papszAllowedDrivers, const char *const *papszFileList);
1061 :
1062 : GDALDatasetH CPL_DLL CPL_STDCALL
1063 : GDALOpen(const char *pszFilename, GDALAccess eAccess) CPL_WARN_UNUSED_RESULT;
1064 : GDALDatasetH CPL_DLL CPL_STDCALL GDALOpenShared(const char *, GDALAccess)
1065 : CPL_WARN_UNUSED_RESULT;
1066 :
1067 : /* Note: we define GDAL_OF_READONLY and GDAL_OF_UPDATE to be on purpose */
1068 : /* equals to GA_ReadOnly and GA_Update */
1069 :
1070 : /** Open in read-only mode.
1071 : * Used by GDALOpenEx().
1072 : */
1073 : #define GDAL_OF_READONLY 0x00
1074 :
1075 : /** Open in update mode.
1076 : * Used by GDALOpenEx().
1077 : */
1078 : #define GDAL_OF_UPDATE 0x01
1079 :
1080 : /** Allow raster and vector drivers to be used.
1081 : * Used by GDALOpenEx().
1082 : */
1083 : #define GDAL_OF_ALL 0x00
1084 :
1085 : /** Allow raster drivers to be used.
1086 : * Used by GDALOpenEx().
1087 : */
1088 : #define GDAL_OF_RASTER 0x02
1089 :
1090 : /** Allow vector drivers to be used.
1091 : * Used by GDALOpenEx().
1092 : */
1093 : #define GDAL_OF_VECTOR 0x04
1094 :
1095 : /** Allow gnm drivers to be used.
1096 : * Used by GDALOpenEx().
1097 : */
1098 : #define GDAL_OF_GNM 0x08
1099 :
1100 : /** Allow multidimensional raster drivers to be used.
1101 : * Used by GDALOpenEx().
1102 : * @since GDAL 3.1
1103 : */
1104 : #define GDAL_OF_MULTIDIM_RASTER 0x10
1105 :
1106 : #ifndef DOXYGEN_SKIP
1107 : #define GDAL_OF_KIND_MASK 0x1E
1108 : #endif
1109 :
1110 : /** Open in shared mode.
1111 : * Used by GDALOpenEx().
1112 : */
1113 : #define GDAL_OF_SHARED 0x20
1114 :
1115 : /** Emit error message in case of failed open.
1116 : * Used by GDALOpenEx().
1117 : */
1118 : #define GDAL_OF_VERBOSE_ERROR 0x40
1119 :
1120 : /** Open as internal dataset. Such dataset isn't registered in the global list
1121 : * of opened dataset. Cannot be used with GDAL_OF_SHARED.
1122 : *
1123 : * Used by GDALOpenEx().
1124 : */
1125 : #define GDAL_OF_INTERNAL 0x80
1126 :
1127 : /** Let GDAL decide if a array-based or hashset-based storage strategy for
1128 : * cached blocks must be used.
1129 : *
1130 : * GDAL_OF_DEFAULT_BLOCK_ACCESS, GDAL_OF_ARRAY_BLOCK_ACCESS and
1131 : * GDAL_OF_HASHSET_BLOCK_ACCESS are mutually exclusive.
1132 : *
1133 : * Used by GDALOpenEx().
1134 : */
1135 : #define GDAL_OF_DEFAULT_BLOCK_ACCESS 0
1136 :
1137 : /** Use a array-based storage strategy for cached blocks.
1138 : *
1139 : * GDAL_OF_DEFAULT_BLOCK_ACCESS, GDAL_OF_ARRAY_BLOCK_ACCESS and
1140 : * GDAL_OF_HASHSET_BLOCK_ACCESS are mutually exclusive.
1141 : *
1142 : * Used by GDALOpenEx().
1143 : */
1144 : #define GDAL_OF_ARRAY_BLOCK_ACCESS 0x100
1145 :
1146 : /** Use a hashset-based storage strategy for cached blocks.
1147 : *
1148 : * GDAL_OF_DEFAULT_BLOCK_ACCESS, GDAL_OF_ARRAY_BLOCK_ACCESS and
1149 : * GDAL_OF_HASHSET_BLOCK_ACCESS are mutually exclusive.
1150 : *
1151 : * Used by GDALOpenEx().
1152 : */
1153 : #define GDAL_OF_HASHSET_BLOCK_ACCESS 0x200
1154 :
1155 : #ifndef DOXYGEN_SKIP
1156 : /* Reserved for a potential future alternative to GDAL_OF_ARRAY_BLOCK_ACCESS
1157 : * and GDAL_OF_HASHSET_BLOCK_ACCESS */
1158 : #define GDAL_OF_RESERVED_1 0x300
1159 :
1160 : /** Mask to detect the block access method */
1161 : #define GDAL_OF_BLOCK_ACCESS_MASK 0x300
1162 : #endif
1163 :
1164 : #ifndef DOXYGEN_SKIP
1165 : /** Set by GDALOpenEx() to indicate to Identify() method that they are called
1166 : * from it */
1167 : #define GDAL_OF_FROM_GDALOPEN 0x400
1168 : #endif
1169 :
1170 : /** Open in thread-safe mode. Not compatible with
1171 : * GDAL_OF_VECTOR, GDAL_OF_MULTIDIM_RASTER or GDAL_OF_UPDATE
1172 : *
1173 : * Used by GDALOpenEx().
1174 : * @since GDAL 3.10
1175 : */
1176 : #define GDAL_OF_THREAD_SAFE 0x800
1177 :
1178 : GDALDatasetH CPL_DLL CPL_STDCALL GDALOpenEx(
1179 : const char *pszFilename, unsigned int nOpenFlags,
1180 : const char *const *papszAllowedDrivers, const char *const *papszOpenOptions,
1181 : const char *const *papszSiblingFiles) CPL_WARN_UNUSED_RESULT;
1182 :
1183 : int CPL_DLL CPL_STDCALL GDALDumpOpenDatasets(FILE *);
1184 :
1185 : GDALDriverH CPL_DLL CPL_STDCALL GDALGetDriverByName(const char *);
1186 : int CPL_DLL CPL_STDCALL GDALGetDriverCount(void);
1187 : GDALDriverH CPL_DLL CPL_STDCALL GDALGetDriver(int);
1188 : GDALDriverH CPL_DLL CPL_STDCALL GDALCreateDriver(void);
1189 : void CPL_DLL CPL_STDCALL GDALDestroyDriver(GDALDriverH);
1190 : int CPL_DLL CPL_STDCALL GDALRegisterDriver(GDALDriverH);
1191 : void CPL_DLL CPL_STDCALL GDALDeregisterDriver(GDALDriverH);
1192 : void CPL_DLL CPL_STDCALL GDALDestroyDriverManager(void);
1193 : void CPL_DLL GDALDestroy(void);
1194 : CPLErr CPL_DLL CPL_STDCALL GDALDeleteDataset(GDALDriverH, const char *);
1195 : CPLErr CPL_DLL CPL_STDCALL GDALRenameDataset(GDALDriverH,
1196 : const char *pszNewName,
1197 : const char *pszOldName);
1198 : CPLErr CPL_DLL CPL_STDCALL GDALCopyDatasetFiles(GDALDriverH,
1199 : const char *pszNewName,
1200 : const char *pszOldName);
1201 : int CPL_DLL CPL_STDCALL
1202 : GDALValidateCreationOptions(GDALDriverH, CSLConstList papszCreationOptions);
1203 : char CPL_DLL **GDALGetOutputDriversForDatasetName(const char *pszDestFilename,
1204 : int nFlagRasterVector,
1205 : bool bSingleMatch,
1206 : bool bEmitWarning);
1207 :
1208 : bool CPL_DLL GDALDriverHasOpenOption(GDALDriverH,
1209 : const char *pszOpenOptionName);
1210 :
1211 : /* The following are deprecated */
1212 : const char CPL_DLL *CPL_STDCALL GDALGetDriverShortName(GDALDriverH);
1213 : const char CPL_DLL *CPL_STDCALL GDALGetDriverLongName(GDALDriverH);
1214 : const char CPL_DLL *CPL_STDCALL GDALGetDriverHelpTopic(GDALDriverH);
1215 : const char CPL_DLL *CPL_STDCALL GDALGetDriverCreationOptionList(GDALDriverH);
1216 :
1217 : /* ==================================================================== */
1218 : /* GDAL_GCP */
1219 : /* ==================================================================== */
1220 :
1221 : /** Ground Control Point */
1222 : typedef struct
1223 : {
1224 : /** Unique identifier, often numeric */
1225 : char *pszId;
1226 :
1227 : /** Informational message or "" */
1228 : char *pszInfo;
1229 :
1230 : /** Pixel (x) location of GCP on raster */
1231 : double dfGCPPixel;
1232 : /** Line (y) location of GCP on raster */
1233 : double dfGCPLine;
1234 :
1235 : /** X position of GCP in georeferenced space */
1236 : double dfGCPX;
1237 :
1238 : /** Y position of GCP in georeferenced space */
1239 : double dfGCPY;
1240 :
1241 : /** Elevation of GCP, or zero if not known */
1242 : double dfGCPZ;
1243 : } GDAL_GCP;
1244 :
1245 : void CPL_DLL CPL_STDCALL GDALInitGCPs(int, GDAL_GCP *);
1246 : void CPL_DLL CPL_STDCALL GDALDeinitGCPs(int, GDAL_GCP *);
1247 : GDAL_GCP CPL_DLL *CPL_STDCALL GDALDuplicateGCPs(int, const GDAL_GCP *);
1248 :
1249 : int CPL_DLL CPL_STDCALL GDALGCPsToGeoTransform(
1250 : int nGCPCount, const GDAL_GCP *pasGCPs, double *padfGeoTransform,
1251 : int bApproxOK) CPL_WARN_UNUSED_RESULT;
1252 : int CPL_DLL CPL_STDCALL GDALInvGeoTransform(const double *padfGeoTransformIn,
1253 : double *padfInvGeoTransformOut)
1254 : CPL_WARN_UNUSED_RESULT;
1255 : void CPL_DLL CPL_STDCALL GDALApplyGeoTransform(const double *, double, double,
1256 : double *, double *);
1257 : void CPL_DLL GDALComposeGeoTransforms(const double *padfGeoTransform1,
1258 : const double *padfGeoTransform2,
1259 : double *padfGeoTransformOut);
1260 : int CPL_DLL GDALGCPsToHomography(int nGCPCount, const GDAL_GCP *pasGCPs,
1261 : double *padfHomography) CPL_WARN_UNUSED_RESULT;
1262 : int CPL_DLL GDALInvHomography(const double *padfHomographyIn,
1263 : double *padfInvHomographyOut)
1264 : CPL_WARN_UNUSED_RESULT;
1265 : int CPL_DLL GDALApplyHomography(const double *, double, double, double *,
1266 : double *) CPL_WARN_UNUSED_RESULT;
1267 : void CPL_DLL GDALComposeHomographies(const double *padfHomography1,
1268 : const double *padfHomography2,
1269 : double *padfHomographyOut);
1270 :
1271 : /* ==================================================================== */
1272 : /* major objects (dataset, and, driver, drivermanager). */
1273 : /* ==================================================================== */
1274 :
1275 : char CPL_DLL **CPL_STDCALL GDALGetMetadataDomainList(GDALMajorObjectH hObject);
1276 : char CPL_DLL **CPL_STDCALL GDALGetMetadata(GDALMajorObjectH, const char *);
1277 : CPLErr CPL_DLL CPL_STDCALL GDALSetMetadata(GDALMajorObjectH, CSLConstList,
1278 : const char *);
1279 : const char CPL_DLL *CPL_STDCALL GDALGetMetadataItem(GDALMajorObjectH,
1280 : const char *, const char *);
1281 : CPLErr CPL_DLL CPL_STDCALL GDALSetMetadataItem(GDALMajorObjectH, const char *,
1282 : const char *, const char *);
1283 : const char CPL_DLL *CPL_STDCALL GDALGetDescription(GDALMajorObjectH);
1284 : void CPL_DLL CPL_STDCALL GDALSetDescription(GDALMajorObjectH, const char *);
1285 :
1286 : /* ==================================================================== */
1287 : /* GDALDataset class ... normally this represents one file. */
1288 : /* ==================================================================== */
1289 :
1290 : /** Name of driver metadata item for layer creation option list */
1291 : #define GDAL_DS_LAYER_CREATIONOPTIONLIST "DS_LAYER_CREATIONOPTIONLIST"
1292 :
1293 : GDALDriverH CPL_DLL CPL_STDCALL GDALGetDatasetDriver(GDALDatasetH);
1294 : char CPL_DLL **CPL_STDCALL GDALGetFileList(GDALDatasetH);
1295 : void CPL_DLL GDALDatasetMarkSuppressOnClose(GDALDatasetH);
1296 : CPLErr CPL_DLL CPL_STDCALL GDALClose(GDALDatasetH);
1297 : CPLErr CPL_DLL GDALCloseEx(GDALDatasetH hDS, GDALProgressFunc pfnProgress,
1298 : void *pProgressData);
1299 : bool CPL_DLL GDALDatasetGetCloseReportsProgress(GDALDatasetH hDS);
1300 : CPLErr CPL_DLL GDALDatasetRunCloseWithoutDestroying(GDALDatasetH hDS);
1301 : CPLErr CPL_DLL GDALDatasetRunCloseWithoutDestroyingEx(
1302 : GDALDatasetH hDS, GDALProgressFunc pfnProgress, void *pProgressData);
1303 : int CPL_DLL CPL_STDCALL GDALGetRasterXSize(GDALDatasetH);
1304 : int CPL_DLL CPL_STDCALL GDALGetRasterYSize(GDALDatasetH);
1305 : int CPL_DLL CPL_STDCALL GDALGetRasterCount(GDALDatasetH);
1306 : GDALRasterBandH CPL_DLL CPL_STDCALL GDALGetRasterBand(GDALDatasetH, int);
1307 :
1308 : bool CPL_DLL GDALDatasetIsThreadSafe(GDALDatasetH, int nScopeFlags,
1309 : CSLConstList papszOptions);
1310 : GDALDatasetH CPL_DLL GDALGetThreadSafeDataset(GDALDatasetH, int nScopeFlags,
1311 : CSLConstList papszOptions);
1312 :
1313 : CPLErr CPL_DLL CPL_STDCALL GDALAddBand(GDALDatasetH hDS, GDALDataType eType,
1314 : CSLConstList papszOptions);
1315 :
1316 : GDALAsyncReaderH CPL_DLL CPL_STDCALL GDALBeginAsyncReader(
1317 : GDALDatasetH hDS, int nXOff, int nYOff, int nXSize, int nYSize, void *pBuf,
1318 : int nBufXSize, int nBufYSize, GDALDataType eBufType, int nBandCount,
1319 : int *panBandMap, int nPixelSpace, int nLineSpace, int nBandSpace,
1320 : CSLConstList papszOptions) CPL_WARN_UNUSED_RESULT;
1321 :
1322 : void CPL_DLL CPL_STDCALL GDALEndAsyncReader(GDALDatasetH hDS,
1323 : GDALAsyncReaderH hAsynchReaderH);
1324 :
1325 : CPLErr CPL_DLL CPL_STDCALL GDALDatasetRasterIO(
1326 : GDALDatasetH hDS, GDALRWFlag eRWFlag, int nDSXOff, int nDSYOff,
1327 : int nDSXSize, int nDSYSize, void *pBuffer, int nBXSize, int nBYSize,
1328 : GDALDataType eBDataType, int nBandCount, const int *panBandCount,
1329 : int nPixelSpace, int nLineSpace, int nBandSpace) CPL_WARN_UNUSED_RESULT;
1330 :
1331 : CPLErr CPL_DLL CPL_STDCALL GDALDatasetRasterIOEx(
1332 : GDALDatasetH hDS, GDALRWFlag eRWFlag, int nDSXOff, int nDSYOff,
1333 : int nDSXSize, int nDSYSize, void *pBuffer, int nBXSize, int nBYSize,
1334 : GDALDataType eBDataType, int nBandCount, const int *panBandCount,
1335 : GSpacing nPixelSpace, GSpacing nLineSpace, GSpacing nBandSpace,
1336 : GDALRasterIOExtraArg *psExtraArg) CPL_WARN_UNUSED_RESULT;
1337 :
1338 : CPLErr CPL_DLL CPL_STDCALL GDALDatasetAdviseRead(
1339 : GDALDatasetH hDS, int nDSXOff, int nDSYOff, int nDSXSize, int nDSYSize,
1340 : int nBXSize, int nBYSize, GDALDataType eBDataType, int nBandCount,
1341 : int *panBandCount, CSLConstList papszOptions);
1342 :
1343 : char CPL_DLL **
1344 : GDALDatasetGetCompressionFormats(GDALDatasetH hDS, int nXOff, int nYOff,
1345 : int nXSize, int nYSize, int nBandCount,
1346 : const int *panBandList) CPL_WARN_UNUSED_RESULT;
1347 : CPLErr CPL_DLL GDALDatasetReadCompressedData(
1348 : GDALDatasetH hDS, const char *pszFormat, int nXOff, int nYOff, int nXSize,
1349 : int nYSize, int nBandCount, const int *panBandList, void **ppBuffer,
1350 : size_t *pnBufferSize, char **ppszDetailedFormat);
1351 :
1352 : const char CPL_DLL *CPL_STDCALL GDALGetProjectionRef(GDALDatasetH);
1353 : OGRSpatialReferenceH CPL_DLL GDALGetSpatialRef(GDALDatasetH);
1354 : CPLErr CPL_DLL CPL_STDCALL GDALSetProjection(GDALDatasetH, const char *);
1355 : CPLErr CPL_DLL GDALSetSpatialRef(GDALDatasetH, OGRSpatialReferenceH);
1356 : CPLErr CPL_DLL CPL_STDCALL GDALGetGeoTransform(GDALDatasetH, double *);
1357 : CPLErr CPL_DLL CPL_STDCALL GDALSetGeoTransform(GDALDatasetH, const double *);
1358 :
1359 : CPLErr CPL_DLL GDALGetExtent(GDALDatasetH, OGREnvelope *,
1360 : OGRSpatialReferenceH hCRS);
1361 : CPLErr CPL_DLL GDALGetExtentWGS84LongLat(GDALDatasetH, OGREnvelope *);
1362 :
1363 : CPLErr CPL_DLL GDALDatasetGeolocationToPixelLine(
1364 : GDALDatasetH, double dfGeolocX, double dfGeolocY, OGRSpatialReferenceH hSRS,
1365 : double *pdfPixel, double *pdfLine, CSLConstList papszTransformerOptions);
1366 :
1367 : CPLErr CPL_DLL GDALDatasetGetInterBandCovarianceMatrix(
1368 : GDALDatasetH hDS, double *padfCovMatrix, size_t nSize, int nBandCount,
1369 : const int *panBandList, bool bApproxOK, bool bForce,
1370 : bool bWriteIntoMetadata, int nDeltaDegreeOfFreedom,
1371 : GDALProgressFunc pfnProgress, void *pProgressData);
1372 :
1373 : CPLErr CPL_DLL GDALDatasetComputeInterBandCovarianceMatrix(
1374 : GDALDatasetH hDS, double *padfCovMatrix, size_t nSize, int nBandCount,
1375 : const int *panBandList, bool bApproxOK, bool bWriteIntoMetadata,
1376 : int nDeltaDegreeOfFreedom, GDALProgressFunc pfnProgress,
1377 : void *pProgressData);
1378 :
1379 : int CPL_DLL CPL_STDCALL GDALGetGCPCount(GDALDatasetH);
1380 : const char CPL_DLL *CPL_STDCALL GDALGetGCPProjection(GDALDatasetH);
1381 : OGRSpatialReferenceH CPL_DLL GDALGetGCPSpatialRef(GDALDatasetH);
1382 : const GDAL_GCP CPL_DLL *CPL_STDCALL GDALGetGCPs(GDALDatasetH);
1383 : CPLErr CPL_DLL CPL_STDCALL GDALSetGCPs(GDALDatasetH, int, const GDAL_GCP *,
1384 : const char *);
1385 : CPLErr CPL_DLL GDALSetGCPs2(GDALDatasetH, int, const GDAL_GCP *,
1386 : OGRSpatialReferenceH);
1387 :
1388 : void CPL_DLL *CPL_STDCALL GDALGetInternalHandle(GDALDatasetH, const char *);
1389 : int CPL_DLL CPL_STDCALL GDALReferenceDataset(GDALDatasetH);
1390 : int CPL_DLL CPL_STDCALL GDALDereferenceDataset(GDALDatasetH);
1391 : int CPL_DLL CPL_STDCALL GDALReleaseDataset(GDALDatasetH);
1392 :
1393 : CPLErr CPL_DLL CPL_STDCALL GDALBuildOverviews(GDALDatasetH, const char *, int,
1394 : const int *, int, const int *,
1395 : GDALProgressFunc,
1396 : void *) CPL_WARN_UNUSED_RESULT;
1397 : CPLErr CPL_DLL CPL_STDCALL GDALBuildOverviewsEx(
1398 : GDALDatasetH, const char *, int, const int *, int, const int *,
1399 : GDALProgressFunc, void *, CSLConstList papszOptions) CPL_WARN_UNUSED_RESULT;
1400 : void CPL_DLL CPL_STDCALL GDALGetOpenDatasets(GDALDatasetH **hDS, int *pnCount);
1401 : int CPL_DLL CPL_STDCALL GDALGetAccess(GDALDatasetH hDS);
1402 : CPLErr CPL_DLL CPL_STDCALL GDALFlushCache(GDALDatasetH hDS);
1403 : CPLErr CPL_DLL CPL_STDCALL GDALDropCache(GDALDatasetH hDS);
1404 :
1405 : CPLErr CPL_DLL CPL_STDCALL GDALCreateDatasetMaskBand(GDALDatasetH hDS,
1406 : int nFlags);
1407 :
1408 : CPLErr CPL_DLL CPL_STDCALL GDALDatasetCopyWholeRaster(
1409 : GDALDatasetH hSrcDS, GDALDatasetH hDstDS, CSLConstList papszOptions,
1410 : GDALProgressFunc pfnProgress, void *pProgressData) CPL_WARN_UNUSED_RESULT;
1411 :
1412 : CPLErr CPL_DLL CPL_STDCALL GDALRasterBandCopyWholeRaster(
1413 : GDALRasterBandH hSrcBand, GDALRasterBandH hDstBand,
1414 : const char *const *constpapszOptions, GDALProgressFunc pfnProgress,
1415 : void *pProgressData) CPL_WARN_UNUSED_RESULT;
1416 :
1417 : CPLErr CPL_DLL GDALRegenerateOverviews(GDALRasterBandH hSrcBand,
1418 : int nOverviewCount,
1419 : GDALRasterBandH *pahOverviewBands,
1420 : const char *pszResampling,
1421 : GDALProgressFunc pfnProgress,
1422 : void *pProgressData);
1423 :
1424 : CPLErr CPL_DLL GDALRegenerateOverviewsEx(GDALRasterBandH hSrcBand,
1425 : int nOverviewCount,
1426 : GDALRasterBandH *pahOverviewBands,
1427 : const char *pszResampling,
1428 : GDALProgressFunc pfnProgress,
1429 : void *pProgressData,
1430 : CSLConstList papszOptions);
1431 :
1432 : int CPL_DLL GDALDatasetGetLayerCount(GDALDatasetH);
1433 : OGRLayerH CPL_DLL GDALDatasetGetLayer(GDALDatasetH, int);
1434 :
1435 : /* Defined here to avoid circular dependency with ogr_api.h */
1436 : GDALDatasetH CPL_DLL OGR_L_GetDataset(OGRLayerH hLayer);
1437 :
1438 : OGRLayerH CPL_DLL GDALDatasetGetLayerByName(GDALDatasetH, const char *);
1439 : int CPL_DLL GDALDatasetIsLayerPrivate(GDALDatasetH, int);
1440 : OGRErr CPL_DLL GDALDatasetDeleteLayer(GDALDatasetH, int);
1441 : OGRLayerH CPL_DLL GDALDatasetCreateLayer(GDALDatasetH, const char *,
1442 : OGRSpatialReferenceH,
1443 : OGRwkbGeometryType, CSLConstList);
1444 : OGRLayerH CPL_DLL GDALDatasetCreateLayerFromGeomFieldDefn(GDALDatasetH,
1445 : const char *,
1446 : OGRGeomFieldDefnH,
1447 : CSLConstList);
1448 : OGRLayerH CPL_DLL GDALDatasetCopyLayer(GDALDatasetH, OGRLayerH, const char *,
1449 : CSLConstList);
1450 : void CPL_DLL GDALDatasetResetReading(GDALDatasetH);
1451 : OGRFeatureH CPL_DLL GDALDatasetGetNextFeature(GDALDatasetH hDS,
1452 : OGRLayerH *phBelongingLayer,
1453 : double *pdfProgressPct,
1454 : GDALProgressFunc pfnProgress,
1455 : void *pProgressData);
1456 : int CPL_DLL GDALDatasetTestCapability(GDALDatasetH, const char *);
1457 : OGRLayerH CPL_DLL GDALDatasetExecuteSQL(GDALDatasetH, const char *,
1458 : OGRGeometryH, const char *);
1459 : OGRErr CPL_DLL GDALDatasetAbortSQL(GDALDatasetH);
1460 : void CPL_DLL GDALDatasetReleaseResultSet(GDALDatasetH, OGRLayerH);
1461 : OGRStyleTableH CPL_DLL GDALDatasetGetStyleTable(GDALDatasetH);
1462 : void CPL_DLL GDALDatasetSetStyleTableDirectly(GDALDatasetH, OGRStyleTableH);
1463 : void CPL_DLL GDALDatasetSetStyleTable(GDALDatasetH, OGRStyleTableH);
1464 : OGRErr CPL_DLL GDALDatasetStartTransaction(GDALDatasetH hDS, int bForce);
1465 : OGRErr CPL_DLL GDALDatasetCommitTransaction(GDALDatasetH hDS);
1466 : OGRErr CPL_DLL GDALDatasetRollbackTransaction(GDALDatasetH hDS);
1467 : void CPL_DLL GDALDatasetClearStatistics(GDALDatasetH hDS);
1468 :
1469 : GDALMDArrayH CPL_DLL GDALDatasetAsMDArray(
1470 : GDALDatasetH hDS, CSLConstList papszOptions) CPL_WARN_UNUSED_RESULT;
1471 :
1472 : char CPL_DLL **GDALDatasetGetFieldDomainNames(GDALDatasetH, CSLConstList)
1473 : CPL_WARN_UNUSED_RESULT;
1474 : OGRFieldDomainH CPL_DLL GDALDatasetGetFieldDomain(GDALDatasetH hDS,
1475 : const char *pszName);
1476 : bool CPL_DLL GDALDatasetAddFieldDomain(GDALDatasetH hDS,
1477 : OGRFieldDomainH hFieldDomain,
1478 : char **ppszFailureReason);
1479 : bool CPL_DLL GDALDatasetDeleteFieldDomain(GDALDatasetH hDS, const char *pszName,
1480 : char **ppszFailureReason);
1481 : bool CPL_DLL GDALDatasetUpdateFieldDomain(GDALDatasetH hDS,
1482 : OGRFieldDomainH hFieldDomain,
1483 : char **ppszFailureReason);
1484 :
1485 : char CPL_DLL **GDALDatasetGetRelationshipNames(GDALDatasetH, CSLConstList)
1486 : CPL_WARN_UNUSED_RESULT;
1487 : GDALRelationshipH CPL_DLL GDALDatasetGetRelationship(GDALDatasetH hDS,
1488 : const char *pszName);
1489 :
1490 : bool CPL_DLL GDALDatasetAddRelationship(GDALDatasetH hDS,
1491 : GDALRelationshipH hRelationship,
1492 : char **ppszFailureReason);
1493 : bool CPL_DLL GDALDatasetDeleteRelationship(GDALDatasetH hDS,
1494 : const char *pszName,
1495 : char **ppszFailureReason);
1496 : bool CPL_DLL GDALDatasetUpdateRelationship(GDALDatasetH hDS,
1497 : GDALRelationshipH hRelationship,
1498 : char **ppszFailureReason);
1499 :
1500 : /** Type of functions to pass to GDALDatasetSetQueryLoggerFunc
1501 : * @since GDAL 3.7 */
1502 : typedef void (*GDALQueryLoggerFunc)(const char *pszSQL, const char *pszError,
1503 : int64_t lNumRecords,
1504 : int64_t lExecutionTimeMilliseconds,
1505 : void *pQueryLoggerArg);
1506 :
1507 : /**
1508 : * Sets the SQL query logger callback.
1509 : *
1510 : * When supported by the driver, the callback will be called with
1511 : * the executed SQL text, the error message, the execution time in milliseconds,
1512 : * the number of records fetched/affected and the client status data.
1513 : *
1514 : * A value of -1 in the execution time or in the number of records indicates
1515 : * that the values are unknown.
1516 : *
1517 : * @param hDS Dataset handle.
1518 : * @param pfnQueryLoggerFunc Callback function
1519 : * @param poQueryLoggerArg Opaque client status data
1520 : * @return true in case of success.
1521 : * @since GDAL 3.7
1522 : */
1523 : bool CPL_DLL GDALDatasetSetQueryLoggerFunc(
1524 : GDALDatasetH hDS, GDALQueryLoggerFunc pfnQueryLoggerFunc,
1525 : void *poQueryLoggerArg);
1526 :
1527 : /* ==================================================================== */
1528 : /* Informational utilities about subdatasets in file names */
1529 : /* ==================================================================== */
1530 :
1531 : /**
1532 : * @brief Returns a new GDALSubdatasetInfo object with methods to extract
1533 : * and manipulate subdataset information.
1534 : * If the pszFileName argument is not recognized by any driver as
1535 : * a subdataset descriptor, NULL is returned.
1536 : * The returned object must be freed with GDALDestroySubdatasetInfo().
1537 : * @param pszFileName File name with subdataset information
1538 : * @note This method does not check if the subdataset actually exists.
1539 : * @return Opaque pointer to a GDALSubdatasetInfo object or NULL if no drivers accepted the file name.
1540 : * @since GDAL 3.8
1541 : */
1542 : GDALSubdatasetInfoH CPL_DLL GDALGetSubdatasetInfo(const char *pszFileName);
1543 :
1544 : /**
1545 : * @brief Returns the file path component of a
1546 : * subdataset descriptor effectively stripping the information about the subdataset
1547 : * and returning the "parent" dataset descriptor.
1548 : * The returned string must be freed with CPLFree().
1549 : * @param hInfo Pointer to GDALSubdatasetInfo object
1550 : * @note This method does not check if the subdataset actually exists.
1551 : * @return The original string with the subdataset information removed.
1552 : * @since GDAL 3.8
1553 : */
1554 : char CPL_DLL *GDALSubdatasetInfoGetPathComponent(GDALSubdatasetInfoH hInfo);
1555 :
1556 : /**
1557 : * @brief Returns the subdataset component of a subdataset descriptor descriptor.
1558 : * The returned string must be freed with CPLFree().
1559 : * @param hInfo Pointer to GDALSubdatasetInfo object
1560 : * @note This method does not check if the subdataset actually exists.
1561 : * @return The subdataset name.
1562 : * @since GDAL 3.8
1563 : */
1564 : char CPL_DLL *
1565 : GDALSubdatasetInfoGetSubdatasetComponent(GDALSubdatasetInfoH hInfo);
1566 :
1567 : /**
1568 : * @brief Replaces the path component of a subdataset descriptor.
1569 : * The returned string must be freed with CPLFree().
1570 : * @param hInfo Pointer to GDALSubdatasetInfo object
1571 : * @param pszNewPath New path.
1572 : * @note This method does not check if the subdataset actually exists.
1573 : * @return The original subdataset descriptor with the old path component replaced by newPath.
1574 : * @since GDAL 3.8
1575 : */
1576 : char CPL_DLL *GDALSubdatasetInfoModifyPathComponent(GDALSubdatasetInfoH hInfo,
1577 : const char *pszNewPath);
1578 :
1579 : /**
1580 : * @brief Destroys a GDALSubdatasetInfo object.
1581 : * @param hInfo Pointer to GDALSubdatasetInfo object
1582 : * @since GDAL 3.8
1583 : */
1584 : void CPL_DLL GDALDestroySubdatasetInfo(GDALSubdatasetInfoH hInfo);
1585 :
1586 : /* ==================================================================== */
1587 : /* GDALRasterBand ... one band/channel in a dataset. */
1588 : /* ==================================================================== */
1589 :
1590 : /* Note: the only user of SRCVAL() is alg/gdal_simplesurf.cpp */
1591 :
1592 : /* clang-format off */
1593 : /**
1594 : * SRCVAL - Macro which may be used by pixel functions to obtain
1595 : * a pixel from a source buffer.
1596 : */
1597 : #define SRCVAL(papoSource, eSrcType, ii) \
1598 : (eSrcType == GDT_UInt8 ? CPL_REINTERPRET_CAST(const GByte *, papoSource)[ii] : \
1599 : eSrcType == GDT_Int8 ? CPL_REINTERPRET_CAST(const GInt8 *, papoSource)[ii] : \
1600 : eSrcType == GDT_UInt16 ? CPL_REINTERPRET_CAST(const GUInt16 *, papoSource)[ii] : \
1601 : eSrcType == GDT_Int16 ? CPL_REINTERPRET_CAST(const GInt16 *, papoSource)[ii] : \
1602 : eSrcType == GDT_UInt32 ? CPL_REINTERPRET_CAST(const GUInt32 *, papoSource)[ii] : \
1603 : eSrcType == GDT_Int32 ? CPL_REINTERPRET_CAST(const GInt32 *, papoSource)[ii] : \
1604 : eSrcType == GDT_UInt64 ? CPL_STATIC_CAST(double, CPL_REINTERPRET_CAST(const GUInt64 *, papoSource)[ii]) : \
1605 : eSrcType == GDT_Int64 ? CPL_STATIC_CAST(double, CPL_REINTERPRET_CAST(const GUInt64 *, papoSource)[ii]) : \
1606 : eSrcType == GDT_Float32 ? CPL_STATIC_CAST(double, CPL_REINTERPRET_CAST(const float *, papoSource)[ii]) : \
1607 : eSrcType == GDT_Float64 ? CPL_REINTERPRET_CAST(const double *, papoSource)[ii] : \
1608 : eSrcType == GDT_CInt16 ? CPL_REINTERPRET_CAST(const GInt16 *, papoSource)[(ii)*2] : \
1609 : eSrcType == GDT_CInt32 ? CPL_REINTERPRET_CAST(const GInt32 *, papoSource)[(ii)*2] : \
1610 : eSrcType == GDT_CFloat32 ? CPL_STATIC_CAST(double, CPL_REINTERPRET_CAST(const float *, papoSource)[ii*2]) : \
1611 : eSrcType == GDT_CFloat64 ? CPL_REINTERPRET_CAST(const double *, papoSource)[ii*2] : \
1612 : 0)
1613 :
1614 : /* clang-format on */
1615 :
1616 : /** Type of functions to pass to GDALAddDerivedBandPixelFunc.
1617 : */
1618 : typedef CPLErr (*GDALDerivedPixelFunc)(void **papoSources, int nSources,
1619 : void *pData, int nBufXSize,
1620 : int nBufYSize, GDALDataType eSrcType,
1621 : GDALDataType eBufType, int nPixelSpace,
1622 : int nLineSpace);
1623 :
1624 : /** Type of functions to pass to GDALAddDerivedBandPixelFuncWithArgs.
1625 : * @since GDAL 3.4 */
1626 : typedef CPLErr (*GDALDerivedPixelFuncWithArgs)(
1627 : void **papoSources, int nSources, void *pData, int nBufXSize, int nBufYSize,
1628 : GDALDataType eSrcType, GDALDataType eBufType, int nPixelSpace,
1629 : int nLineSpace, CSLConstList papszFunctionArgs);
1630 :
1631 : GDALDataType CPL_DLL CPL_STDCALL GDALGetRasterDataType(GDALRasterBandH);
1632 : void CPL_DLL CPL_STDCALL GDALGetBlockSize(GDALRasterBandH, int *pnXSize,
1633 : int *pnYSize);
1634 :
1635 : CPLErr CPL_DLL CPL_STDCALL GDALGetActualBlockSize(GDALRasterBandH,
1636 : int nXBlockOff,
1637 : int nYBlockOff, int *pnXValid,
1638 : int *pnYValid);
1639 :
1640 : CPLErr CPL_DLL CPL_STDCALL GDALRasterAdviseRead(GDALRasterBandH hRB,
1641 : int nDSXOff, int nDSYOff,
1642 : int nDSXSize, int nDSYSize,
1643 : int nBXSize, int nBYSize,
1644 : GDALDataType eBDataType,
1645 : CSLConstList papszOptions);
1646 :
1647 : CPLErr CPL_DLL CPL_STDCALL GDALRasterIO(GDALRasterBandH hRBand,
1648 : GDALRWFlag eRWFlag, int nDSXOff,
1649 : int nDSYOff, int nDSXSize, int nDSYSize,
1650 : void *pBuffer, int nBXSize, int nBYSize,
1651 : GDALDataType eBDataType,
1652 : int nPixelSpace,
1653 : int nLineSpace) CPL_WARN_UNUSED_RESULT;
1654 : CPLErr CPL_DLL CPL_STDCALL GDALRasterIOEx(
1655 : GDALRasterBandH hRBand, GDALRWFlag eRWFlag, int nDSXOff, int nDSYOff,
1656 : int nDSXSize, int nDSYSize, void *pBuffer, int nBXSize, int nBYSize,
1657 : GDALDataType eBDataType, GSpacing nPixelSpace, GSpacing nLineSpace,
1658 : GDALRasterIOExtraArg *psExtraArg) CPL_WARN_UNUSED_RESULT;
1659 : CPLErr CPL_DLL CPL_STDCALL GDALReadBlock(GDALRasterBandH, int, int,
1660 : void *) CPL_WARN_UNUSED_RESULT;
1661 : CPLErr CPL_DLL CPL_STDCALL GDALWriteBlock(GDALRasterBandH, int, int,
1662 : void *) CPL_WARN_UNUSED_RESULT;
1663 : int CPL_DLL CPL_STDCALL GDALGetRasterBandXSize(GDALRasterBandH);
1664 : int CPL_DLL CPL_STDCALL GDALGetRasterBandYSize(GDALRasterBandH);
1665 : GDALAccess CPL_DLL CPL_STDCALL GDALGetRasterAccess(GDALRasterBandH);
1666 : int CPL_DLL CPL_STDCALL GDALGetBandNumber(GDALRasterBandH);
1667 : GDALDatasetH CPL_DLL CPL_STDCALL GDALGetBandDataset(GDALRasterBandH);
1668 :
1669 : GDALColorInterp
1670 : CPL_DLL CPL_STDCALL GDALGetRasterColorInterpretation(GDALRasterBandH);
1671 : CPLErr CPL_DLL CPL_STDCALL GDALSetRasterColorInterpretation(GDALRasterBandH,
1672 : GDALColorInterp);
1673 : GDALColorTableH CPL_DLL CPL_STDCALL GDALGetRasterColorTable(GDALRasterBandH);
1674 : CPLErr CPL_DLL CPL_STDCALL GDALSetRasterColorTable(GDALRasterBandH,
1675 : GDALColorTableH);
1676 : int CPL_DLL CPL_STDCALL GDALHasArbitraryOverviews(GDALRasterBandH);
1677 : int CPL_DLL CPL_STDCALL GDALGetOverviewCount(GDALRasterBandH);
1678 : GDALRasterBandH CPL_DLL CPL_STDCALL GDALGetOverview(GDALRasterBandH, int);
1679 : double CPL_DLL CPL_STDCALL GDALGetRasterNoDataValue(GDALRasterBandH, int *);
1680 : int64_t CPL_DLL CPL_STDCALL GDALGetRasterNoDataValueAsInt64(GDALRasterBandH,
1681 : int *);
1682 : uint64_t CPL_DLL CPL_STDCALL GDALGetRasterNoDataValueAsUInt64(GDALRasterBandH,
1683 : int *);
1684 : CPLErr CPL_DLL CPL_STDCALL GDALSetRasterNoDataValue(GDALRasterBandH, double);
1685 : CPLErr CPL_DLL CPL_STDCALL GDALSetRasterNoDataValueAsInt64(GDALRasterBandH,
1686 : int64_t);
1687 : CPLErr CPL_DLL CPL_STDCALL GDALSetRasterNoDataValueAsUInt64(GDALRasterBandH,
1688 : uint64_t);
1689 : CPLErr CPL_DLL CPL_STDCALL GDALDeleteRasterNoDataValue(GDALRasterBandH);
1690 : char CPL_DLL **CPL_STDCALL GDALGetRasterCategoryNames(GDALRasterBandH);
1691 : CPLErr CPL_DLL CPL_STDCALL GDALSetRasterCategoryNames(GDALRasterBandH,
1692 : CSLConstList);
1693 : double CPL_DLL CPL_STDCALL GDALGetRasterMinimum(GDALRasterBandH,
1694 : int *pbSuccess);
1695 : double CPL_DLL CPL_STDCALL GDALGetRasterMaximum(GDALRasterBandH,
1696 : int *pbSuccess);
1697 : CPLErr CPL_DLL CPL_STDCALL GDALGetRasterStatistics(
1698 : GDALRasterBandH, int bApproxOK, int bForce, double *pdfMin, double *pdfMax,
1699 : double *pdfMean, double *pdfStdDev);
1700 : CPLErr CPL_DLL CPL_STDCALL
1701 : GDALComputeRasterStatistics(GDALRasterBandH, int bApproxOK, double *pdfMin,
1702 : double *pdfMax, double *pdfMean, double *pdfStdDev,
1703 : GDALProgressFunc pfnProgress, void *pProgressData);
1704 : CPLErr CPL_DLL CPL_STDCALL GDALSetRasterStatistics(GDALRasterBandH hBand,
1705 : double dfMin, double dfMax,
1706 : double dfMean,
1707 : double dfStdDev);
1708 :
1709 : GDALMDArrayH
1710 : CPL_DLL GDALRasterBandAsMDArray(GDALRasterBandH) CPL_WARN_UNUSED_RESULT;
1711 :
1712 : const char CPL_DLL *CPL_STDCALL GDALGetRasterUnitType(GDALRasterBandH);
1713 : CPLErr CPL_DLL CPL_STDCALL GDALSetRasterUnitType(GDALRasterBandH hBand,
1714 : const char *pszNewValue);
1715 : double CPL_DLL CPL_STDCALL GDALGetRasterOffset(GDALRasterBandH, int *pbSuccess);
1716 : CPLErr CPL_DLL CPL_STDCALL GDALSetRasterOffset(GDALRasterBandH hBand,
1717 : double dfNewOffset);
1718 : double CPL_DLL CPL_STDCALL GDALGetRasterScale(GDALRasterBandH, int *pbSuccess);
1719 : CPLErr CPL_DLL CPL_STDCALL GDALSetRasterScale(GDALRasterBandH hBand,
1720 : double dfNewOffset);
1721 : CPLErr CPL_DLL CPL_STDCALL GDALComputeRasterMinMax(GDALRasterBandH hBand,
1722 : int bApproxOK,
1723 : double adfMinMax[2]);
1724 : CPLErr CPL_DLL GDALComputeRasterMinMaxLocation(GDALRasterBandH hBand,
1725 : double *pdfMin, double *pdfMax,
1726 : int *pnMinX, int *pnMinY,
1727 : int *pnMaxX, int *pnMaxY);
1728 : CPLErr CPL_DLL CPL_STDCALL GDALFlushRasterCache(GDALRasterBandH hBand);
1729 : CPLErr CPL_DLL CPL_STDCALL GDALDropRasterCache(GDALRasterBandH hBand);
1730 : CPLErr CPL_DLL CPL_STDCALL GDALGetRasterHistogram(
1731 : GDALRasterBandH hBand, double dfMin, double dfMax, int nBuckets,
1732 : int *panHistogram, int bIncludeOutOfRange, int bApproxOK,
1733 : GDALProgressFunc pfnProgress, void *pProgressData)
1734 : /*! @cond Doxygen_Suppress */
1735 : CPL_WARN_DEPRECATED("Use GDALGetRasterHistogramEx() instead")
1736 : /*! @endcond */
1737 : ;
1738 : CPLErr CPL_DLL CPL_STDCALL GDALGetRasterHistogramEx(
1739 : GDALRasterBandH hBand, double dfMin, double dfMax, int nBuckets,
1740 : GUIntBig *panHistogram, int bIncludeOutOfRange, int bApproxOK,
1741 : GDALProgressFunc pfnProgress, void *pProgressData);
1742 : CPLErr CPL_DLL CPL_STDCALL
1743 : GDALGetDefaultHistogram(GDALRasterBandH hBand, double *pdfMin, double *pdfMax,
1744 : int *pnBuckets, int **ppanHistogram, int bForce,
1745 : GDALProgressFunc pfnProgress, void *pProgressData)
1746 : /*! @cond Doxygen_Suppress */
1747 : CPL_WARN_DEPRECATED("Use GDALGetDefaultHistogramEx() instead")
1748 : /*! @endcond */
1749 : ;
1750 : CPLErr CPL_DLL CPL_STDCALL
1751 : GDALGetDefaultHistogramEx(GDALRasterBandH hBand, double *pdfMin, double *pdfMax,
1752 : int *pnBuckets, GUIntBig **ppanHistogram, int bForce,
1753 : GDALProgressFunc pfnProgress, void *pProgressData);
1754 : CPLErr CPL_DLL CPL_STDCALL GDALSetDefaultHistogram(GDALRasterBandH hBand,
1755 : double dfMin, double dfMax,
1756 : int nBuckets,
1757 : int *panHistogram)
1758 : /*! @cond Doxygen_Suppress */
1759 : CPL_WARN_DEPRECATED("Use GDALSetDefaultHistogramEx() instead")
1760 : /*! @endcond */
1761 : ;
1762 : CPLErr CPL_DLL CPL_STDCALL GDALSetDefaultHistogramEx(GDALRasterBandH hBand,
1763 : double dfMin, double dfMax,
1764 : int nBuckets,
1765 : GUIntBig *panHistogram);
1766 : int CPL_DLL CPL_STDCALL GDALGetRandomRasterSample(GDALRasterBandH, int,
1767 : float *);
1768 : GDALRasterBandH CPL_DLL CPL_STDCALL GDALGetRasterSampleOverview(GDALRasterBandH,
1769 : int);
1770 : GDALRasterBandH CPL_DLL CPL_STDCALL
1771 : GDALGetRasterSampleOverviewEx(GDALRasterBandH, GUIntBig);
1772 : CPLErr CPL_DLL CPL_STDCALL GDALFillRaster(GDALRasterBandH hBand,
1773 : double dfRealValue,
1774 : double dfImaginaryValue);
1775 : CPLErr CPL_DLL CPL_STDCALL GDALComputeBandStats(
1776 : GDALRasterBandH hBand, int nSampleStep, double *pdfMean, double *pdfStdDev,
1777 : GDALProgressFunc pfnProgress, void *pProgressData);
1778 : CPLErr CPL_DLL GDALOverviewMagnitudeCorrection(GDALRasterBandH hBaseBand,
1779 : int nOverviewCount,
1780 : GDALRasterBandH *pahOverviews,
1781 : GDALProgressFunc pfnProgress,
1782 : void *pProgressData);
1783 :
1784 : GDALRasterAttributeTableH CPL_DLL CPL_STDCALL
1785 : GDALGetDefaultRAT(GDALRasterBandH hBand);
1786 : CPLErr CPL_DLL CPL_STDCALL GDALSetDefaultRAT(GDALRasterBandH,
1787 : GDALRasterAttributeTableH);
1788 : CPLErr CPL_DLL CPL_STDCALL GDALAddDerivedBandPixelFunc(
1789 : const char *pszName, GDALDerivedPixelFunc pfnPixelFunc);
1790 : CPLErr CPL_DLL CPL_STDCALL GDALAddDerivedBandPixelFuncWithArgs(
1791 : const char *pszName, GDALDerivedPixelFuncWithArgs pfnPixelFunc,
1792 : const char *pszMetadata);
1793 :
1794 : CPLErr CPL_DLL GDALRasterInterpolateAtPoint(GDALRasterBandH hBand,
1795 : double dfPixel, double dfLine,
1796 : GDALRIOResampleAlg eInterpolation,
1797 : double *pdfRealValue,
1798 : double *pdfImagValue);
1799 :
1800 : CPLErr CPL_DLL GDALRasterInterpolateAtGeolocation(
1801 : GDALRasterBandH hBand, double dfGeolocX, double dfGeolocY,
1802 : OGRSpatialReferenceH hSRS, GDALRIOResampleAlg eInterpolation,
1803 : double *pdfRealValue, double *pdfImagValue,
1804 : CSLConstList papszTransformerOptions);
1805 :
1806 : /** Generic pointer for the working structure of VRTProcessedDataset
1807 : * function. */
1808 : typedef void *VRTPDWorkingDataPtr;
1809 :
1810 : /** Initialization function to pass to GDALVRTRegisterProcessedDatasetFunc.
1811 : *
1812 : * This initialization function is called for each step of a VRTProcessedDataset
1813 : * that uses the related algorithm.
1814 : * The initialization function returns the output data type, output band count
1815 : * and potentially initializes a working structure, typically parsing arguments.
1816 : *
1817 : * @param pszFuncName Function name. Must be unique and not null.
1818 : * @param pUserData User data. May be nullptr. Must remain valid during the
1819 : * lifetime of GDAL.
1820 : * @param papszFunctionArgs Function arguments as a list of key=value pairs.
1821 : * @param nInBands Number of input bands.
1822 : * @param eInDT Input data type.
1823 : * @param[in,out] padfInNoData Array of nInBands values for the input nodata
1824 : * value. The init function may also override them.
1825 : * @param[in,out] pnOutBands Pointer whose value must be set to the number of
1826 : * output bands. This will be set to 0 by the caller
1827 : * when calling the function, unless this is the
1828 : * final step, in which case it will be initialized
1829 : * with the number of expected output bands.
1830 : * @param[out] peOutDT Pointer whose value must be set to the output
1831 : * data type.
1832 : * @param[in,out] ppadfOutNoData Pointer to an array of *pnOutBands values
1833 : * for the output nodata value that the
1834 : * function must set.
1835 : * For non-final steps, *ppadfOutNoData
1836 : * will be nullptr and it is the responsibility
1837 : * of the function to CPLMalloc()'ate it.
1838 : * If this is the final step, it will be
1839 : * already allocated and initialized with the
1840 : * expected nodata values from the output
1841 : * dataset (if the init function need to
1842 : * reallocate it, it must use CPLRealloc())
1843 : * @param pszVRTPath Directory of the VRT
1844 : * @param[out] ppWorkingData Pointer whose value must be set to a working
1845 : * structure, or nullptr.
1846 : * @return CE_None in case of success, error otherwise.
1847 : * @since GDAL 3.9 */
1848 : typedef CPLErr (*GDALVRTProcessedDatasetFuncInit)(
1849 : const char *pszFuncName, void *pUserData, CSLConstList papszFunctionArgs,
1850 : int nInBands, GDALDataType eInDT, double *padfInNoData, int *pnOutBands,
1851 : GDALDataType *peOutDT, double **ppadfOutNoData, const char *pszVRTPath,
1852 : VRTPDWorkingDataPtr *ppWorkingData);
1853 :
1854 : /** Free function to pass to GDALVRTRegisterProcessedDatasetFunc.
1855 : *
1856 : * @param pszFuncName Function name. Must be unique and not null.
1857 : * @param pUserData User data. May be nullptr. Must remain valid during the
1858 : * lifetime of GDAL.
1859 : * @param pWorkingData Value of the *ppWorkingData output parameter of
1860 : * GDALVRTProcessedDatasetFuncInit.
1861 : * @since GDAL 3.9
1862 : */
1863 : typedef void (*GDALVRTProcessedDatasetFuncFree)(
1864 : const char *pszFuncName, void *pUserData, VRTPDWorkingDataPtr pWorkingData);
1865 :
1866 : /** Processing function to pass to GDALVRTRegisterProcessedDatasetFunc.
1867 : * @param pszFuncName Function name. Must be unique and not null.
1868 : * @param pUserData User data. May be nullptr. Must remain valid during the
1869 : * lifetime of GDAL.
1870 : * @param pWorkingData Value of the *ppWorkingData output parameter of
1871 : * GDALVRTProcessedDatasetFuncInit.
1872 : * @param papszFunctionArgs Function arguments as a list of key=value pairs.
1873 : * @param nBufXSize Width in pixels of pInBuffer and pOutBuffer
1874 : * @param nBufYSize Height in pixels of pInBuffer and pOutBuffer
1875 : * @param pInBuffer Input buffer. It is pixel-interleaved
1876 : * (i.e. R00,G00,B00,R01,G01,B01, etc.)
1877 : * @param nInBufferSize Size in bytes of pInBuffer
1878 : * @param eInDT Data type of pInBuffer
1879 : * @param nInBands Number of bands in pInBuffer.
1880 : * @param padfInNoData Input nodata values.
1881 : * @param pOutBuffer Output buffer. It is pixel-interleaved
1882 : * (i.e. R00,G00,B00,R01,G01,B01, etc.)
1883 : * @param nOutBufferSize Size in bytes of pOutBuffer
1884 : * @param eOutDT Data type of pOutBuffer
1885 : * @param nOutBands Number of bands in pOutBuffer.
1886 : * @param padfOutNoData Input nodata values.
1887 : * @param dfSrcXOff Source X coordinate in pixel of the top-left of the region
1888 : * @param dfSrcYOff Source Y coordinate in pixel of the top-left of the region
1889 : * @param dfSrcXSize Width in pixels of the region
1890 : * @param dfSrcYSize Height in pixels of the region
1891 : * @param adfSrcGT Source geotransform
1892 : * @param pszVRTPath Directory of the VRT
1893 : * @param papszExtra Extra arguments (unused for now)
1894 : * @since GDAL 3.9
1895 : */
1896 : typedef CPLErr (*GDALVRTProcessedDatasetFuncProcess)(
1897 : const char *pszFuncName, void *pUserData, VRTPDWorkingDataPtr pWorkingData,
1898 : CSLConstList papszFunctionArgs, int nBufXSize, int nBufYSize,
1899 : const void *pInBuffer, size_t nInBufferSize, GDALDataType eInDT,
1900 : int nInBands, const double *padfInNoData, void *pOutBuffer,
1901 : size_t nOutBufferSize, GDALDataType eOutDT, int nOutBands,
1902 : const double *padfOutNoData, double dfSrcXOff, double dfSrcYOff,
1903 : double dfSrcXSize, double dfSrcYSize, const double adfSrcGT[/*6*/],
1904 : const char *pszVRTPath, CSLConstList papszExtra);
1905 :
1906 : CPLErr CPL_DLL GDALVRTRegisterProcessedDatasetFunc(
1907 : const char *pszFuncName, void *pUserData, const char *pszXMLMetadata,
1908 : GDALDataType eRequestedInputDT, const GDALDataType *paeSupportedInputDT,
1909 : size_t nSupportedInputDTSize, const int *panSupportedInputBandCount,
1910 : size_t nSupportedInputBandCountSize,
1911 : GDALVRTProcessedDatasetFuncInit pfnInit,
1912 : GDALVRTProcessedDatasetFuncFree pfnFree,
1913 : GDALVRTProcessedDatasetFuncProcess pfnProcess, CSLConstList papszOptions);
1914 :
1915 : GDALRasterBandH CPL_DLL CPL_STDCALL GDALGetMaskBand(GDALRasterBandH hBand);
1916 : int CPL_DLL CPL_STDCALL GDALGetMaskFlags(GDALRasterBandH hBand);
1917 : CPLErr CPL_DLL CPL_STDCALL GDALCreateMaskBand(GDALRasterBandH hBand,
1918 : int nFlags);
1919 : bool CPL_DLL GDALIsMaskBand(GDALRasterBandH hBand);
1920 :
1921 : /** Flag returned by GDALGetMaskFlags() to indicate that all pixels are valid */
1922 : #define GMF_ALL_VALID 0x01
1923 : /** Flag returned by GDALGetMaskFlags() to indicate that the mask band is
1924 : * valid for all bands */
1925 : #define GMF_PER_DATASET 0x02
1926 : /** Flag returned by GDALGetMaskFlags() to indicate that the mask band is
1927 : * an alpha band */
1928 : #define GMF_ALPHA 0x04
1929 : /** Flag returned by GDALGetMaskFlags() to indicate that the mask band is
1930 : * computed from nodata values */
1931 : #define GMF_NODATA 0x08
1932 :
1933 : /** Flag returned by GDALGetDataCoverageStatus() when the driver does not
1934 : * implement GetDataCoverageStatus(). This flag should be returned together
1935 : * with GDAL_DATA_COVERAGE_STATUS_DATA */
1936 : #define GDAL_DATA_COVERAGE_STATUS_UNIMPLEMENTED 0x01
1937 :
1938 : /** Flag returned by GDALGetDataCoverageStatus() when there is (potentially)
1939 : * data in the queried window. Can be combined with the binary or operator
1940 : * with GDAL_DATA_COVERAGE_STATUS_UNIMPLEMENTED or
1941 : * GDAL_DATA_COVERAGE_STATUS_EMPTY */
1942 : #define GDAL_DATA_COVERAGE_STATUS_DATA 0x02
1943 :
1944 : /** Flag returned by GDALGetDataCoverageStatus() when there is nodata in the
1945 : * queried window. This is typically identified by the concept of missing block
1946 : * in formats that supports it.
1947 : * Can be combined with the binary or operator with
1948 : * GDAL_DATA_COVERAGE_STATUS_DATA */
1949 : #define GDAL_DATA_COVERAGE_STATUS_EMPTY 0x04
1950 :
1951 : int CPL_DLL CPL_STDCALL GDALGetDataCoverageStatus(GDALRasterBandH hBand,
1952 : int nXOff, int nYOff,
1953 : int nXSize, int nYSize,
1954 : int nMaskFlagStop,
1955 : double *pdfDataPct);
1956 :
1957 : void CPL_DLL GDALComputedRasterBandRelease(GDALComputedRasterBandH hBand);
1958 :
1959 : /** Raster algebra unary operation */
1960 : typedef enum
1961 : {
1962 : /** Logical not */
1963 : GRAUO_LOGICAL_NOT,
1964 : /** Absolute value (module for complex data type) */
1965 : GRAUO_ABS,
1966 : /** Square root */
1967 : GRAUO_SQRT,
1968 : /** Natural logarithm (``ln``) */
1969 : GRAUO_LOG,
1970 : /** Logarithm base 10 */
1971 : GRAUO_LOG10,
1972 : } GDALRasterAlgebraUnaryOperation;
1973 :
1974 : GDALComputedRasterBandH CPL_DLL GDALRasterBandUnaryOp(
1975 : GDALRasterBandH hBand,
1976 : GDALRasterAlgebraUnaryOperation eOp) CPL_WARN_UNUSED_RESULT;
1977 :
1978 : /** Raster algebra binary operation */
1979 : typedef enum
1980 : {
1981 : /** Addition */
1982 : GRABO_ADD,
1983 : /** Subtraction */
1984 : GRABO_SUB,
1985 : /** Multiplication */
1986 : GRABO_MUL,
1987 : /** Division */
1988 : GRABO_DIV,
1989 : /** Power */
1990 : GRABO_POW,
1991 : /** Strictly greater than test*/
1992 : GRABO_GT,
1993 : /** Greater or equal to test */
1994 : GRABO_GE,
1995 : /** Strictly lesser than test */
1996 : GRABO_LT,
1997 : /** Lesser or equal to test */
1998 : GRABO_LE,
1999 : /** Equality test */
2000 : GRABO_EQ,
2001 : /** Non-equality test */
2002 : GRABO_NE,
2003 : /** Logical and */
2004 : GRABO_LOGICAL_AND,
2005 : /** Logical or */
2006 : GRABO_LOGICAL_OR
2007 : } GDALRasterAlgebraBinaryOperation;
2008 :
2009 : GDALComputedRasterBandH CPL_DLL GDALRasterBandBinaryOpBand(
2010 : GDALRasterBandH hBand, GDALRasterAlgebraBinaryOperation eOp,
2011 : GDALRasterBandH hOtherBand) CPL_WARN_UNUSED_RESULT;
2012 : GDALComputedRasterBandH CPL_DLL GDALRasterBandBinaryOpDouble(
2013 : GDALRasterBandH hBand, GDALRasterAlgebraBinaryOperation eOp,
2014 : double constant) CPL_WARN_UNUSED_RESULT;
2015 : GDALComputedRasterBandH CPL_DLL GDALRasterBandBinaryOpDoubleToBand(
2016 : double constant, GDALRasterAlgebraBinaryOperation eOp,
2017 : GDALRasterBandH hBand) CPL_WARN_UNUSED_RESULT;
2018 :
2019 : GDALComputedRasterBandH CPL_DLL
2020 : GDALRasterBandIfThenElse(GDALRasterBandH hCondBand, GDALRasterBandH hThenBand,
2021 : GDALRasterBandH hElseBand) CPL_WARN_UNUSED_RESULT;
2022 :
2023 : GDALComputedRasterBandH CPL_DLL GDALRasterBandAsDataType(
2024 : GDALRasterBandH hBand, GDALDataType eDT) CPL_WARN_UNUSED_RESULT;
2025 :
2026 : GDALComputedRasterBandH CPL_DLL GDALMaximumOfNBands(
2027 : size_t nBandCount, GDALRasterBandH *pahBands) CPL_WARN_UNUSED_RESULT;
2028 : GDALComputedRasterBandH CPL_DLL GDALRasterBandMaxConstant(
2029 : GDALRasterBandH hBand, double dfConstant) CPL_WARN_UNUSED_RESULT;
2030 : GDALComputedRasterBandH CPL_DLL GDALMinimumOfNBands(
2031 : size_t nBandCount, GDALRasterBandH *pahBands) CPL_WARN_UNUSED_RESULT;
2032 : GDALComputedRasterBandH CPL_DLL GDALRasterBandMinConstant(
2033 : GDALRasterBandH hBand, double dfConstant) CPL_WARN_UNUSED_RESULT;
2034 : GDALComputedRasterBandH CPL_DLL GDALMeanOfNBands(
2035 : size_t nBandCount, GDALRasterBandH *pahBands) CPL_WARN_UNUSED_RESULT;
2036 :
2037 : /* ==================================================================== */
2038 : /* GDALAsyncReader */
2039 : /* ==================================================================== */
2040 :
2041 : GDALAsyncStatusType CPL_DLL CPL_STDCALL GDALARGetNextUpdatedRegion(
2042 : GDALAsyncReaderH hARIO, double dfTimeout, int *pnXBufOff, int *pnYBufOff,
2043 : int *pnXBufSize, int *pnYBufSize);
2044 : int CPL_DLL CPL_STDCALL GDALARLockBuffer(GDALAsyncReaderH hARIO,
2045 : double dfTimeout);
2046 : void CPL_DLL CPL_STDCALL GDALARUnlockBuffer(GDALAsyncReaderH hARIO);
2047 :
2048 : /* -------------------------------------------------------------------- */
2049 : /* Helper functions. */
2050 : /* -------------------------------------------------------------------- */
2051 : int CPL_DLL CPL_STDCALL GDALGeneralCmdLineProcessor(int nArgc,
2052 : char ***ppapszArgv,
2053 : int nOptions);
2054 : void CPL_DLL CPL_STDCALL GDALSwapWords(void *pData, int nWordSize,
2055 : int nWordCount, int nWordSkip);
2056 : void CPL_DLL CPL_STDCALL GDALSwapWordsEx(void *pData, int nWordSize,
2057 : size_t nWordCount, int nWordSkip);
2058 :
2059 : void CPL_DLL CPL_STDCALL GDALCopyWords(const void *CPL_RESTRICT pSrcData,
2060 : GDALDataType eSrcType,
2061 : int nSrcPixelOffset,
2062 : void *CPL_RESTRICT pDstData,
2063 : GDALDataType eDstType,
2064 : int nDstPixelOffset, int nWordCount);
2065 :
2066 : void CPL_DLL CPL_STDCALL GDALCopyWords64(
2067 : const void *CPL_RESTRICT pSrcData, GDALDataType eSrcType,
2068 : int nSrcPixelOffset, void *CPL_RESTRICT pDstData, GDALDataType eDstType,
2069 : int nDstPixelOffset, GPtrDiff_t nWordCount);
2070 :
2071 : void CPL_DLL GDALCopyBits(const GByte *pabySrcData, int nSrcOffset,
2072 : int nSrcStep, GByte *pabyDstData, int nDstOffset,
2073 : int nDstStep, int nBitCount, int nStepCount);
2074 :
2075 : void CPL_DLL GDALDeinterleave(const void *pSourceBuffer, GDALDataType eSourceDT,
2076 : int nComponents, void **ppDestBuffer,
2077 : GDALDataType eDestDT, size_t nIters);
2078 :
2079 : void CPL_DLL GDALTranspose2D(const void *pSrc, GDALDataType eSrcType,
2080 : void *pDst, GDALDataType eDstType,
2081 : size_t nSrcWidth, size_t nSrcHeight);
2082 :
2083 : double CPL_DLL GDALGetNoDataReplacementValue(GDALDataType, double);
2084 :
2085 : int CPL_DLL CPL_STDCALL GDALLoadWorldFile(const char *, double *);
2086 : int CPL_DLL CPL_STDCALL GDALReadWorldFile(const char *, const char *, double *);
2087 : int CPL_DLL CPL_STDCALL GDALWriteWorldFile(const char *, const char *,
2088 : double *);
2089 : int CPL_DLL CPL_STDCALL GDALLoadTabFile(const char *, double *, char **, int *,
2090 : GDAL_GCP **);
2091 : int CPL_DLL CPL_STDCALL GDALReadTabFile(const char *, double *, char **, int *,
2092 : GDAL_GCP **);
2093 : int CPL_DLL CPL_STDCALL GDALLoadOziMapFile(const char *, double *, char **,
2094 : int *, GDAL_GCP **);
2095 : int CPL_DLL CPL_STDCALL GDALReadOziMapFile(const char *, double *, char **,
2096 : int *, GDAL_GCP **);
2097 :
2098 : const char CPL_DLL *CPL_STDCALL GDALDecToDMS(double, const char *, int);
2099 : double CPL_DLL CPL_STDCALL GDALPackedDMSToDec(double);
2100 : double CPL_DLL CPL_STDCALL GDALDecToPackedDMS(double);
2101 :
2102 : /* Note to developers : please keep this section in sync with ogr_core.h */
2103 :
2104 : #ifndef GDAL_VERSION_INFO_DEFINED
2105 : #ifndef DOXYGEN_SKIP
2106 : #define GDAL_VERSION_INFO_DEFINED
2107 : #endif
2108 : const char CPL_DLL *CPL_STDCALL GDALVersionInfo(const char *);
2109 : #endif
2110 :
2111 : #ifndef GDAL_CHECK_VERSION
2112 :
2113 : int CPL_DLL CPL_STDCALL GDALCheckVersion(int nVersionMajor, int nVersionMinor,
2114 : const char *pszCallingComponentName);
2115 :
2116 : /** Helper macro for GDALCheckVersion()
2117 : @see GDALCheckVersion()
2118 : */
2119 : #define GDAL_CHECK_VERSION(pszCallingComponentName) \
2120 : GDALCheckVersion(GDAL_VERSION_MAJOR, GDAL_VERSION_MINOR, \
2121 : pszCallingComponentName)
2122 :
2123 : #endif
2124 :
2125 : /*! @cond Doxygen_Suppress */
2126 : #ifdef GDAL_COMPILATION
2127 : #define GDALExtractRPCInfoV1 GDALExtractRPCInfo
2128 : #else
2129 : #define GDALRPCInfo GDALRPCInfoV2
2130 : #define GDALExtractRPCInfo GDALExtractRPCInfoV2
2131 : #endif
2132 :
2133 : /* Deprecated: use GDALRPCInfoV2 */
2134 : typedef struct
2135 : {
2136 : double dfLINE_OFF; /*!< Line offset */
2137 : double dfSAMP_OFF; /*!< Sample/Pixel offset */
2138 : double dfLAT_OFF; /*!< Latitude offset */
2139 : double dfLONG_OFF; /*!< Longitude offset */
2140 : double dfHEIGHT_OFF; /*!< Height offset */
2141 :
2142 : double dfLINE_SCALE; /*!< Line scale */
2143 : double dfSAMP_SCALE; /*!< Sample/Pixel scale */
2144 : double dfLAT_SCALE; /*!< Latitude scale */
2145 : double dfLONG_SCALE; /*!< Longitude scale */
2146 : double dfHEIGHT_SCALE; /*!< Height scale */
2147 :
2148 : double adfLINE_NUM_COEFF[20]; /*!< Line Numerator Coefficients */
2149 : double adfLINE_DEN_COEFF[20]; /*!< Line Denominator Coefficients */
2150 : double adfSAMP_NUM_COEFF[20]; /*!< Sample/Pixel Numerator Coefficients */
2151 : double adfSAMP_DEN_COEFF[20]; /*!< Sample/Pixel Denominator Coefficients */
2152 :
2153 : double dfMIN_LONG; /*!< Minimum longitude */
2154 : double dfMIN_LAT; /*!< Minimum latitude */
2155 : double dfMAX_LONG; /*!< Maximum longitude */
2156 : double dfMAX_LAT; /*!< Maximum latitude */
2157 : } GDALRPCInfoV1;
2158 :
2159 : /*! @endcond */
2160 :
2161 : /** Structure to store Rational Polynomial Coefficients / Rigorous Projection
2162 : * Model. See http://geotiff.maptools.org/rpc_prop.html */
2163 : typedef struct
2164 : {
2165 : double dfLINE_OFF; /*!< Line offset */
2166 : double dfSAMP_OFF; /*!< Sample/Pixel offset */
2167 : double dfLAT_OFF; /*!< Latitude offset */
2168 : double dfLONG_OFF; /*!< Longitude offset */
2169 : double dfHEIGHT_OFF; /*!< Height offset */
2170 :
2171 : double dfLINE_SCALE; /*!< Line scale */
2172 : double dfSAMP_SCALE; /*!< Sample/Pixel scale */
2173 : double dfLAT_SCALE; /*!< Latitude scale */
2174 : double dfLONG_SCALE; /*!< Longitude scale */
2175 : double dfHEIGHT_SCALE; /*!< Height scale */
2176 :
2177 : double adfLINE_NUM_COEFF[20]; /*!< Line Numerator Coefficients */
2178 : double adfLINE_DEN_COEFF[20]; /*!< Line Denominator Coefficients */
2179 : double adfSAMP_NUM_COEFF[20]; /*!< Sample/Pixel Numerator Coefficients */
2180 : double adfSAMP_DEN_COEFF[20]; /*!< Sample/Pixel Denominator Coefficients */
2181 :
2182 : double dfMIN_LONG; /*!< Minimum longitude */
2183 : double dfMIN_LAT; /*!< Minimum latitude */
2184 : double dfMAX_LONG; /*!< Maximum longitude */
2185 : double dfMAX_LAT; /*!< Maximum latitude */
2186 :
2187 : /* Those fields should be at the end. And all above fields should be the
2188 : * same as in GDALRPCInfoV1 */
2189 : double dfERR_BIAS; /*!< Bias error */
2190 : double dfERR_RAND; /*!< Random error */
2191 : } GDALRPCInfoV2;
2192 :
2193 : /*! @cond Doxygen_Suppress */
2194 : int CPL_DLL CPL_STDCALL GDALExtractRPCInfoV1(CSLConstList, GDALRPCInfoV1 *);
2195 : /*! @endcond */
2196 : int CPL_DLL CPL_STDCALL GDALExtractRPCInfoV2(CSLConstList, GDALRPCInfoV2 *);
2197 :
2198 : /* ==================================================================== */
2199 : /* Color tables. */
2200 : /* ==================================================================== */
2201 :
2202 : /** Color tuple */
2203 : typedef struct
2204 : {
2205 : /*! gray, red, cyan or hue */
2206 : short c1;
2207 :
2208 : /*! green, magenta, or lightness */
2209 : short c2;
2210 :
2211 : /*! blue, yellow, or saturation */
2212 : short c3;
2213 :
2214 : /*! alpha or blackband */
2215 : short c4;
2216 : } GDALColorEntry;
2217 :
2218 : GDALColorTableH CPL_DLL CPL_STDCALL GDALCreateColorTable(GDALPaletteInterp)
2219 : CPL_WARN_UNUSED_RESULT;
2220 : void CPL_DLL CPL_STDCALL GDALDestroyColorTable(GDALColorTableH);
2221 : GDALColorTableH CPL_DLL CPL_STDCALL GDALCloneColorTable(GDALColorTableH);
2222 : GDALPaletteInterp
2223 : CPL_DLL CPL_STDCALL GDALGetPaletteInterpretation(GDALColorTableH);
2224 : int CPL_DLL CPL_STDCALL GDALGetColorEntryCount(GDALColorTableH);
2225 : const GDALColorEntry CPL_DLL *CPL_STDCALL GDALGetColorEntry(GDALColorTableH,
2226 : int);
2227 : int CPL_DLL CPL_STDCALL GDALGetColorEntryAsRGB(GDALColorTableH, int,
2228 : GDALColorEntry *);
2229 : void CPL_DLL CPL_STDCALL GDALSetColorEntry(GDALColorTableH, int,
2230 : const GDALColorEntry *);
2231 : void CPL_DLL CPL_STDCALL GDALCreateColorRamp(GDALColorTableH hTable,
2232 : int nStartIndex,
2233 : const GDALColorEntry *psStartColor,
2234 : int nEndIndex,
2235 : const GDALColorEntry *psEndColor);
2236 :
2237 : /* ==================================================================== */
2238 : /* Raster Attribute Table */
2239 : /* ==================================================================== */
2240 :
2241 : /** Field type of raster attribute table */
2242 : typedef enum
2243 : {
2244 : /*! Integer field */ GFT_Integer,
2245 : /*! Floating point (double) field */ GFT_Real,
2246 : /*! String field */ GFT_String,
2247 : /*! Boolean field (GDAL >= 3.12) */ GFT_Boolean,
2248 : /*! DateTime field (GDAL >= 3.12) */ GFT_DateTime,
2249 : /*! Geometry field, as WKB (GDAL >= 3.12) */ GFT_WKBGeometry
2250 : } GDALRATFieldType;
2251 :
2252 : /** First invalid value for the GDALRATFieldType enumeration */
2253 : #define GFT_MaxCount (GFT_WKBGeometry + 1)
2254 :
2255 : /** Field usage of raster attribute table */
2256 : typedef enum
2257 : {
2258 : /*! General purpose field. */ GFU_Generic = 0,
2259 : /*! Histogram pixel count */ GFU_PixelCount = 1,
2260 : /*! Class name */ GFU_Name = 2,
2261 : /*! Class range minimum */ GFU_Min = 3,
2262 : /*! Class range maximum */ GFU_Max = 4,
2263 : /*! Class value (min=max) */ GFU_MinMax = 5,
2264 : /*! Red class color (0-255) */ GFU_Red = 6,
2265 : /*! Green class color (0-255) */ GFU_Green = 7,
2266 : /*! Blue class color (0-255) */ GFU_Blue = 8,
2267 : /*! Alpha (0=transparent,255=opaque)*/ GFU_Alpha = 9,
2268 : /*! Color Range Red Minimum */ GFU_RedMin = 10,
2269 : /*! Color Range Green Minimum */ GFU_GreenMin = 11,
2270 : /*! Color Range Blue Minimum */ GFU_BlueMin = 12,
2271 : /*! Color Range Alpha Minimum */ GFU_AlphaMin = 13,
2272 : /*! Color Range Red Maximum */ GFU_RedMax = 14,
2273 : /*! Color Range Green Maximum */ GFU_GreenMax = 15,
2274 : /*! Color Range Blue Maximum */ GFU_BlueMax = 16,
2275 : /*! Color Range Alpha Maximum */ GFU_AlphaMax = 17,
2276 : /*! Maximum GFU value (equals to GFU_AlphaMax+1 currently) */ GFU_MaxCount
2277 : } GDALRATFieldUsage;
2278 :
2279 : /** RAT table type (thematic or athematic)
2280 : */
2281 : typedef enum
2282 : {
2283 : /*! Thematic table type */ GRTT_THEMATIC,
2284 : /*! Athematic table type */ GRTT_ATHEMATIC
2285 : } GDALRATTableType;
2286 :
2287 : GDALRasterAttributeTableH CPL_DLL CPL_STDCALL
2288 : GDALCreateRasterAttributeTable(void) CPL_WARN_UNUSED_RESULT;
2289 :
2290 : void CPL_DLL CPL_STDCALL
2291 : GDALDestroyRasterAttributeTable(GDALRasterAttributeTableH);
2292 :
2293 : int CPL_DLL CPL_STDCALL GDALRATGetColumnCount(GDALRasterAttributeTableH);
2294 :
2295 : const char CPL_DLL *CPL_STDCALL GDALRATGetNameOfCol(GDALRasterAttributeTableH,
2296 : int);
2297 : GDALRATFieldUsage CPL_DLL CPL_STDCALL
2298 : GDALRATGetUsageOfCol(GDALRasterAttributeTableH, int);
2299 : GDALRATFieldType CPL_DLL CPL_STDCALL
2300 : GDALRATGetTypeOfCol(GDALRasterAttributeTableH, int);
2301 :
2302 : const char CPL_DLL *GDALGetRATFieldTypeName(GDALRATFieldType);
2303 : const char CPL_DLL *GDALGetRATFieldUsageName(GDALRATFieldUsage);
2304 :
2305 : int CPL_DLL CPL_STDCALL GDALRATGetColOfUsage(GDALRasterAttributeTableH,
2306 : GDALRATFieldUsage);
2307 : int CPL_DLL CPL_STDCALL GDALRATGetRowCount(GDALRasterAttributeTableH);
2308 :
2309 : const char CPL_DLL *CPL_STDCALL
2310 : GDALRATGetValueAsString(GDALRasterAttributeTableH, int iRow, int iField);
2311 : int CPL_DLL CPL_STDCALL GDALRATGetValueAsInt(GDALRasterAttributeTableH,
2312 : int iRow, int iField);
2313 : double CPL_DLL CPL_STDCALL GDALRATGetValueAsDouble(GDALRasterAttributeTableH,
2314 : int iRow, int iField);
2315 : bool CPL_DLL GDALRATGetValueAsBoolean(GDALRasterAttributeTableH, int iRow,
2316 : int iField);
2317 :
2318 : #ifdef __cplusplus
2319 : extern "C++"
2320 : {
2321 : #endif
2322 :
2323 : /** Structure encoding a DateTime field for a GDAL Raster Attribute Table.
2324 : *
2325 : * @since 3.12
2326 : */
2327 : struct GDALRATDateTime
2328 : {
2329 : /*! Year */ int nYear;
2330 : /*! Month [1, 12] */ int nMonth;
2331 : /*! Day [1, 31] */ int nDay;
2332 : /*! Hour [0, 23] */ int nHour;
2333 : /*! Minute [0, 59] */ int nMinute;
2334 : /*! Second [0, 61) */ float fSecond;
2335 : /*! Time zone hour [0, 23] */ int nTimeZoneHour;
2336 : /*! Time zone minute: 0, 15, 30, 45 */ int nTimeZoneMinute;
2337 : /*! Whether time zone is positive (or null) */ bool bPositiveTimeZone;
2338 : /*! Whether this object is valid */ bool bIsValid;
2339 :
2340 : #ifdef __cplusplus
2341 137 : GDALRATDateTime()
2342 137 : : nYear(0), nMonth(0), nDay(0), nHour(0), nMinute(0), fSecond(0),
2343 : nTimeZoneHour(0), nTimeZoneMinute(0), bPositiveTimeZone(false),
2344 137 : bIsValid(false)
2345 : {
2346 69 : }
2347 : #endif
2348 : };
2349 :
2350 : #ifdef __cplusplus
2351 : }
2352 : #endif
2353 :
2354 : /*! @cond Doxygen_Suppress */
2355 : typedef struct GDALRATDateTime GDALRATDateTime;
2356 : /*! @endcond */
2357 :
2358 : CPLErr CPL_DLL GDALRATGetValueAsDateTime(GDALRasterAttributeTableH, int iRow,
2359 : int iField,
2360 : GDALRATDateTime *psDateTime);
2361 : const GByte CPL_DLL *GDALRATGetValueAsWKBGeometry(GDALRasterAttributeTableH,
2362 : int iRow, int iField,
2363 : size_t *pnWKBSize);
2364 :
2365 : void CPL_DLL CPL_STDCALL GDALRATSetValueAsString(GDALRasterAttributeTableH,
2366 : int iRow, int iField,
2367 : const char *);
2368 : void CPL_DLL CPL_STDCALL GDALRATSetValueAsInt(GDALRasterAttributeTableH,
2369 : int iRow, int iField, int);
2370 : void CPL_DLL CPL_STDCALL GDALRATSetValueAsDouble(GDALRasterAttributeTableH,
2371 : int iRow, int iField, double);
2372 : CPLErr CPL_DLL GDALRATSetValueAsBoolean(GDALRasterAttributeTableH, int iRow,
2373 : int iField, bool);
2374 : CPLErr CPL_DLL GDALRATSetValueAsDateTime(GDALRasterAttributeTableH, int iRow,
2375 : int iField,
2376 : const GDALRATDateTime *psDateTime);
2377 : CPLErr CPL_DLL GDALRATSetValueAsWKBGeometry(GDALRasterAttributeTableH, int iRow,
2378 : int iField, const void *pabyWKB,
2379 : size_t nWKBSize);
2380 :
2381 : int CPL_DLL CPL_STDCALL
2382 : GDALRATChangesAreWrittenToFile(GDALRasterAttributeTableH hRAT);
2383 :
2384 : CPLErr CPL_DLL CPL_STDCALL GDALRATValuesIOAsDouble(
2385 : GDALRasterAttributeTableH hRAT, GDALRWFlag eRWFlag, int iField,
2386 : int iStartRow, int iLength, double *pdfData);
2387 : CPLErr CPL_DLL CPL_STDCALL
2388 : GDALRATValuesIOAsInteger(GDALRasterAttributeTableH hRAT, GDALRWFlag eRWFlag,
2389 : int iField, int iStartRow, int iLength, int *pnData);
2390 : CPLErr CPL_DLL CPL_STDCALL GDALRATValuesIOAsString(
2391 : GDALRasterAttributeTableH hRAT, GDALRWFlag eRWFlag, int iField,
2392 : int iStartRow, int iLength, char **papszStrList);
2393 : CPLErr CPL_DLL GDALRATValuesIOAsBoolean(GDALRasterAttributeTableH hRAT,
2394 : GDALRWFlag eRWFlag, int iField,
2395 : int iStartRow, int iLength,
2396 : bool *pbData);
2397 : CPLErr CPL_DLL GDALRATValuesIOAsDateTime(GDALRasterAttributeTableH hRAT,
2398 : GDALRWFlag eRWFlag, int iField,
2399 : int iStartRow, int iLength,
2400 : GDALRATDateTime *pasDateTime);
2401 : CPLErr CPL_DLL GDALRATValuesIOAsWKBGeometry(GDALRasterAttributeTableH hRAT,
2402 : GDALRWFlag eRWFlag, int iField,
2403 : int iStartRow, int iLength,
2404 : GByte **ppabyWKB,
2405 : size_t *pnWKBSize);
2406 :
2407 : void CPL_DLL CPL_STDCALL GDALRATSetRowCount(GDALRasterAttributeTableH, int);
2408 : CPLErr CPL_DLL CPL_STDCALL GDALRATCreateColumn(GDALRasterAttributeTableH,
2409 : const char *, GDALRATFieldType,
2410 : GDALRATFieldUsage);
2411 : CPLErr CPL_DLL CPL_STDCALL GDALRATSetLinearBinning(GDALRasterAttributeTableH,
2412 : double, double);
2413 : int CPL_DLL CPL_STDCALL GDALRATGetLinearBinning(GDALRasterAttributeTableH,
2414 : double *, double *);
2415 : CPLErr CPL_DLL CPL_STDCALL GDALRATSetTableType(
2416 : GDALRasterAttributeTableH hRAT, const GDALRATTableType eInTableType);
2417 : GDALRATTableType CPL_DLL CPL_STDCALL
2418 : GDALRATGetTableType(GDALRasterAttributeTableH hRAT);
2419 : CPLErr CPL_DLL CPL_STDCALL
2420 : GDALRATInitializeFromColorTable(GDALRasterAttributeTableH, GDALColorTableH);
2421 : GDALColorTableH CPL_DLL CPL_STDCALL
2422 : GDALRATTranslateToColorTable(GDALRasterAttributeTableH, int nEntryCount);
2423 : void CPL_DLL CPL_STDCALL GDALRATDumpReadable(GDALRasterAttributeTableH, FILE *);
2424 : GDALRasterAttributeTableH CPL_DLL CPL_STDCALL
2425 : GDALRATClone(const GDALRasterAttributeTableH);
2426 :
2427 : void CPL_DLL *CPL_STDCALL GDALRATSerializeJSON(GDALRasterAttributeTableH)
2428 : CPL_WARN_UNUSED_RESULT;
2429 :
2430 : int CPL_DLL CPL_STDCALL GDALRATGetRowOfValue(GDALRasterAttributeTableH, double);
2431 : void CPL_DLL CPL_STDCALL GDALRATRemoveStatistics(GDALRasterAttributeTableH);
2432 :
2433 : /* -------------------------------------------------------------------- */
2434 : /* Relationships */
2435 : /* -------------------------------------------------------------------- */
2436 :
2437 : /** Cardinality of relationship.
2438 : *
2439 : * @since GDAL 3.6
2440 : */
2441 : typedef enum
2442 : {
2443 : /** One-to-one */
2444 : GRC_ONE_TO_ONE,
2445 : /** One-to-many */
2446 : GRC_ONE_TO_MANY,
2447 : /** Many-to-one */
2448 : GRC_MANY_TO_ONE,
2449 : /** Many-to-many */
2450 : GRC_MANY_TO_MANY,
2451 : } GDALRelationshipCardinality;
2452 :
2453 : /** Type of relationship.
2454 : *
2455 : * @since GDAL 3.6
2456 : */
2457 : typedef enum
2458 : {
2459 : /** Composite relationship */
2460 : GRT_COMPOSITE,
2461 : /** Association relationship */
2462 : GRT_ASSOCIATION,
2463 : /** Aggregation relationship */
2464 : GRT_AGGREGATION,
2465 : } GDALRelationshipType;
2466 :
2467 : GDALRelationshipH CPL_DLL GDALRelationshipCreate(const char *, const char *,
2468 : const char *,
2469 : GDALRelationshipCardinality);
2470 : void CPL_DLL CPL_STDCALL GDALDestroyRelationship(GDALRelationshipH);
2471 : const char CPL_DLL *GDALRelationshipGetName(GDALRelationshipH);
2472 : GDALRelationshipCardinality
2473 : CPL_DLL GDALRelationshipGetCardinality(GDALRelationshipH);
2474 : const char CPL_DLL *GDALRelationshipGetLeftTableName(GDALRelationshipH);
2475 : const char CPL_DLL *GDALRelationshipGetRightTableName(GDALRelationshipH);
2476 : const char CPL_DLL *GDALRelationshipGetMappingTableName(GDALRelationshipH);
2477 : void CPL_DLL GDALRelationshipSetMappingTableName(GDALRelationshipH,
2478 : const char *);
2479 : char CPL_DLL **GDALRelationshipGetLeftTableFields(GDALRelationshipH);
2480 : char CPL_DLL **GDALRelationshipGetRightTableFields(GDALRelationshipH);
2481 : void CPL_DLL GDALRelationshipSetLeftTableFields(GDALRelationshipH,
2482 : CSLConstList);
2483 : void CPL_DLL GDALRelationshipSetRightTableFields(GDALRelationshipH,
2484 : CSLConstList);
2485 : char CPL_DLL **GDALRelationshipGetLeftMappingTableFields(GDALRelationshipH);
2486 : char CPL_DLL **GDALRelationshipGetRightMappingTableFields(GDALRelationshipH);
2487 : void CPL_DLL GDALRelationshipSetLeftMappingTableFields(GDALRelationshipH,
2488 : CSLConstList);
2489 : void CPL_DLL GDALRelationshipSetRightMappingTableFields(GDALRelationshipH,
2490 : CSLConstList);
2491 : GDALRelationshipType CPL_DLL GDALRelationshipGetType(GDALRelationshipH);
2492 : void CPL_DLL GDALRelationshipSetType(GDALRelationshipH, GDALRelationshipType);
2493 : const char CPL_DLL *GDALRelationshipGetForwardPathLabel(GDALRelationshipH);
2494 : void CPL_DLL GDALRelationshipSetForwardPathLabel(GDALRelationshipH,
2495 : const char *);
2496 : const char CPL_DLL *GDALRelationshipGetBackwardPathLabel(GDALRelationshipH);
2497 : void CPL_DLL GDALRelationshipSetBackwardPathLabel(GDALRelationshipH,
2498 : const char *);
2499 : const char CPL_DLL *GDALRelationshipGetRelatedTableType(GDALRelationshipH);
2500 : void CPL_DLL GDALRelationshipSetRelatedTableType(GDALRelationshipH,
2501 : const char *);
2502 :
2503 : /* ==================================================================== */
2504 : /* GDAL Cache Management */
2505 : /* ==================================================================== */
2506 :
2507 : void CPL_DLL CPL_STDCALL GDALSetCacheMax(int nBytes);
2508 : int CPL_DLL CPL_STDCALL GDALGetCacheMax(void);
2509 : int CPL_DLL CPL_STDCALL GDALGetCacheUsed(void);
2510 : void CPL_DLL CPL_STDCALL GDALSetCacheMax64(GIntBig nBytes);
2511 : GIntBig CPL_DLL CPL_STDCALL GDALGetCacheMax64(void);
2512 : GIntBig CPL_DLL CPL_STDCALL GDALGetCacheUsed64(void);
2513 :
2514 : int CPL_DLL CPL_STDCALL GDALFlushCacheBlock(void);
2515 :
2516 : /* ==================================================================== */
2517 : /* GDAL virtual memory */
2518 : /* ==================================================================== */
2519 :
2520 : CPLVirtualMem CPL_DLL *GDALDatasetGetVirtualMem(
2521 : GDALDatasetH hDS, GDALRWFlag eRWFlag, int nXOff, int nYOff, int nXSize,
2522 : int nYSize, int nBufXSize, int nBufYSize, GDALDataType eBufType,
2523 : int nBandCount, int *panBandMap, int nPixelSpace, GIntBig nLineSpace,
2524 : GIntBig nBandSpace, size_t nCacheSize, size_t nPageSizeHint,
2525 : int bSingleThreadUsage, CSLConstList papszOptions) CPL_WARN_UNUSED_RESULT;
2526 :
2527 : CPLVirtualMem CPL_DLL *GDALRasterBandGetVirtualMem(
2528 : GDALRasterBandH hBand, GDALRWFlag eRWFlag, int nXOff, int nYOff, int nXSize,
2529 : int nYSize, int nBufXSize, int nBufYSize, GDALDataType eBufType,
2530 : int nPixelSpace, GIntBig nLineSpace, size_t nCacheSize,
2531 : size_t nPageSizeHint, int bSingleThreadUsage,
2532 : CSLConstList papszOptions) CPL_WARN_UNUSED_RESULT;
2533 :
2534 : CPLVirtualMem CPL_DLL *
2535 : GDALGetVirtualMemAuto(GDALRasterBandH hBand, GDALRWFlag eRWFlag,
2536 : int *pnPixelSpace, GIntBig *pnLineSpace,
2537 : CSLConstList papszOptions) CPL_WARN_UNUSED_RESULT;
2538 :
2539 : /**! Enumeration to describe the tile organization */
2540 : typedef enum
2541 : {
2542 : /*! Tile Interleaved by Pixel: tile (0,0) with internal band interleaved by
2543 : pixel organization, tile (1, 0), ... */
2544 : GTO_TIP,
2545 : /*! Band Interleaved by Tile : tile (0,0) of first band, tile (0,0) of
2546 : second band, ... tile (1,0) of first band, tile (1,0) of second band, ...
2547 : */
2548 : GTO_BIT,
2549 : /*! Band SeQuential : all the tiles of first band, all the tiles of
2550 : following band... */
2551 : GTO_BSQ
2552 : } GDALTileOrganization;
2553 :
2554 : CPLVirtualMem CPL_DLL *GDALDatasetGetTiledVirtualMem(
2555 : GDALDatasetH hDS, GDALRWFlag eRWFlag, int nXOff, int nYOff, int nXSize,
2556 : int nYSize, int nTileXSize, int nTileYSize, GDALDataType eBufType,
2557 : int nBandCount, int *panBandMap, GDALTileOrganization eTileOrganization,
2558 : size_t nCacheSize, int bSingleThreadUsage,
2559 : CSLConstList papszOptions) CPL_WARN_UNUSED_RESULT;
2560 :
2561 : CPLVirtualMem CPL_DLL *GDALRasterBandGetTiledVirtualMem(
2562 : GDALRasterBandH hBand, GDALRWFlag eRWFlag, int nXOff, int nYOff, int nXSize,
2563 : int nYSize, int nTileXSize, int nTileYSize, GDALDataType eBufType,
2564 : size_t nCacheSize, int bSingleThreadUsage,
2565 : CSLConstList papszOptions) CPL_WARN_UNUSED_RESULT;
2566 :
2567 : /* ==================================================================== */
2568 : /* VRTPansharpenedDataset class. */
2569 : /* ==================================================================== */
2570 :
2571 : GDALDatasetH CPL_DLL GDALCreatePansharpenedVRT(
2572 : const char *pszXML, GDALRasterBandH hPanchroBand, int nInputSpectralBands,
2573 : GDALRasterBandH *pahInputSpectralBands) CPL_WARN_UNUSED_RESULT;
2574 :
2575 : /* =================================================================== */
2576 : /* Misc API */
2577 : /* ==================================================================== */
2578 :
2579 : CPLXMLNode CPL_DLL *
2580 : GDALGetJPEG2000Structure(const char *pszFilename,
2581 : CSLConstList papszOptions) CPL_WARN_UNUSED_RESULT;
2582 :
2583 : /* ==================================================================== */
2584 : /* Multidimensional API_api */
2585 : /* ==================================================================== */
2586 :
2587 : GDALDatasetH CPL_DLL
2588 : GDALCreateMultiDimensional(GDALDriverH hDriver, const char *pszName,
2589 : CSLConstList papszRootGroupOptions,
2590 : CSLConstList papszOptions) CPL_WARN_UNUSED_RESULT;
2591 :
2592 : GDALExtendedDataTypeH CPL_DLL GDALExtendedDataTypeCreate(GDALDataType eType)
2593 : CPL_WARN_UNUSED_RESULT;
2594 : GDALExtendedDataTypeH CPL_DLL GDALExtendedDataTypeCreateString(
2595 : size_t nMaxStringLength) CPL_WARN_UNUSED_RESULT;
2596 : GDALExtendedDataTypeH CPL_DLL GDALExtendedDataTypeCreateStringEx(
2597 : size_t nMaxStringLength,
2598 : GDALExtendedDataTypeSubType eSubType) CPL_WARN_UNUSED_RESULT;
2599 : GDALExtendedDataTypeH CPL_DLL GDALExtendedDataTypeCreateCompound(
2600 : const char *pszName, size_t nTotalSize, size_t nComponents,
2601 : const GDALEDTComponentH *comps) CPL_WARN_UNUSED_RESULT;
2602 : void CPL_DLL GDALExtendedDataTypeRelease(GDALExtendedDataTypeH hEDT);
2603 : const char CPL_DLL *GDALExtendedDataTypeGetName(GDALExtendedDataTypeH hEDT);
2604 : GDALExtendedDataTypeClass CPL_DLL
2605 : GDALExtendedDataTypeGetClass(GDALExtendedDataTypeH hEDT);
2606 : GDALDataType CPL_DLL
2607 : GDALExtendedDataTypeGetNumericDataType(GDALExtendedDataTypeH hEDT);
2608 : size_t CPL_DLL GDALExtendedDataTypeGetSize(GDALExtendedDataTypeH hEDT);
2609 : size_t CPL_DLL
2610 : GDALExtendedDataTypeGetMaxStringLength(GDALExtendedDataTypeH hEDT);
2611 : GDALEDTComponentH CPL_DLL *
2612 : GDALExtendedDataTypeGetComponents(GDALExtendedDataTypeH hEDT,
2613 : size_t *pnCount) CPL_WARN_UNUSED_RESULT;
2614 : void CPL_DLL GDALExtendedDataTypeFreeComponents(GDALEDTComponentH *components,
2615 : size_t nCount);
2616 : int CPL_DLL GDALExtendedDataTypeCanConvertTo(GDALExtendedDataTypeH hSourceEDT,
2617 : GDALExtendedDataTypeH hTargetEDT);
2618 : int CPL_DLL GDALExtendedDataTypeEquals(GDALExtendedDataTypeH hFirstEDT,
2619 : GDALExtendedDataTypeH hSecondEDT);
2620 : GDALExtendedDataTypeSubType CPL_DLL
2621 : GDALExtendedDataTypeGetSubType(GDALExtendedDataTypeH hEDT);
2622 : GDALRasterAttributeTableH CPL_DLL
2623 : GDALExtendedDataTypeGetRAT(GDALExtendedDataTypeH hEDT) CPL_WARN_UNUSED_RESULT;
2624 :
2625 : GDALEDTComponentH CPL_DLL
2626 : GDALEDTComponentCreate(const char *pszName, size_t nOffset,
2627 : GDALExtendedDataTypeH hType) CPL_WARN_UNUSED_RESULT;
2628 : void CPL_DLL GDALEDTComponentRelease(GDALEDTComponentH hComp);
2629 : const char CPL_DLL *GDALEDTComponentGetName(GDALEDTComponentH hComp);
2630 : size_t CPL_DLL GDALEDTComponentGetOffset(GDALEDTComponentH hComp);
2631 : GDALExtendedDataTypeH CPL_DLL GDALEDTComponentGetType(GDALEDTComponentH hComp)
2632 : CPL_WARN_UNUSED_RESULT;
2633 :
2634 : GDALGroupH CPL_DLL GDALDatasetGetRootGroup(GDALDatasetH hDS)
2635 : CPL_WARN_UNUSED_RESULT;
2636 : void CPL_DLL GDALGroupRelease(GDALGroupH hGroup);
2637 : const char CPL_DLL *GDALGroupGetName(GDALGroupH hGroup);
2638 : const char CPL_DLL *GDALGroupGetFullName(GDALGroupH hGroup);
2639 : char CPL_DLL **
2640 : GDALGroupGetMDArrayNames(GDALGroupH hGroup,
2641 : CSLConstList papszOptions) CPL_WARN_UNUSED_RESULT;
2642 : char CPL_DLL **GDALGroupGetMDArrayFullNamesRecursive(
2643 : GDALGroupH hGroup, CSLConstList papszGroupOptions,
2644 : CSLConstList papszArrayOptions) CPL_WARN_UNUSED_RESULT;
2645 : GDALMDArrayH CPL_DLL
2646 : GDALGroupOpenMDArray(GDALGroupH hGroup, const char *pszMDArrayName,
2647 : CSLConstList papszOptions) CPL_WARN_UNUSED_RESULT;
2648 : GDALMDArrayH CPL_DLL GDALGroupOpenMDArrayFromFullname(
2649 : GDALGroupH hGroup, const char *pszMDArrayName,
2650 : CSLConstList papszOptions) CPL_WARN_UNUSED_RESULT;
2651 : GDALMDArrayH CPL_DLL GDALGroupResolveMDArray(
2652 : GDALGroupH hGroup, const char *pszName, const char *pszStartingPoint,
2653 : CSLConstList papszOptions) CPL_WARN_UNUSED_RESULT;
2654 : char CPL_DLL **
2655 : GDALGroupGetGroupNames(GDALGroupH hGroup,
2656 : CSLConstList papszOptions) CPL_WARN_UNUSED_RESULT;
2657 : GDALGroupH CPL_DLL
2658 : GDALGroupOpenGroup(GDALGroupH hGroup, const char *pszSubGroupName,
2659 : CSLConstList papszOptions) CPL_WARN_UNUSED_RESULT;
2660 : GDALGroupH CPL_DLL GDALGroupOpenGroupFromFullname(
2661 : GDALGroupH hGroup, const char *pszMDArrayName,
2662 : CSLConstList papszOptions) CPL_WARN_UNUSED_RESULT;
2663 : char CPL_DLL **
2664 : GDALGroupGetVectorLayerNames(GDALGroupH hGroup,
2665 : CSLConstList papszOptions) CPL_WARN_UNUSED_RESULT;
2666 : OGRLayerH CPL_DLL
2667 : GDALGroupOpenVectorLayer(GDALGroupH hGroup, const char *pszVectorLayerName,
2668 : CSLConstList papszOptions) CPL_WARN_UNUSED_RESULT;
2669 : GDALDimensionH CPL_DLL *
2670 : GDALGroupGetDimensions(GDALGroupH hGroup, size_t *pnCount,
2671 : CSLConstList papszOptions) CPL_WARN_UNUSED_RESULT;
2672 : GDALAttributeH CPL_DLL GDALGroupGetAttribute(
2673 : GDALGroupH hGroup, const char *pszName) CPL_WARN_UNUSED_RESULT;
2674 : GDALAttributeH CPL_DLL *
2675 : GDALGroupGetAttributes(GDALGroupH hGroup, size_t *pnCount,
2676 : CSLConstList papszOptions) CPL_WARN_UNUSED_RESULT;
2677 : CSLConstList CPL_DLL GDALGroupGetStructuralInfo(GDALGroupH hGroup);
2678 : GDALGroupH CPL_DLL
2679 : GDALGroupCreateGroup(GDALGroupH hGroup, const char *pszSubGroupName,
2680 : CSLConstList papszOptions) CPL_WARN_UNUSED_RESULT;
2681 : bool CPL_DLL GDALGroupDeleteGroup(GDALGroupH hGroup, const char *pszName,
2682 : CSLConstList papszOptions);
2683 : GDALDimensionH CPL_DLL GDALGroupCreateDimension(
2684 : GDALGroupH hGroup, const char *pszName, const char *pszType,
2685 : const char *pszDirection, GUInt64 nSize,
2686 : CSLConstList papszOptions) CPL_WARN_UNUSED_RESULT;
2687 : GDALMDArrayH CPL_DLL GDALGroupCreateMDArray(
2688 : GDALGroupH hGroup, const char *pszName, size_t nDimensions,
2689 : GDALDimensionH *pahDimensions, GDALExtendedDataTypeH hEDT,
2690 : CSLConstList papszOptions) CPL_WARN_UNUSED_RESULT;
2691 : bool CPL_DLL GDALGroupDeleteMDArray(GDALGroupH hGroup, const char *pszName,
2692 : CSLConstList papszOptions);
2693 : GDALAttributeH CPL_DLL GDALGroupCreateAttribute(
2694 : GDALGroupH hGroup, const char *pszName, size_t nDimensions,
2695 : const GUInt64 *panDimensions, GDALExtendedDataTypeH hEDT,
2696 : CSLConstList papszOptions) CPL_WARN_UNUSED_RESULT;
2697 : bool CPL_DLL GDALGroupDeleteAttribute(GDALGroupH hGroup, const char *pszName,
2698 : CSLConstList papszOptions);
2699 : bool CPL_DLL GDALGroupRename(GDALGroupH hGroup, const char *pszNewName);
2700 : GDALGroupH CPL_DLL GDALGroupSubsetDimensionFromSelection(
2701 : GDALGroupH hGroup, const char *pszSelection, CSLConstList papszOptions);
2702 : size_t CPL_DLL GDALGroupGetDataTypeCount(GDALGroupH hGroup);
2703 : GDALExtendedDataTypeH CPL_DLL GDALGroupGetDataType(GDALGroupH hGroup,
2704 : size_t nIdx);
2705 :
2706 : void CPL_DLL GDALMDArrayRelease(GDALMDArrayH hMDArray);
2707 : const char CPL_DLL *GDALMDArrayGetName(GDALMDArrayH hArray);
2708 : const char CPL_DLL *GDALMDArrayGetFullName(GDALMDArrayH hArray);
2709 : GUInt64 CPL_DLL GDALMDArrayGetTotalElementsCount(GDALMDArrayH hArray);
2710 : size_t CPL_DLL GDALMDArrayGetDimensionCount(GDALMDArrayH hArray);
2711 : GDALDimensionH CPL_DLL *
2712 : GDALMDArrayGetDimensions(GDALMDArrayH hArray,
2713 : size_t *pnCount) CPL_WARN_UNUSED_RESULT;
2714 : GDALExtendedDataTypeH CPL_DLL GDALMDArrayGetDataType(GDALMDArrayH hArray)
2715 : CPL_WARN_UNUSED_RESULT;
2716 : int CPL_DLL GDALMDArrayRead(GDALMDArrayH hArray, const GUInt64 *arrayStartIdx,
2717 : const size_t *count, const GInt64 *arrayStep,
2718 : const GPtrDiff_t *bufferStride,
2719 : GDALExtendedDataTypeH bufferDatatype,
2720 : void *pDstBuffer, const void *pDstBufferAllocStart,
2721 : size_t nDstBufferllocSize);
2722 : int CPL_DLL GDALMDArrayWrite(GDALMDArrayH hArray, const GUInt64 *arrayStartIdx,
2723 : const size_t *count, const GInt64 *arrayStep,
2724 : const GPtrDiff_t *bufferStride,
2725 : GDALExtendedDataTypeH bufferDatatype,
2726 : const void *pSrcBuffer,
2727 : const void *psrcBufferAllocStart,
2728 : size_t nSrcBufferllocSize);
2729 : int CPL_DLL GDALMDArrayAdviseRead(GDALMDArrayH hArray,
2730 : const GUInt64 *arrayStartIdx,
2731 : const size_t *count);
2732 : int CPL_DLL GDALMDArrayAdviseReadEx(GDALMDArrayH hArray,
2733 : const GUInt64 *arrayStartIdx,
2734 : const size_t *count,
2735 : CSLConstList papszOptions);
2736 : GDALAttributeH CPL_DLL GDALMDArrayGetAttribute(
2737 : GDALMDArrayH hArray, const char *pszName) CPL_WARN_UNUSED_RESULT;
2738 : GDALAttributeH CPL_DLL *
2739 : GDALMDArrayGetAttributes(GDALMDArrayH hArray, size_t *pnCount,
2740 : CSLConstList papszOptions) CPL_WARN_UNUSED_RESULT;
2741 : GDALAttributeH CPL_DLL GDALMDArrayCreateAttribute(
2742 : GDALMDArrayH hArray, const char *pszName, size_t nDimensions,
2743 : const GUInt64 *panDimensions, GDALExtendedDataTypeH hEDT,
2744 : CSLConstList papszOptions) CPL_WARN_UNUSED_RESULT;
2745 : bool CPL_DLL GDALMDArrayDeleteAttribute(GDALMDArrayH hArray,
2746 : const char *pszName,
2747 : CSLConstList papszOptions);
2748 : bool CPL_DLL GDALMDArrayResize(GDALMDArrayH hArray,
2749 : const GUInt64 *panNewDimSizes,
2750 : CSLConstList papszOptions);
2751 : const void CPL_DLL *GDALMDArrayGetRawNoDataValue(GDALMDArrayH hArray);
2752 : double CPL_DLL GDALMDArrayGetNoDataValueAsDouble(GDALMDArrayH hArray,
2753 : int *pbHasNoDataValue);
2754 : int64_t CPL_DLL GDALMDArrayGetNoDataValueAsInt64(GDALMDArrayH hArray,
2755 : int *pbHasNoDataValue);
2756 : uint64_t CPL_DLL GDALMDArrayGetNoDataValueAsUInt64(GDALMDArrayH hArray,
2757 : int *pbHasNoDataValue);
2758 : int CPL_DLL GDALMDArraySetRawNoDataValue(GDALMDArrayH hArray, const void *);
2759 : int CPL_DLL GDALMDArraySetNoDataValueAsDouble(GDALMDArrayH hArray,
2760 : double dfNoDataValue);
2761 : int CPL_DLL GDALMDArraySetNoDataValueAsInt64(GDALMDArrayH hArray,
2762 : int64_t nNoDataValue);
2763 : int CPL_DLL GDALMDArraySetNoDataValueAsUInt64(GDALMDArrayH hArray,
2764 : uint64_t nNoDataValue);
2765 : int CPL_DLL GDALMDArraySetScale(GDALMDArrayH hArray, double dfScale);
2766 : int CPL_DLL GDALMDArraySetScaleEx(GDALMDArrayH hArray, double dfScale,
2767 : GDALDataType eStorageType);
2768 : double CPL_DLL GDALMDArrayGetScale(GDALMDArrayH hArray, int *pbHasValue);
2769 : double CPL_DLL GDALMDArrayGetScaleEx(GDALMDArrayH hArray, int *pbHasValue,
2770 : GDALDataType *peStorageType);
2771 : int CPL_DLL GDALMDArraySetOffset(GDALMDArrayH hArray, double dfOffset);
2772 : int CPL_DLL GDALMDArraySetOffsetEx(GDALMDArrayH hArray, double dfOffset,
2773 : GDALDataType eStorageType);
2774 : double CPL_DLL GDALMDArrayGetOffset(GDALMDArrayH hArray, int *pbHasValue);
2775 : double CPL_DLL GDALMDArrayGetOffsetEx(GDALMDArrayH hArray, int *pbHasValue,
2776 : GDALDataType *peStorageType);
2777 : GUInt64 CPL_DLL *GDALMDArrayGetBlockSize(GDALMDArrayH hArray, size_t *pnCount);
2778 : int CPL_DLL GDALMDArraySetUnit(GDALMDArrayH hArray, const char *);
2779 : const char CPL_DLL *GDALMDArrayGetUnit(GDALMDArrayH hArray);
2780 : int CPL_DLL GDALMDArraySetSpatialRef(GDALMDArrayH, OGRSpatialReferenceH);
2781 : OGRSpatialReferenceH CPL_DLL GDALMDArrayGetSpatialRef(GDALMDArrayH hArray);
2782 : size_t CPL_DLL *GDALMDArrayGetProcessingChunkSize(GDALMDArrayH hArray,
2783 : size_t *pnCount,
2784 : size_t nMaxChunkMemory);
2785 : CSLConstList CPL_DLL GDALMDArrayGetStructuralInfo(GDALMDArrayH hArray);
2786 : GDALMDArrayH CPL_DLL GDALMDArrayGetView(GDALMDArrayH hArray,
2787 : const char *pszViewExpr);
2788 : GDALMDArrayH CPL_DLL GDALMDArrayTranspose(GDALMDArrayH hArray,
2789 : size_t nNewAxisCount,
2790 : const int *panMapNewAxisToOldAxis);
2791 : GDALMDArrayH CPL_DLL GDALMDArrayGetUnscaled(GDALMDArrayH hArray);
2792 : GDALMDArrayH CPL_DLL GDALMDArrayGetMask(GDALMDArrayH hArray,
2793 : CSLConstList papszOptions);
2794 : GDALDatasetH CPL_DLL GDALMDArrayAsClassicDataset(GDALMDArrayH hArray,
2795 : size_t iXDim, size_t iYDim);
2796 : GDALDatasetH CPL_DLL GDALMDArrayAsClassicDatasetEx(GDALMDArrayH hArray,
2797 : size_t iXDim, size_t iYDim,
2798 : GDALGroupH hRootGroup,
2799 : CSLConstList papszOptions);
2800 : CPLErr CPL_DLL GDALMDArrayGetStatistics(
2801 : GDALMDArrayH hArray, GDALDatasetH, int bApproxOK, int bForce,
2802 : double *pdfMin, double *pdfMax, double *pdfMean, double *pdfStdDev,
2803 : GUInt64 *pnValidCount, GDALProgressFunc pfnProgress, void *pProgressData);
2804 : int CPL_DLL GDALMDArrayComputeStatistics(GDALMDArrayH hArray, GDALDatasetH,
2805 : int bApproxOK, double *pdfMin,
2806 : double *pdfMax, double *pdfMean,
2807 : double *pdfStdDev,
2808 : GUInt64 *pnValidCount,
2809 : GDALProgressFunc, void *pProgressData);
2810 : int CPL_DLL GDALMDArrayComputeStatisticsEx(
2811 : GDALMDArrayH hArray, GDALDatasetH, int bApproxOK, double *pdfMin,
2812 : double *pdfMax, double *pdfMean, double *pdfStdDev, GUInt64 *pnValidCount,
2813 : GDALProgressFunc, void *pProgressData, CSLConstList papszOptions);
2814 : GDALMDArrayH CPL_DLL GDALMDArrayGetResampled(GDALMDArrayH hArray,
2815 : size_t nNewDimCount,
2816 : const GDALDimensionH *pahNewDims,
2817 : GDALRIOResampleAlg resampleAlg,
2818 : OGRSpatialReferenceH hTargetSRS,
2819 : CSLConstList papszOptions);
2820 : GDALMDArrayH CPL_DLL GDALMDArrayGetGridded(
2821 : GDALMDArrayH hArray, const char *pszGridOptions, GDALMDArrayH hXArray,
2822 : GDALMDArrayH hYArray, CSLConstList papszOptions) CPL_WARN_UNUSED_RESULT;
2823 :
2824 : GDALMDArrayH CPL_DLL *
2825 : GDALMDArrayGetCoordinateVariables(GDALMDArrayH hArray,
2826 : size_t *pnCount) CPL_WARN_UNUSED_RESULT;
2827 :
2828 : GDALMDArrayH CPL_DLL *
2829 : GDALMDArrayGetMeshGrid(const GDALMDArrayH *pahInputArrays,
2830 : size_t nCountInputArrays, size_t *pnCountOutputArrays,
2831 : CSLConstList papszOptions) CPL_WARN_UNUSED_RESULT;
2832 :
2833 : #ifdef __cplusplus
2834 : extern "C++"
2835 : {
2836 : #endif
2837 :
2838 : /** Information on a raw block of a GDALMDArray
2839 : *
2840 : * @since 3.12
2841 : */
2842 : struct
2843 : #ifdef __cplusplus
2844 : CPL_DLL
2845 : #endif
2846 : GDALMDArrayRawBlockInfo
2847 : {
2848 : /** Filename into which the raw block is found */
2849 : char *pszFilename;
2850 : /** File offset within pszFilename of the start of the raw block */
2851 : uint64_t nOffset;
2852 : /** Size in bytes of the raw block */
2853 : uint64_t nSize;
2854 : /** NULL or Null-terminated list of driver specific information on the
2855 : * raw block */
2856 : char **papszInfo;
2857 : /** In-memory buffer of nSize bytes. When this is set, pszFilename and
2858 : * nOffset are set to NULL.
2859 : *
2860 : * When using C++ copy constructor or copy-assignment operator, if
2861 : * a memory allocation fails, a CPLError() will be emitted and this
2862 : * field will be NULL, but nSize not zero.
2863 : */
2864 : GByte *pabyInlineData;
2865 :
2866 : #ifdef __cplusplus
2867 : /*! @cond Doxygen_Suppress */
2868 23 : inline GDALMDArrayRawBlockInfo()
2869 23 : : pszFilename(nullptr), nOffset(0), nSize(0), papszInfo(nullptr),
2870 23 : pabyInlineData(nullptr)
2871 : {
2872 23 : }
2873 :
2874 : ~GDALMDArrayRawBlockInfo();
2875 :
2876 : void clear();
2877 :
2878 : GDALMDArrayRawBlockInfo(const GDALMDArrayRawBlockInfo &);
2879 : GDALMDArrayRawBlockInfo &operator=(const GDALMDArrayRawBlockInfo &);
2880 : GDALMDArrayRawBlockInfo(GDALMDArrayRawBlockInfo &&);
2881 : GDALMDArrayRawBlockInfo &operator=(GDALMDArrayRawBlockInfo &&);
2882 : /*! @endcond */
2883 : #endif
2884 : };
2885 :
2886 : #ifdef __cplusplus
2887 : }
2888 : #endif
2889 :
2890 : /*! @cond Doxygen_Suppress */
2891 : typedef struct GDALMDArrayRawBlockInfo GDALMDArrayRawBlockInfo;
2892 : /*! @endcond */
2893 :
2894 : GDALMDArrayRawBlockInfo CPL_DLL *GDALMDArrayRawBlockInfoCreate(void);
2895 : void CPL_DLL
2896 : GDALMDArrayRawBlockInfoRelease(GDALMDArrayRawBlockInfo *psBlockInfo);
2897 : bool CPL_DLL GDALMDArrayGetRawBlockInfo(GDALMDArrayH hArray,
2898 : const uint64_t *panBlockCoordinates,
2899 : GDALMDArrayRawBlockInfo *psBlockInfo);
2900 :
2901 : void CPL_DLL GDALReleaseArrays(GDALMDArrayH *arrays, size_t nCount);
2902 : int CPL_DLL GDALMDArrayCache(GDALMDArrayH hArray, CSLConstList papszOptions);
2903 : bool CPL_DLL GDALMDArrayRename(GDALMDArrayH hArray, const char *pszNewName);
2904 :
2905 : GDALRasterAttributeTableH CPL_DLL GDALCreateRasterAttributeTableFromMDArrays(
2906 : GDALRATTableType eTableType, int nArrays, const GDALMDArrayH *ahArrays,
2907 : const GDALRATFieldUsage *paeUsages);
2908 :
2909 : void CPL_DLL GDALAttributeRelease(GDALAttributeH hAttr);
2910 : void CPL_DLL GDALReleaseAttributes(GDALAttributeH *attributes, size_t nCount);
2911 : const char CPL_DLL *GDALAttributeGetName(GDALAttributeH hAttr);
2912 : const char CPL_DLL *GDALAttributeGetFullName(GDALAttributeH hAttr);
2913 : GUInt64 CPL_DLL GDALAttributeGetTotalElementsCount(GDALAttributeH hAttr);
2914 : size_t CPL_DLL GDALAttributeGetDimensionCount(GDALAttributeH hAttr);
2915 : GUInt64 CPL_DLL *
2916 : GDALAttributeGetDimensionsSize(GDALAttributeH hAttr,
2917 : size_t *pnCount) CPL_WARN_UNUSED_RESULT;
2918 : GDALExtendedDataTypeH CPL_DLL GDALAttributeGetDataType(GDALAttributeH hAttr)
2919 : CPL_WARN_UNUSED_RESULT;
2920 : GByte CPL_DLL *GDALAttributeReadAsRaw(GDALAttributeH hAttr,
2921 : size_t *pnSize) CPL_WARN_UNUSED_RESULT;
2922 : void CPL_DLL GDALAttributeFreeRawResult(GDALAttributeH hAttr, GByte *raw,
2923 : size_t nSize);
2924 : const char CPL_DLL *GDALAttributeReadAsString(GDALAttributeH hAttr);
2925 : int CPL_DLL GDALAttributeReadAsInt(GDALAttributeH hAttr);
2926 : int64_t CPL_DLL GDALAttributeReadAsInt64(GDALAttributeH hAttr);
2927 : double CPL_DLL GDALAttributeReadAsDouble(GDALAttributeH hAttr);
2928 : char CPL_DLL **
2929 : GDALAttributeReadAsStringArray(GDALAttributeH hAttr) CPL_WARN_UNUSED_RESULT;
2930 : int CPL_DLL *GDALAttributeReadAsIntArray(GDALAttributeH hAttr, size_t *pnCount)
2931 : CPL_WARN_UNUSED_RESULT;
2932 : int64_t CPL_DLL *
2933 : GDALAttributeReadAsInt64Array(GDALAttributeH hAttr,
2934 : size_t *pnCount) CPL_WARN_UNUSED_RESULT;
2935 : double CPL_DLL *
2936 : GDALAttributeReadAsDoubleArray(GDALAttributeH hAttr,
2937 : size_t *pnCount) CPL_WARN_UNUSED_RESULT;
2938 : int CPL_DLL GDALAttributeWriteRaw(GDALAttributeH hAttr, const void *, size_t);
2939 : int CPL_DLL GDALAttributeWriteString(GDALAttributeH hAttr, const char *);
2940 : int CPL_DLL GDALAttributeWriteStringArray(GDALAttributeH hAttr, CSLConstList);
2941 : int CPL_DLL GDALAttributeWriteInt(GDALAttributeH hAttr, int);
2942 : int CPL_DLL GDALAttributeWriteIntArray(GDALAttributeH hAttr, const int *,
2943 : size_t);
2944 : int CPL_DLL GDALAttributeWriteInt64(GDALAttributeH hAttr, int64_t);
2945 : int CPL_DLL GDALAttributeWriteInt64Array(GDALAttributeH hAttr, const int64_t *,
2946 : size_t);
2947 : int CPL_DLL GDALAttributeWriteDouble(GDALAttributeH hAttr, double);
2948 : int CPL_DLL GDALAttributeWriteDoubleArray(GDALAttributeH hAttr, const double *,
2949 : size_t);
2950 : bool CPL_DLL GDALAttributeRename(GDALAttributeH hAttr, const char *pszNewName);
2951 :
2952 : void CPL_DLL GDALDimensionRelease(GDALDimensionH hDim);
2953 : void CPL_DLL GDALReleaseDimensions(GDALDimensionH *dims, size_t nCount);
2954 : const char CPL_DLL *GDALDimensionGetName(GDALDimensionH hDim);
2955 : const char CPL_DLL *GDALDimensionGetFullName(GDALDimensionH hDim);
2956 : const char CPL_DLL *GDALDimensionGetType(GDALDimensionH hDim);
2957 : const char CPL_DLL *GDALDimensionGetDirection(GDALDimensionH hDim);
2958 : GUInt64 CPL_DLL GDALDimensionGetSize(GDALDimensionH hDim);
2959 : GDALMDArrayH CPL_DLL GDALDimensionGetIndexingVariable(GDALDimensionH hDim)
2960 : CPL_WARN_UNUSED_RESULT;
2961 : int CPL_DLL GDALDimensionSetIndexingVariable(GDALDimensionH hDim,
2962 : GDALMDArrayH hArray);
2963 : bool CPL_DLL GDALDimensionRename(GDALDimensionH hDim, const char *pszNewName);
2964 :
2965 : CPL_C_END
2966 :
2967 : #endif /* ndef GDAL_H_INCLUDED */
|
