boost::gil::any_image< ImageTypes > Class Template Reference

Represents a run-time specified image. More...

#include <any_image.hpp>

Inheritance diagram for boost::gil::any_image< ImageTypes >:

Collaboration diagram for boost::gil::any_image< ImageTypes >:

Public Types
typedef any_image_view < typename detail::images_get_const_views_t < ImageTypes >::type >	const_view_t
typedef any_image_view < typename detail::images_get_views_t < ImageTypes >::type >	view_t
typedef std::ptrdiff_t	x_coord_t
typedef std::ptrdiff_t	y_coord_t
typedef point2< std::ptrdiff_t >	point_t
typedef ImageTypes	types_t

Public Member Functions
	any_image ()
template<typename T >
	any_image (const T &obj)
template<typename T >
	any_image (T &obj, bool do_swap)
	any_image (const any_image &v)
template<typename T >
any_image &	operator= (const T &obj)
any_image &	operator= (const any_image &v)
void	recreate (const point_t &dims, unsigned alignment=1)
void	recreate (x_coord_t width, y_coord_t height, unsigned alignment=1)
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 ImageTypes>
class boost::gil::any_image< ImageTypes >

Represents a run-time specified image.

Note it does NOT model ImageConcept

Represents an image whose type (color space, layout, planar/interleaved organization, etc) can be specified at run time. It is the runtime equivalent of image. Some of the requirements of ImageConcept, 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 does not fully model ImageConcept. In particular, its view and const_view methods return any_image_view, which does not fully model ImageViewConcept. See any_image_view for more.

Member Typedef Documentation

template<typename ImageTypes>

typedef any_image_view<typename detail::images_get_const_views_t<ImageTypes>::type> boost::gil::any_image< ImageTypes >::const_view_t

template<typename ImageTypes>

typedef point2<std::ptrdiff_t> boost::gil::any_image< ImageTypes >::point_t

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

inherited

template<typename ImageTypes>

typedef any_image_view<typename detail::images_get_views_t<ImageTypes>::type> boost::gil::any_image< ImageTypes >::view_t

template<typename ImageTypes>

typedef std::ptrdiff_t boost::gil::any_image< ImageTypes >::x_coord_t

template<typename ImageTypes>

typedef std::ptrdiff_t boost::gil::any_image< ImageTypes >::y_coord_t

Constructor & Destructor Documentation

template<typename ImageTypes>

boost::gil::any_image< ImageTypes >::any_image ( )

inline

template<typename ImageTypes>

template<typename T >

boost::gil::any_image< ImageTypes >::any_image ( const T &  obj )

inlineexplicit

template<typename ImageTypes>

template<typename T >

boost::gil::any_image< ImageTypes >::any_image ( T &  obj, bool  do_swap  )

inlineexplicit

template<typename ImageTypes>

boost::gil::any_image< ImageTypes >::any_image ( const any_image< ImageTypes > &  v )

inline

Member Function Documentation

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

inlineinherited

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

inlineinherited

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

inlineinherited

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

inlineinherited

template<typename ImageTypes>

point_t boost::gil::any_image< ImageTypes >::dimensions ( ) const

inline

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

Referenced by boost::gil::any_image< ImageTypes >::height(), and boost::gil::any_image< ImageTypes >::width().

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

inlinestaticinherited

template<typename ImageTypes>

y_coord_t boost::gil::any_image< ImageTypes >::height ( ) const

inline

References boost::gil::any_image< ImageTypes >::dimensions(), and boost::gil::point2< T >::y.

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

inlineinherited

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

inlineinherited

Referenced by boost::gil::detail::construct_matched_t< N >::apply().

template<typename ImageTypes>

std::size_t boost::gil::any_image< ImageTypes >::num_channels ( ) const

inline

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

template<typename ImageTypes>

template<typename T >

any_image& boost::gil::any_image< ImageTypes >::operator= ( const T &  obj )

inline

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

template<typename ImageTypes>

any_image& boost::gil::any_image< ImageTypes >::operator= ( const any_image< ImageTypes > &  v )

inline

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

template<typename ImageTypes>

void boost::gil::any_image< ImageTypes >::recreate ( const point_t &  dims, unsigned  alignment = 1  )

inline

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

Referenced by boost::gil::detail::jpeg_reader_dynamic::read_image(), boost::gil::detail::tiff_reader_dynamic::read_image(), and boost::gil::detail::png_reader_dynamic::read_image().

template<typename ImageTypes>

void boost::gil::any_image< ImageTypes >::recreate ( x_coord_t  width, y_coord_t  height, unsigned  alignment = 1  )

inline

References boost::gil::any_image< ImageTypes >::recreate().

Referenced by boost::gil::any_image< ImageTypes >::recreate().

template<typename ImageTypes>

x_coord_t boost::gil::any_image< ImageTypes >::width ( ) const

inline

References boost::gil::any_image< ImageTypes >::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.hpp