GDAL

gdal_vrt.h
Go to the documentation of this file.
1/******************************************************************************
2 *
3 * Project: Virtual GDAL Datasets
4 * Purpose: C/Public declarations of virtual GDAL dataset objects.
5 * Author: Andrey Kiselev, dron@ak4719.spb.edu
6 *
7 ******************************************************************************
8 * Copyright (c) 2007, Andrey Kiselev <dron@ak4719.spb.edu>
9 *
10 * SPDX-License-Identifier: MIT
11 ****************************************************************************/
12
13#ifndef GDAL_VRT_H_INCLUDED
14#define GDAL_VRT_H_INCLUDED
15
22#include "cpl_error.h"
23#include "cpl_minixml.h"
24#include "cpl_port.h"
25#include "gdal.h"
26
28#define VRT_NODATA_UNSET -1234.56
29
30 CPL_C_START
31
33 typedef CPLErr (*VRTImageReadFunc)(void *hCBData, int nXOff, int nYOff,
34 int nXSize, int nYSize, void *pData);
35
36/* -------------------------------------------------------------------- */
37/* Define handle types related to various VRT dataset classes. */
38/* -------------------------------------------------------------------- */
40 typedef void *VRTAveragedSourceH;
41 typedef void *VRTAverageFilteredSourceH;
42 typedef void *VRTComplexSourceH;
43 typedef void *VRTDerivedRasterBandH;
44 typedef void *VRTDriverH;
45 typedef void *VRTFilteredSourceH;
46 typedef void *VRTFuncSourceH;
47 typedef void *VRTKernelFilteredSourceH;
48 typedef void *VRTRasterBandH;
49 typedef void *VRTRawRasterBandH;
50 typedef void *VRTSimpleSourceH;
51 typedef void *VRTSourceH;
52 typedef void *VRTWarpedDatasetH;
53 typedef void *VRTWarpedRasterBandH;
57 typedef void *VRTDatasetH;
59 typedef void *VRTSourcedRasterBandH;
60
61/* ==================================================================== */
62/* VRTDataset class. */
63/* ==================================================================== */
64
65 VRTDatasetH CPL_DLL CPL_STDCALL VRTCreate(int, int);
66 void CPL_DLL CPL_STDCALL VRTFlushCache(VRTDatasetH);
67 CPLXMLNode CPL_DLL *CPL_STDCALL VRTSerializeToXML(VRTDatasetH, const char *);
68 int CPL_DLL CPL_STDCALL VRTAddBand(VRTDatasetH, GDALDataType, char **);
69
70/* ==================================================================== */
71/* VRTSourcedRasterBand class. */
72/* ==================================================================== */
73
74 CPLErr CPL_STDCALL VRTAddSource(VRTSourcedRasterBandH, VRTSourceH);
75 CPLErr CPL_DLL CPL_STDCALL VRTAddSimpleSource(VRTSourcedRasterBandH,
76 GDALRasterBandH, int, int, int,
77 int, int, int, int, int,
78 const char *, double);
79 CPLErr CPL_DLL CPL_STDCALL VRTAddComplexSource(VRTSourcedRasterBandH,
80 GDALRasterBandH, int, int, int,
81 int, int, int, int, int, double,
82 double, double);
83 CPLErr CPL_DLL CPL_STDCALL VRTAddFuncSource(VRTSourcedRasterBandH,
84 VRTImageReadFunc, void *, double);
85
86 CPL_C_END
87
88#endif /* GDAL_VRT_H_INCLUDED */
cpl_error.h
CPL error handling services.
CPLErr
CPLErr
Error category.
Definition cpl_error.h:37
cpl_minixml.h
Definitions for CPL mini XML Parser/Serializer.
cpl_port.h
Core portability definitions for CPL.
CPL_C_END
#define CPL_C_END
Macro to end a block of C symbols.
Definition cpl_port.h:289
CPL_C_START
#define CPL_C_START
Macro to start a block of C symbols.
Definition cpl_port.h:285
gdal.h
Public (C callable) GDAL entry points.
GDALDataType
GDALDataType
Definition gdal.h:48
GDALRasterBandH
void * GDALRasterBandH
Opaque type used for the C bindings of the C++ GDALRasterBand class.
Definition gdal_fwd.h:45
VRTDatasetH
void * VRTDatasetH
Opaque type for a VRT dataset.
Definition gdal_vrt.h:57
VRTImageReadFunc
CPLErr(* VRTImageReadFunc)(void *hCBData, int nXOff, int nYOff, int nXSize, int nYSize, void *pData)
Type for a function that returns the pixel data in a provided window.
Definition gdal_vrt.h:33
VRTCreate
VRTDatasetH VRTCreate(int, int)
Definition vrtdataset.cpp:77
VRTFlushCache
void VRTFlushCache(VRTDatasetH)
Definition vrtdataset.cpp:243
VRTSourcedRasterBandH
void * VRTSourcedRasterBandH
Opaque type for a VRT sourced raster band.
Definition gdal_vrt.h:59
VRTAddFuncSource
CPLErr VRTAddFuncSource(VRTSourcedRasterBandH, VRTImageReadFunc, void *, double)
Definition vrtsourcedrasterband.cpp:2758
VRTAddSource
CPLErr VRTAddSource(VRTSourcedRasterBandH, VRTSourceH)
Definition vrtsourcedrasterband.cpp:2260
VRTAddComplexSource
CPLErr VRTAddComplexSource(VRTSourcedRasterBandH, GDALRasterBandH, int, int, int, int, int, int, int, int, double, double, double)
Definition vrtsourcedrasterband.cpp:2707
VRTSerializeToXML
CPLXMLNode * VRTSerializeToXML(VRTDatasetH, const char *)
Definition vrtdataset.cpp:411
VRTAddSimpleSource
CPLErr VRTAddSimpleSource(VRTSourcedRasterBandH, GDALRasterBandH, int, int, int, int, int, int, int, int, const char *, double)
Definition vrtsourcedrasterband.cpp:2604
VRTAddBand
int VRTAddBand(VRTDatasetH, GDALDataType, char **)
Definition vrtdataset.cpp:1960
CPLXMLNode
Document node structure.
Definition cpl_minixml.h:54