This reference page is linked to from the following overview topics: Images.

Detailed Description

Iterates over a specified region of an image in optimal order.

It does not lock the region of the image or otherwise cause it to be present in CPU memory -- for that, use ImgLockPageIterator... Note that the regions returned are the tiles, stripes or pages that intersect the requested region -- they may encompass a larger area than you request, or even the entire image.

Definition at line 1010 of file image.h.

#include <image.h>

Inheritance diagram for ImgPageIterator:

[legend]

List of all members.

Public Member Functions
	ImgPageIterator (Image img, const ImgTile srcTile=0, bool writing=false)
	Create an iterator to cover the specified region of the image.
virtual	~ImgPageIterator ()
virtual bool	next ()
void *	dataPtr ()
Protected Attributes
void *	m_BlindData
Image *	m_Image
int	m_Type
void *	m_PixelData
ImgTile	m_SrcTile

Constructor & Destructor Documentation

ImgPageIterator	(	Image *	img,
		const ImgTile *	srcTile = `0`,
		bool	writing = `false`
	)

Create an iterator to cover the specified region of the image.

Parameters:

img	A pointer to the image that you are iterating over
srcTile	A const pointer to the region of the image to be iterated over -- NULL means the bounds of the image

virtual ~ImgPageIterator ( ) [virtual]