Boost  v1.57.0
doxygen for www.boost.org
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
boost::gil::bit_aligned_pixel_iterator< NonAlignedPixelReference > Struct Template Reference

An iterator over non-byte-aligned pixels. More...

#include <bit_aligned_pixel_iterator.hpp>

Inheritance diagram for boost::gil::bit_aligned_pixel_iterator< NonAlignedPixelReference >:
Collaboration diagram for boost::gil::bit_aligned_pixel_iterator< NonAlignedPixelReference >:

Public Types

typedef parent_t::difference_type difference_type
 
typedef parent_t::reference reference
 

Public Member Functions

 bit_aligned_pixel_iterator ()
 
 bit_aligned_pixel_iterator (const bit_aligned_pixel_iterator &p)
 
bit_aligned_pixel_iteratoroperator= (const bit_aligned_pixel_iterator &p)
 
template<typename Ref >
 bit_aligned_pixel_iterator (const bit_aligned_pixel_iterator< Ref > &p)
 
 bit_aligned_pixel_iterator (reference *ref)
 
 bit_aligned_pixel_iterator (typename bit_range_t::byte_t *data, int bit_offset=0)
 
reference operator[] (difference_type d) const
 For some reason operator[] provided by iterator_adaptor returns a custom class that is convertible to reference We require our own reference because it is registered in iterator_traits. More...
 
reference operator-> () const
 
const bit_range_t & bit_range () const
 
bit_range_t & bit_range ()
 

Friends

template<typename Ref >
struct bit_aligned_pixel_iterator
 
class boost::iterator_core_access
 

Detailed Description

template<typename NonAlignedPixelReference>
struct boost::gil::bit_aligned_pixel_iterator< NonAlignedPixelReference >

An iterator over non-byte-aligned pixels.

Models PixelIteratorConcept, PixelBasedConcept, MemoryBasedIteratorConcept, HasDynamicXStepTypeConcept

An iterator over pixels that correspond to non-byte-aligned bit ranges. Examples of such pixels are single bit grayscale pixel, or a 6-bit RGB 222 pixel.

Member Typedef Documentation

template<typename NonAlignedPixelReference>
typedef parent_t::difference_type boost::gil::bit_aligned_pixel_iterator< NonAlignedPixelReference >::difference_type
template<typename NonAlignedPixelReference>
typedef parent_t::reference boost::gil::bit_aligned_pixel_iterator< NonAlignedPixelReference >::reference

Constructor & Destructor Documentation

template<typename NonAlignedPixelReference>
boost::gil::bit_aligned_pixel_iterator< NonAlignedPixelReference >::bit_aligned_pixel_iterator ( )
inline
template<typename NonAlignedPixelReference>
boost::gil::bit_aligned_pixel_iterator< NonAlignedPixelReference >::bit_aligned_pixel_iterator ( const bit_aligned_pixel_iterator< NonAlignedPixelReference > &  p)
inline
template<typename NonAlignedPixelReference>
template<typename Ref >
boost::gil::bit_aligned_pixel_iterator< NonAlignedPixelReference >::bit_aligned_pixel_iterator ( const bit_aligned_pixel_iterator< Ref > &  p)
inline
template<typename NonAlignedPixelReference>
boost::gil::bit_aligned_pixel_iterator< NonAlignedPixelReference >::bit_aligned_pixel_iterator ( reference ref)
inline
template<typename NonAlignedPixelReference>
boost::gil::bit_aligned_pixel_iterator< NonAlignedPixelReference >::bit_aligned_pixel_iterator ( typename bit_range_t::byte_t *  data,
int  bit_offset = 0 
)
inlineexplicit

Member Function Documentation

template<typename NonAlignedPixelReference>
const bit_range_t& boost::gil::bit_aligned_pixel_iterator< NonAlignedPixelReference >::bit_range ( ) const
inline
template<typename NonAlignedPixelReference>
bit_range_t& boost::gil::bit_aligned_pixel_iterator< NonAlignedPixelReference >::bit_range ( )
inline
template<typename NonAlignedPixelReference>
reference boost::gil::bit_aligned_pixel_iterator< NonAlignedPixelReference >::operator-> ( ) const
inline
template<typename NonAlignedPixelReference>
bit_aligned_pixel_iterator& boost::gil::bit_aligned_pixel_iterator< NonAlignedPixelReference >::operator= ( const bit_aligned_pixel_iterator< NonAlignedPixelReference > &  p)
inline
template<typename NonAlignedPixelReference>
reference boost::gil::bit_aligned_pixel_iterator< NonAlignedPixelReference >::operator[] ( difference_type  d) const
inline

For some reason operator[] provided by iterator_adaptor returns a custom class that is convertible to reference We require our own reference because it is registered in iterator_traits.

References boost::it.

Friends And Related Function Documentation

template<typename NonAlignedPixelReference>
template<typename Ref >
friend struct bit_aligned_pixel_iterator
friend
template<typename NonAlignedPixelReference>
friend class boost::iterator_core_access
friend

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