Cinder  0.9.1
Public Member Functions | List of all members
cinder::SurfaceT< T >::ConstIter Class Reference

#include <Surface.h>

Public Member Functions

 ConstIter (const Iter &iter)
 
 ConstIter (const SurfaceT< T > &SurfaceT, const Area &area)
 
const T & r () const
 
const T & g () const
 
const T & b () const
 
const T & a () const
 
const T & r (int32_t xOff, int32_t yOff) const
 
const T & g (int32_t xOff, int32_t yOff) const
 
const T & b (int32_t xOff, int32_t yOff) const
 
const T & a (int32_t xOff, int32_t yOff) const
 
const T & rClamped (int32_t xOff, int32_t yOff) const
 
const T & gClamped (int32_t xOff, int32_t yOff) const
 
const T & bClamped (int32_t xOff, int32_t yOff) const
 
const T & aClamped (int32_t xOff, int32_t yOff) const
 
const int32_t x () const
 
const int32_t y () const
 
ivec2 getPos () const
 
bool pixel ()
 
bool line ()
 
int32_t getWidth () const
 
int32_t getHeight () const
 

Detailed Description

template<typename T>
class cinder::SurfaceT< T >::ConstIter

Convenience class for iterating the pixels of a Surface. The iteration is const, performing read-only operations on the Surface.

Constructor & Destructor Documentation

template<typename T>
cinder::SurfaceT< T >::ConstIter::ConstIter ( const Iter iter)
template<typename T>
cinder::SurfaceT< T >::ConstIter::ConstIter ( const SurfaceT< T > &  SurfaceT,
const Area area 
)

Member Function Documentation

template<typename T>
const T& cinder::SurfaceT< T >::ConstIter::r ( ) const

Returns a reference to the red value of the pixel that the Iter currently points to.

template<typename T>
const T& cinder::SurfaceT< T >::ConstIter::g ( ) const

Returns a reference to the green value of the pixel that the Iter currently points to.

template<typename T>
const T& cinder::SurfaceT< T >::ConstIter::b ( ) const

Returns a reference to the blue value of the pixel that the Iter currently points to.

template<typename T>
const T& cinder::SurfaceT< T >::ConstIter::a ( ) const

Returns a reference to the alpha value of the pixel that the Iter currently points to. Undefined in the absence of an alpha channel.

template<typename T>
const T& cinder::SurfaceT< T >::ConstIter::r ( int32_t  xOff,
int32_t  yOff 
) const

Returns a reference to the red value of the pixel that the Iter currently points to, offset by (xOff, yOff) pixels.

template<typename T>
const T& cinder::SurfaceT< T >::ConstIter::g ( int32_t  xOff,
int32_t  yOff 
) const

Returns a reference to the green value of the pixel that the Iter currently points to, offset by (xOff, yOff) pixels.

template<typename T>
const T& cinder::SurfaceT< T >::ConstIter::b ( int32_t  xOff,
int32_t  yOff 
) const

Returns a reference to the blue value of the pixel that the Iter currently points to, offset by (xOff, yOff) pixels.

template<typename T>
const T& cinder::SurfaceT< T >::ConstIter::a ( int32_t  xOff,
int32_t  yOff 
) const

Returns a reference to the alpha value of the pixel that the Iter currently points to, offset by (xOff, yOff) pixels.

template<typename T>
const T& cinder::SurfaceT< T >::ConstIter::rClamped ( int32_t  xOff,
int32_t  yOff 
) const

Returns the red value of the pixel that the Iter currently points to, offset by (xOff, yOff) pixels. Clamps offset to the bounds of the Iter.

template<typename T>
const T& cinder::SurfaceT< T >::ConstIter::gClamped ( int32_t  xOff,
int32_t  yOff 
) const

Returns the green value of the pixel that the Iter currently points to, offset by (xOff, yOff) pixels. Clamps offset to the bounds of the Iter.

template<typename T>
const T& cinder::SurfaceT< T >::ConstIter::bClamped ( int32_t  xOff,
int32_t  yOff 
) const

Returns the blue value of the pixel that the Iter currently points to, offset by (xOff, yOff) pixels. Clamps offset to the bounds of the Iter.

template<typename T>
const T& cinder::SurfaceT< T >::ConstIter::aClamped ( int32_t  xOff,
int32_t  yOff 
) const

Returns the alpha value of the pixel that the Iter currently points to, offset by (xOff, yOff) pixels. Clamps offset to the bounds of the Iter. Undefined in the absence of an alpha channel.

template<typename T>
const int32_t cinder::SurfaceT< T >::ConstIter::x ( ) const

Returns the x coordinate of the pixel the Iter currently points to.

template<typename T>
const int32_t cinder::SurfaceT< T >::ConstIter::y ( ) const

Returns the t coordinate of the pixel the Iter currently points to.

template<typename T>
ivec2 cinder::SurfaceT< T >::ConstIter::getPos ( ) const

Returns the coordinate of the pixel the Iter currently points to.

template<typename T>
bool cinder::SurfaceT< T >::ConstIter::pixel ( )

Increments which pixel of the current row the Iter points to, and returns false when no pixels remain in the current row.

template<typename T>
bool cinder::SurfaceT< T >::ConstIter::line ( )

Increments which row the Iter points to, and returns false when no rows remain in the Surface.

template<typename T>
int32_t cinder::SurfaceT< T >::ConstIter::getWidth ( ) const

Returns the width of the Area the Iter iterates.

template<typename T>
int32_t cinder::SurfaceT< T >::ConstIter::getHeight ( ) const

Returns the height of the Area the Iter iterates.


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