boost::gil::planar_pixel_iterator

An iterator over planar pixels. Models HomogeneousColorBaseConcept, PixelIteratorConcept, HomogeneousPixelBasedConcept, MemoryBasedIteratorConcept, HasDynamicXStepTypeConcept

Synopsis

Declared in <boost/gil/planar_pixel_iterator.hpp>

template<
    typename IC,
    typename C>
struct planar_pixel_iterator
    : stl_interfaces::iterator_interface<planar_pixel_iterator<ChannelPtr, ColorSpace>, std::random_access_iterator_tag, pixel<std::iterator_traits<ChannelPtr>::value_type, layout<ColorSpace>>, planar_pixel_reference<std::iterator_traits<ChannelPtr>::reference, ColorSpace> const>
    , detail::homogeneous_color_base<ChannelPtr, layout<ColorSpace>, mp11::mp_size<ColorSpace>::value>

Description

/////////////////////////////////////////////////////////////////////////////////////

Planar pixels have channel data that is not consecutive in memory. To abstract this we use classes to represent references and pointers to planar pixels.

Base Classes

Name

Description

stl_interfaces::iterator_interface<planar_pixel_iterator<ChannelPtr, ColorSpace>, std::random_access_iterator_tag, pixel<std::iterator_traits<ChannelPtr>::value_type, layout<ColorSpace>>, planar_pixel_reference<std::iterator_traits<ChannelPtr>::reference, ColorSpace> const>

detail::homogeneous_color_base<ChannelPtr, layout<ColorSpace>, mp11::mp_size<ColorSpace>::value>

Types

Name

address_of

Type Aliases

Name

Member Functions

Name

Description

planar_pixel_iterator [constructor]

Copy constructor and operator= from pointers to compatible planar pixels or planar pixel references. That allow constructs like pointer = &value or pointer = &reference Since we should not override operator& that's the best we can do.

operator=

Assignment operator

operator*

Dereference operators

operator+

operator++

Increment operators

operator+=

Addition assignment operators

operator‐

Subtraction operators

operator‐‐