optris::ImageIterator Class Reference

Iterates in a row major fashion over the image and grants read and write access to the pixels. More...

#include <ImageIterator.h>

Collaboration diagram for optris::ImageIterator:

Public Types
using	Container = std::vector<unsigned char>
	Container type storing the pixel values.

Public Member Functions
OTC_SDK_API	ImageIterator (Image &image) noexcept
	Constructor.
bool	hasNext () const noexcept
	Returns whether there is a next pixel.
OTC_SDK_API void	next ()
	Moves to the next pixel.
OTC_SDK_API Pixel	getPixel () const noexcept
	Returns the current pixel.
OTC_SDK_API void	setPixel (const Pixel &pixel) noexcept
	Sets the current pixel.
int	getIndex () const noexcept
	Returns the current pixel index.
int	getX () const noexcept
	Returns the x-coordinate of the current pixel.
int	getY () const noexcept
	Returns the y-coordinate of the current pixel.

Detailed Description

Iterates in a row major fashion over the image and grants read and write access to the pixels.

Potential width padding will be skipped.

Constructor & Destructor Documentation

ImageIterator()

OTC_SDK_API optris::ImageIterator::ImageIterator ( Image & image )

explicitnoexcept

Constructor.

Parameters

[in]

image

to iterate over.

Member Function Documentation

getIndex()

int optris::ImageIterator::getIndex ( ) const

inlinenoexcept

Returns the current pixel index.

Returns

index of the current pixel.

getPixel()

OTC_SDK_API Pixel optris::ImageIterator::getPixel ( ) const

noexcept

Returns the current pixel.

Returns

current pixel.

getX()

int optris::ImageIterator::getX ( ) const

inlinenoexcept

Returns the x-coordinate of the current pixel.

Returns

x-coordinate of the current pixel.

getY()

int optris::ImageIterator::getY ( ) const

inlinenoexcept

Returns the y-coordinate of the current pixel.

Returns

y-coordinate of the current pixel.

hasNext()

bool optris::ImageIterator::hasNext ( ) const

inlinenoexcept

Returns whether there is a next pixel.

Returns

true if there is a next pixel. False otherwise.

setPixel()

OTC_SDK_API void optris::ImageIterator::setPixel ( const Pixel & pixel )

noexcept

Sets the current pixel.

Parameters

[in]

pixel

to set.

---

The documentation for this class was generated from the following file:

• ImageIterator.h