boost::gil::any_image_view< ImageViewTypes > Class Template Reference

CLASS any_image_view. More...

#include <any_image_view.hpp>

Inheritance diagram for boost::gil::any_image_view< ImageViewTypes >:

Collaboration diagram for boost::gil::any_image_view< ImageViewTypes >:

Public Types
typedef any_image_view < typename detail::views_get_const_t < ImageViewTypes >::type >	const_t
typedef std::ptrdiff_t	x_coord_t
typedef std::ptrdiff_t	y_coord_t
typedef point2< std::ptrdiff_t >	point_t
typedef ImageViewTypes	types_t

Public Member Functions
	any_image_view ()
template<typename T >
	any_image_view (const T &obj)
	any_image_view (const any_image_view &v)
template<typename T >
any_image_view &	operator= (const T &obj)
any_image_view &	operator= (const any_image_view &v)
std::size_t	num_channels () const
point_t	dimensions () const
x_coord_t	width () const
y_coord_t	height () const
void	move_in (T &obj)
const T &	_dynamic_cast () const
T &	_dynamic_cast ()
bool	current_type_is () const
base_t	bits () const
std::size_t	index () const

Static Public Member Functions
static bool	has_type ()

Detailed Description

template<typename ImageViewTypes>
class boost::gil::any_image_view< ImageViewTypes >

CLASS any_image_view.

Represents a run-time specified image view. Models HasDynamicXStepTypeConcept, HasDynamicYStepTypeConcept, Note that this class does NOT model ImageViewConcept

Represents a view whose type (color space, layout, planar/interleaved organization, etc) can be specified at run time. It is the runtime equivalent of image_view. Some of the requirements of ImageViewConcept, such as the value_type typedef cannot be fulfilled, since the language does not allow runtime type specification. Other requirements, such as access to the pixels, would be inefficient to provide. Thus any_image_view does not fully model ImageViewConcept. However, many algorithms provide overloads taking runtime specified views and thus in many cases any_image_view can be used in places taking a view.

To perform an algorithm on any_image_view, put the algorithm in a function object and invoke it by calling apply_operation(runtime_view, algorithm_fn);

Member Typedef Documentation

template<typename ImageViewTypes>

typedef any_image_view<typename detail::views_get_const_t<ImageViewTypes>::type> boost::gil::any_image_view< ImageViewTypes >::const_t

template<typename ImageViewTypes>

typedef point2<std::ptrdiff_t> boost::gil::any_image_view< ImageViewTypes >::point_t

typedef ImageViewTypes boost::gil::variant< ImageViewTypes >::types_t

inherited

template<typename ImageViewTypes>

typedef std::ptrdiff_t boost::gil::any_image_view< ImageViewTypes >::x_coord_t

template<typename ImageViewTypes>

typedef std::ptrdiff_t boost::gil::any_image_view< ImageViewTypes >::y_coord_t

Constructor & Destructor Documentation

template<typename ImageViewTypes>

boost::gil::any_image_view< ImageViewTypes >::any_image_view ( )

inline

template<typename ImageViewTypes>

template<typename T >

boost::gil::any_image_view< ImageViewTypes >::any_image_view ( const T &  obj )

inlineexplicit

template<typename ImageViewTypes>

boost::gil::any_image_view< ImageViewTypes >::any_image_view ( const any_image_view< ImageViewTypes > &  v )

inline

Member Function Documentation

const T& boost::gil::variant< ImageViewTypes >::_dynamic_cast ( ) const

inlineinherited

T& boost::gil::variant< ImageViewTypes >::_dynamic_cast ( )

inlineinherited

References boost::gil::gil_reinterpret_cast(), and T.

base_t boost::gil::variant< ImageViewTypes >::bits ( ) const

inlineinherited

bool boost::gil::variant< ImageViewTypes >::current_type_is ( ) const

inlineinherited

template<typename ImageViewTypes>

point_t boost::gil::any_image_view< ImageViewTypes >::dimensions ( ) const

inline

References boost::gil::variant< ImageViewTypes >::apply_operation.

Referenced by boost::gil::any_image_view< ImageViewTypes >::height(), and boost::gil::any_image_view< ImageViewTypes >::width().

static bool boost::gil::variant< ImageViewTypes >::has_type ( )

inlinestaticinherited

template<typename ImageViewTypes>

y_coord_t boost::gil::any_image_view< ImageViewTypes >::height ( ) const

inline

References boost::gil::any_image_view< ImageViewTypes >::dimensions(), and boost::gil::point2< T >::y.

std::size_t boost::gil::variant< ImageViewTypes >::index ( ) const

inlineinherited

void boost::gil::variant< ImageViewTypes >::move_in ( T &  obj )

inlineinherited

References boost::gil::variant< Types >::swap.

template<typename ImageViewTypes>

std::size_t boost::gil::any_image_view< ImageViewTypes >::num_channels ( ) const

inline

References boost::gil::variant< ImageViewTypes >::apply_operation.

template<typename ImageViewTypes>

template<typename T >

any_image_view& boost::gil::any_image_view< ImageViewTypes >::operator= ( const T &  obj )

inline

References boost::gil::variant< ImageViewTypes >::operator=().

template<typename ImageViewTypes>

any_image_view& boost::gil::any_image_view< ImageViewTypes >::operator= ( const any_image_view< ImageViewTypes > &  v )

inline

References boost::gil::variant< ImageViewTypes >::operator=().

template<typename ImageViewTypes>

x_coord_t boost::gil::any_image_view< ImageViewTypes >::width ( ) const

inline

References boost::gil::any_image_view< ImageViewTypes >::dimensions(), and boost::gil::point2< T >::x.

---

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

• boost_1_57_0/boost/gil/extension/dynamic_image/any_image_view.hpp