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 * Permission is hereby granted, free of charge, to any person obtaining a
12 * copy of this software and associated documentation files (the "Software"),
13 * to deal in the Software without restriction, including without limitation
14 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
15 * and/or sell copies of the Software, and to permit persons to whom the
16 * Software is furnished to do so, subject to the following conditions:
17 *
18 * The above copyright notice and this permission notice shall be included
19 * in all copies or substantial portions of the Software.
20 *
21 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
22 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
24 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
26 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
27 * DEALINGS IN THE SOFTWARE.
28 ****************************************************************************/
29
30#ifndef GDAL_VRT_H_INCLUDED
31#define GDAL_VRT_H_INCLUDED
32
39#include "cpl_error.h"
40#include "cpl_minixml.h"
41#include "cpl_port.h"
42#include "gdal.h"
43
45#define VRT_NODATA_UNSET -1234.56
46
47 CPL_C_START
48
50 typedef CPLErr (*VRTImageReadFunc)(void *hCBData, int nXOff, int nYOff,
51 int nXSize, int nYSize, void *pData);
52
53/* -------------------------------------------------------------------- */
54/* Define handle types related to various VRT dataset classes. */
55/* -------------------------------------------------------------------- */
57typedef void *VRTAveragedSourceH;
58typedef void *VRTAverageFilteredSourceH;
59typedef void *VRTComplexSourceH;
60typedef void *VRTDerivedRasterBandH;
61typedef void *VRTDriverH;
62typedef void *VRTFilteredSourceH;
63typedef void *VRTFuncSourceH;
64typedef void *VRTKernelFilteredSourceH;
65typedef void *VRTRasterBandH;
66typedef void *VRTRawRasterBandH;
67typedef void *VRTSimpleSourceH;
68typedef void *VRTSourceH;
69typedef void *VRTWarpedDatasetH;
70typedef void *VRTWarpedRasterBandH;
74 typedef void *VRTDatasetH;
76 typedef void *VRTSourcedRasterBandH;
77
78/* ==================================================================== */
79/* VRTDataset class. */
80/* ==================================================================== */
81
82 VRTDatasetH CPL_DLL CPL_STDCALL VRTCreate(int, int);
83void CPL_DLL CPL_STDCALL VRTFlushCache(VRTDatasetH);
84 CPLXMLNode CPL_DLL *CPL_STDCALL VRTSerializeToXML(VRTDatasetH, const char *);
85int CPL_DLL CPL_STDCALL VRTAddBand(VRTDatasetH, GDALDataType, char **);
86
87/* ==================================================================== */
88/* VRTSourcedRasterBand class. */
89/* ==================================================================== */
90
91 CPLErr CPL_STDCALL VRTAddSource(VRTSourcedRasterBandH, VRTSourceH);
92 CPLErr CPL_DLL CPL_STDCALL VRTAddSimpleSource(VRTSourcedRasterBandH,
93 GDALRasterBandH, int, int, int,
94 int, int, int, int, int,
95 const char *, double);
96 CPLErr CPL_DLL CPL_STDCALL VRTAddComplexSource(VRTSourcedRasterBandH,
97 GDALRasterBandH, int, int, int,
98 int, int, int, int, int, double,
99 double, double);
100 CPLErr CPL_DLL CPL_STDCALL VRTAddFuncSource(VRTSourcedRasterBandH,
101 VRTImageReadFunc, void *, double);
102
103 CPL_C_END
104
105#endif /* GDAL_VRT_H_INCLUDED */
cpl_error.h
CPL error handling services.
CPLErr
CPLErr
Error category.
Definition: cpl_error.h:53
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:299
CPL_C_START
#define CPL_C_START
Macro to start a block of C symbols.
Definition: cpl_port.h:295
gdal.h
Public (C callable) GDAL entry points.
GDALDataType
GDALDataType
Definition: gdal.h:64
GDALRasterBandH
void * GDALRasterBandH
Opaque type used for the C bindings of the C++ GDALRasterBand class.
Definition: gdal.h:294
VRTDatasetH
void * VRTDatasetH
Opaque type for a VRT dataset.
Definition: gdal_vrt.h:74
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:50
VRTCreate
VRTDatasetH VRTCreate(int, int)
Definition: vrtdataset.cpp:82
VRTFlushCache
void VRTFlushCache(VRTDatasetH)
Definition: vrtdataset.cpp:229
VRTSourcedRasterBandH
void * VRTSourcedRasterBandH
Opaque type for a VRT sourced raster band.
Definition: gdal_vrt.h:76
VRTAddFuncSource
CPLErr VRTAddFuncSource(VRTSourcedRasterBandH, VRTImageReadFunc, void *, double)
Definition: vrtsourcedrasterband.cpp:2296
VRTAddSource
CPLErr VRTAddSource(VRTSourcedRasterBandH, VRTSourceH)
Definition: vrtsourcedrasterband.cpp:1798
VRTAddComplexSource
CPLErr VRTAddComplexSource(VRTSourcedRasterBandH, GDALRasterBandH, int, int, int, int, int, int, int, int, double, double, double)
Definition: vrtsourcedrasterband.cpp:2245
VRTSerializeToXML
CPLXMLNode * VRTSerializeToXML(VRTDatasetH, const char *)
Definition: vrtdataset.cpp:399
VRTAddSimpleSource
CPLErr VRTAddSimpleSource(VRTSourcedRasterBandH, GDALRasterBandH, int, int, int, int, int, int, int, int, const char *, double)
Definition: vrtsourcedrasterband.cpp:2142
VRTAddBand
int VRTAddBand(VRTDatasetH, GDALDataType, char **)
Definition: vrtdataset.cpp:1805
CPLXMLNode
Document node structure.
Definition: cpl_minixml.h:71