#include <imagebuf.h>

Inheritance diagram for ImageBuf::Iterator< BUFT, USERT >:

Public Member Functions
	Iterator (ImageBuf &ib, WrapMode wrap=WrapDefault)

	Iterator (ImageBuf &ib, int x, int y, int z=0, WrapMode wrap=WrapDefault)

	Iterator (ImageBuf &ib, const ROI &roi, WrapMode wrap=WrapDefault)
	Construct read-write iteration region from ImageBuf and ROI. More...

	Iterator (ImageBuf &ib, int xbegin, int xend, int ybegin, int yend, int zbegin=0, int zend=1, WrapMode wrap=WrapDefault)

	Iterator (Iterator &i)

	~Iterator ()

DataArrayProxy< BUFT, USERT > &	operator* ()

USERT	operator[] (int i) const

DataProxy< BUFT, USERT >	operator[] (int i)

void *	rawptr () const

void	set_deep_samples (int n)

void	set_deep_value (int c, int s, float value)

void	set_deep_value (int c, int s, uint32_t value)

Public Member Functions inherited from ImageBuf::IteratorBase
int	x () const
	Retrieve the current x location of the iterator. More...

int	y () const
	Retrieve the current y location of the iterator. More...

int	z () const
	Retrieve the current z location of the iterator. More...

bool	valid () const
	Is the current location within the designated iteration range? More...

bool	valid (int x_, int y_, int z_=0) const

bool	exists (int x_, int y_, int z_=0) const

bool	exists () const

bool	done () const
	Are we finished iterating over the region? More...

int	deep_samples () const
	Retrieve the number of deep data samples at this pixel. More...

WrapMode	wrap () const
	Return the wrap mode. More...

void OIIO_API	pos (int x_, int y_, int z_=0)

void	operator++ ()

void	operator++ (int)
	Increment to the next pixel in the region. More...

ROI	range () const
	Return the iteration range. More...

void OIIO_API	rerange (int xbegin, int xend, int ybegin, int yend, int zbegin, int zend, WrapMode wrap=WrapDefault)

const void *	rawptr () const

float	deep_value (int c, int s) const
	Retrieve the deep data value of sample s of channel c. More...

uint32_t	deep_value_uint (int c, int s) const

bool	localpixels () const

bool	has_error () const

void	clear_error ()

Additional Inherited Members
Protected Member Functions inherited from ImageBuf::IteratorBase
OIIO_API	IteratorBase (const ImageBuf &ib, WrapMode wrap, bool write=false)

OIIO_API	IteratorBase (const ImageBuf &ib, int x, int y, int z, WrapMode wrap, bool write=false)

OIIO_API	IteratorBase (const ImageBuf &ib, const ROI &roi, WrapMode wrap, bool write=false)
	Construct valid iteration region from ImageBuf and ROI. More...

OIIO_API	IteratorBase (const ImageBuf &ib, int xbegin, int xend, int ybegin, int yend, int zbegin, int zend, WrapMode wrap, bool write=false)

OIIO_API	IteratorBase (const IteratorBase &i)
	Copy constructor. More...

OIIO_API const IteratorBase &	operator= (const IteratorBase &i)
	Assign one IteratorBase to another. More...

	~IteratorBase ()

void OIIO_API	init_ib (WrapMode wrap, bool write)

void OIIO_API	range_is_image ()

void	pos_xincr ()

void OIIO_API	pos_xincr_local_past_end ()

void OIIO_API	pos_done ()

void OIIO_API	release_tile ()

Protected Attributes inherited from ImageBuf::IteratorBase
const ImageBuf *	m_ib = nullptr

bool	m_valid = false

bool	m_exists = false

bool	m_deep = false

bool	m_localpixels = false

int	m_img_xbegin

int	m_img_xend

int	m_img_ybegin

int	m_img_yend

int	m_img_zbegin

int	m_img_zend

int	m_rng_xbegin

int	m_rng_xend

int	m_rng_ybegin

int	m_rng_yend

int	m_rng_zbegin

int	m_rng_zend

int	m_x

int	m_y

int	m_z

pvt::ImageCacheTile *	m_tile = nullptr

int	m_tilexbegin

int	m_tileybegin

int	m_tilezbegin

int	m_tilexend

int	m_nchannels

stride_t	m_pixel_stride

char *	m_proxydata = nullptr

WrapMode	m_wrap = WrapBlack

bool	m_readerror = false

Detailed Description

template<typename BUFT, typename USERT = float>
class ImageBuf::Iterator< BUFT, USERT >

Templated class for referring to an individual pixel in an ImageBuf, iterating over the pixels of an ImageBuf, or iterating over the pixels of a specified region of the ImageBuf [xbegin..xend) X [ybegin..yend). It is templated on BUFT, the type known to be in the internal representation of the ImageBuf, and USERT, the type that the user wants to retrieve or set the data (defaulting to float). the whole idea is to allow this:

ImageBuf img (...);
ImageBuf::Iterator<float> pixel (img, 0, 512, 0, 512);
for (  ;  ! pixel.done();  ++pixel) {
    for (int c = 0;  c < img.nchannels();  ++c) {
        float x = pixel[c];
        pixel[c] = ...;
    }
}

Definition at line 1432 of file imagebuf.h.