GDAL

gdal_vrt.h
Go to the documentation of this file.
1/******************************************************************************
2 * $Id$
3 *
4 * Project: Virtual GDAL Datasets
5 * Purpose: C/Public declarations of virtual GDAL dataset objects.
6 * Author: Andrey Kiselev, dron@ak4719.spb.edu
7 *
8 ******************************************************************************
9 * Copyright (c) 2007, Andrey Kiselev <dron@ak4719.spb.edu>
10 *
11 * SPDX-License-Identifier: MIT
12 ****************************************************************************/
13
14#ifndef GDAL_VRT_H_INCLUDED
15#define GDAL_VRT_H_INCLUDED
16
23#include "cpl_error.h"
24#include "cpl_minixml.h"
25#include "cpl_port.h"
26#include "gdal.h"
27
29#define VRT_NODATA_UNSET -1234.56
30
31 CPL_C_START
32
34 typedef CPLErr (*VRTImageReadFunc)(void *hCBData, int nXOff, int nYOff,
35 int nXSize, int nYSize, void *pData);
36
37/* -------------------------------------------------------------------- */
38/* Define handle types related to various VRT dataset classes. */
39/* -------------------------------------------------------------------- */
41 typedef void *VRTAveragedSourceH;
42 typedef void *VRTAverageFilteredSourceH;
43 typedef void *VRTComplexSourceH;
44 typedef void *VRTDerivedRasterBandH;
45 typedef void *VRTDriverH;
46 typedef void *VRTFilteredSourceH;
47 typedef void *VRTFuncSourceH;
48 typedef void *VRTKernelFilteredSourceH;
49 typedef void *VRTRasterBandH;
50 typedef void *VRTRawRasterBandH;
51 typedef void *VRTSimpleSourceH;
52 typedef void *VRTSourceH;
53 typedef void *VRTWarpedDatasetH;
54 typedef void *VRTWarpedRasterBandH;
58 typedef void *VRTDatasetH;
60 typedef void *VRTSourcedRasterBandH;
61
62/* ==================================================================== */
63/* VRTDataset class. */
64/* ==================================================================== */
65
66 VRTDatasetH CPL_DLL CPL_STDCALL VRTCreate(int, int);
67 void CPL_DLL CPL_STDCALL VRTFlushCache(VRTDatasetH);
68 CPLXMLNode CPL_DLL *CPL_STDCALL VRTSerializeToXML(VRTDatasetH, const char *);
69 int CPL_DLL CPL_STDCALL VRTAddBand(VRTDatasetH, GDALDataType, char **);
70
71/* ==================================================================== */
72/* VRTSourcedRasterBand class. */
73/* ==================================================================== */
74
75 CPLErr CPL_STDCALL VRTAddSource(VRTSourcedRasterBandH, VRTSourceH);
76 CPLErr CPL_DLL CPL_STDCALL VRTAddSimpleSource(VRTSourcedRasterBandH,
77 GDALRasterBandH, int, int, int,
78 int, int, int, int, int,
79 const char *, double);
80 CPLErr CPL_DLL CPL_STDCALL VRTAddComplexSource(VRTSourcedRasterBandH,
81 GDALRasterBandH, int, int, int,
82 int, int, int, int, int, double,
83 double, double);
84 CPLErr CPL_DLL CPL_STDCALL VRTAddFuncSource(VRTSourcedRasterBandH,
85 VRTImageReadFunc, void *, double);
86
87 CPL_C_END
88
89#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:283
CPL_C_START
#define CPL_C_START
Macro to start a block of C symbols.
Definition: cpl_port.h:279
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.h:379
VRTDatasetH
void * VRTDatasetH
Opaque type for a VRT dataset.
Definition: gdal_vrt.h:58
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:34
VRTCreate
VRTDatasetH VRTCreate(int, int)
Definition: vrtdataset.cpp:68
VRTFlushCache
void VRTFlushCache(VRTDatasetH)
Definition: vrtdataset.cpp:231
VRTSourcedRasterBandH
void * VRTSourcedRasterBandH
Opaque type for a VRT sourced raster band.
Definition: gdal_vrt.h:60
VRTAddFuncSource
CPLErr VRTAddFuncSource(VRTSourcedRasterBandH, VRTImageReadFunc, void *, double)
Definition: vrtsourcedrasterband.cpp:2591
VRTAddSource
CPLErr VRTAddSource(VRTSourcedRasterBandH, VRTSourceH)
Definition: vrtsourcedrasterband.cpp:2093
VRTAddComplexSource
CPLErr VRTAddComplexSource(VRTSourcedRasterBandH, GDALRasterBandH, int, int, int, int, int, int, int, int, double, double, double)
Definition: vrtsourcedrasterband.cpp:2540
VRTSerializeToXML
CPLXMLNode * VRTSerializeToXML(VRTDatasetH, const char *)
Definition: vrtdataset.cpp:401
VRTAddSimpleSource
CPLErr VRTAddSimpleSource(VRTSourcedRasterBandH, GDALRasterBandH, int, int, int, int, int, int, int, int, const char *, double)
Definition: vrtsourcedrasterband.cpp:2437
VRTAddBand
int VRTAddBand(VRTDatasetH, GDALDataType, char **)
Definition: vrtdataset.cpp:1810
CPLXMLNode
Document node structure.
Definition: cpl_minixml.h:55