gdal_vrt.h File Reference

#include "cpl_error.h"
#include "cpl_minixml.h"
#include "cpl_port.h"
#include "gdal.h"

Go to the source code of this file.

Macros
#define	VRT_NODATA_UNSET   -1234.56

Typedefs
typedef void *	VRTDatasetH
typedef void *	VRTSourcedRasterBandH

Functions
VRTDatasetH CPL_DLL CPL_STDCALL	VRTCreate (int, int)
void CPL_DLL CPL_STDCALL	VRTFlushCache (VRTDatasetH)
CPLXMLNode CPL_DLL *CPL_STDCALL	VRTSerializeToXML (VRTDatasetH, const char *)
int CPL_DLL CPL_STDCALL	VRTAddBand (VRTDatasetH, GDALDataType, char **)
CPLErr CPL_STDCALL	VRTAddSource (VRTSourcedRasterBandH, VRTSourceH)
CPLErr CPL_DLL CPL_STDCALL	VRTAddSimpleSource (VRTSourcedRasterBandH, GDALRasterBandH, int, int, int, int, int, int, int, int, const char *, double)
CPLErr CPL_DLL CPL_STDCALL	VRTAddComplexSource (VRTSourcedRasterBandH, GDALRasterBandH, int, int, int, int, int, int, int, int, double, double, double)
CPLErr CPL_DLL CPL_STDCALL	VRTAddFuncSource (VRTSourcedRasterBandH, VRTImageReadFunc, void *, double)

Variables
CPL_C_START typedef CPLErr(*	VRTImageReadFunc )(void *hCBData, int nXOff, int nYOff, int nXSize, int nYSize, void *pData)

Detailed Description

Public (C callable) entry points for virtual GDAL dataset objects.

Macro Definition Documentation

VRT_NODATA_UNSET

#define VRT_NODATA_UNSET   -1234.56

Special value to indicate that nodata is not set

Typedef Documentation

VRTDatasetH

typedef void* VRTDatasetH

Opaque type for a VRT dataset

VRTSourcedRasterBandH

typedef void* VRTSourcedRasterBandH

Opaque type for a VRT sourced raster band

Function Documentation

VRTAddBand()

int CPL_DLL CPL_STDCALL VRTAddBand	(	VRTDatasetH	hDataset,
		GDALDataType	eType,
		char **	papszOptions
	)

See also

VRTDataset::VRTAddBand().

VRTAddComplexSource()

CPLErr CPL_DLL CPL_STDCALL VRTAddComplexSource	(	VRTSourcedRasterBandH	hVRTBand,
		GDALRasterBandH	hSrcBand,
		int	nSrcXOff,
		int	nSrcYOff,
		int	nSrcXSize,
		int	nSrcYSize,
		int	nDstXOff,
		int	nDstYOff,
		int	nDstXSize,
		int	nDstYSize,
		double	dfScaleOff,
		double	dfScaleRatio,
		double	dfNoDataValue
	)

See also

VRTSourcedRasterBand::AddComplexSource().

VRTAddFuncSource()

CPLErr CPL_DLL CPL_STDCALL VRTAddFuncSource	(	VRTSourcedRasterBandH	hVRTBand,
		VRTImageReadFunc	pfnReadFunc,
		void *	pCBData,
		double	dfNoDataValue
	)

See also

VRTSourcedRasterBand::AddFuncSource().

VRTAddSimpleSource()

CPLErr CPL_DLL CPL_STDCALL VRTAddSimpleSource	(	VRTSourcedRasterBandH	hVRTBand,
		GDALRasterBandH	hSrcBand,
		int	nSrcXOff,
		int	nSrcYOff,
		int	nSrcXSize,
		int	nSrcYSize,
		int	nDstXOff,
		int	nDstYOff,
		int	nDstXSize,
		int	nDstYSize,
		const char *	pszResampling,
		double	dfNoDataValue
	)

See also

VRTSourcedRasterBand::AddSimpleSource().

VRTAddSource()

CPLErr CPL_STDCALL VRTAddSource	(	VRTSourcedRasterBandH	hVRTBand,
		VRTSourceH	hNewSource
	)

See also

VRTSourcedRasterBand::AddSource().

VRTCreate()

VRTDatasetH CPL_DLL CPL_STDCALL VRTCreate	(	int	nXSize,
		int	nYSize
	)

See also

VRTDataset::VRTDataset()

VRTFlushCache()

void CPL_DLL CPL_STDCALL VRTFlushCache

(

VRTDatasetH

hDataset

)

See also

VRTDataset::FlushCache()

VRTSerializeToXML()

CPLXMLNode CPL_DLL* CPL_STDCALL VRTSerializeToXML	(	VRTDatasetH	hDataset,
		const char *	pszVRTPath
	)

See also

VRTDataset::SerializeToXML()

Variable Documentation

VRTImageReadFunc

CPL_C_START typedef 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