Boost: boost::gil::image< Pixel, IsPlanar, Alloc > Singleton Reference

Boost v1.57.0

doxygen for www.boost.org

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages

container interface over image view. More...

#include <typedefs.hpp>

Collaboration diagram for boost::gil::image< Pixel, IsPlanar, Alloc >:

Collaboration graph

Public Types
typedef Alloc::template rebind < unsigned char >::other	allocator_type

typedef view_type_from_pixel < Pixel, IsPlanar >::type	view_t

typedef view_t::const_t	const_view_t

typedef view_t::point_t	point_t

typedef view_t::coord_t	coord_t

typedef view_t::value_type	value_type

typedef coord_t	x_coord_t

typedef coord_t	y_coord_t

Public Member Functions
const point_t &	dimensions () const

x_coord_t	width () const

y_coord_t	height () const

	image (std::size_t alignment=0, const Alloc alloc_in=Alloc())

	image (const point_t &dimensions, std::size_t alignment=0, const Alloc alloc_in=Alloc())

	image (x_coord_t width, y_coord_t height, std::size_t alignment=0, const Alloc alloc_in=Alloc())

	image (const point_t &dimensions, const Pixel &p_in, std::size_t alignment, const Alloc alloc_in=Alloc())

	image (x_coord_t width, y_coord_t height, const Pixel &p_in, std::size_t alignment, const Alloc alloc_in=Alloc())

	image (const image &img)

template<typename P2 , bool IP2, typename Alloc2 >
	image (const image< P2, IP2, Alloc2 > &img)

image &	operator= (const image &img)

template<typename Img >
image &	operator= (const Img &img)

	~image ()

Alloc &	allocator ()

Alloc const &	allocator () const

void	swap (image &img)

void	recreate (const point_t &dims, std::size_t alignment=0, const Alloc alloc_in=Alloc())

void	recreate (x_coord_t width, y_coord_t height, std::size_t alignment=0, const Alloc alloc_in=Alloc())

void	recreate (const point_t &dims, const Pixel &p_in, std::size_t alignment, const Alloc alloc_in=Alloc())

void	recreate (x_coord_t width, y_coord_t height, const Pixel &p_in, std::size_t alignment, const Alloc alloc_in=Alloc())

Public Attributes
view_t	_view

Detailed Description

template<typename Pixel, bool IsPlanar = false, typename Alloc = std::allocator<unsigned char>>
singleton boost::gil::image< Pixel, IsPlanar, Alloc >

container interface over image view.

Models ImageConcept, PixelBasedConcept

A 2D container whose elements are pixels. It is templated over the pixel type, a boolean indicating whether it should be planar, and an optional allocator.

Note that its element type does not have to be a pixel. image can be instantiated with any Regular element, in which case it models the weaker RandomAccess2DImageConcept and does not model PixelBasedConcept

Member Typedef Documentation

template<typename Pixel, bool IsPlanar = false, typename Alloc = std::allocator<unsigned char>>

typedef Alloc::template rebind<unsigned char>::other boost::gil::image< Pixel, IsPlanar, Alloc >::allocator_type

template<typename Pixel, bool IsPlanar = false, typename Alloc = std::allocator<unsigned char>>

typedef view_t::const_t boost::gil::image< Pixel, IsPlanar, Alloc >::const_view_t

template<typename Pixel, bool IsPlanar = false, typename Alloc = std::allocator<unsigned char>>

typedef view_t::coord_t boost::gil::image< Pixel, IsPlanar, Alloc >::coord_t

template<typename Pixel, bool IsPlanar = false, typename Alloc = std::allocator<unsigned char>>

typedef view_t::point_t boost::gil::image< Pixel, IsPlanar, Alloc >::point_t

template<typename Pixel, bool IsPlanar = false, typename Alloc = std::allocator<unsigned char>>

typedef view_t::value_type boost::gil::image< Pixel, IsPlanar, Alloc >::value_type

template<typename Pixel, bool IsPlanar = false, typename Alloc = std::allocator<unsigned char>>

typedef view_type_from_pixel<Pixel, IsPlanar>::type boost::gil::image< Pixel, IsPlanar, Alloc >::view_t

template<typename Pixel, bool IsPlanar = false, typename Alloc = std::allocator<unsigned char>>

typedef coord_t boost::gil::image< Pixel, IsPlanar, Alloc >::x_coord_t

template<typename Pixel, bool IsPlanar = false, typename Alloc = std::allocator<unsigned char>>

typedef coord_t boost::gil::image< Pixel, IsPlanar, Alloc >::y_coord_t

Constructor & Destructor Documentation

template<typename Pixel, bool IsPlanar = false, typename Alloc = std::allocator<unsigned char>>

boost::gil::image< Pixel, IsPlanar, Alloc >::image	(	std::size_t	alignment = `0`,
		const Alloc	alloc_in = `Alloc()`
	)

inlineexplicit

template<typename Pixel, bool IsPlanar = false, typename Alloc = std::allocator<unsigned char>>

boost::gil::image< Pixel, IsPlanar, Alloc >::image	(	const point_t &	dimensions,
		std::size_t	alignment = `0`,
		const Alloc	alloc_in = `Alloc()`
	)

inline

template<typename Pixel, bool IsPlanar = false, typename Alloc = std::allocator<unsigned char>>

boost::gil::image< Pixel, IsPlanar, Alloc >::image	(	x_coord_t	width,
		y_coord_t	height,
		std::size_t	alignment = `0`,
		const Alloc	alloc_in = `Alloc()`
	)

inline

template<typename Pixel, bool IsPlanar = false, typename Alloc = std::allocator<unsigned char>>

boost::gil::image< Pixel, IsPlanar, Alloc >::image	(	const point_t &	dimensions,
		const Pixel &	p_in,
		std::size_t	alignment,
		const Alloc	alloc_in = `Alloc()`
	)

inline

template<typename Pixel, bool IsPlanar = false, typename Alloc = std::allocator<unsigned char>>

boost::gil::image< Pixel, IsPlanar, Alloc >::image	(	x_coord_t	width,
		y_coord_t	height,
		const Pixel &	p_in,
		std::size_t	alignment,
		const Alloc	alloc_in = `Alloc()`
	)

inline

template<typename Pixel, bool IsPlanar = false, typename Alloc = std::allocator<unsigned char>>

boost::gil::image< Pixel, IsPlanar, Alloc >::image ( const image< Pixel, IsPlanar, Alloc > & img )

inline

References boost::gil::image< Pixel, IsPlanar, Alloc >::_view, and boost::gil::image< Pixel, IsPlanar, Alloc >::dimensions().

template<typename Pixel, bool IsPlanar = false, typename Alloc = std::allocator<unsigned char>>

template<typename P2 , bool IP2, typename Alloc2 >

boost::gil::image< Pixel, IsPlanar, Alloc >::image ( const image< P2, IP2, Alloc2 > & img )

inline

References boost::gil::image< Pixel, IsPlanar, Alloc >::_view, and boost::gil::image< Pixel, IsPlanar, Alloc >::dimensions().

template<typename Pixel, bool IsPlanar = false, typename Alloc = std::allocator<unsigned char>>

boost::gil::image< Pixel, IsPlanar, Alloc >::~image ( )

inline

References boost::gil::image< Pixel, IsPlanar, Alloc >::_view, and boost::gil::destruct_pixels().

Member Function Documentation

template<typename Pixel, bool IsPlanar = false, typename Alloc = std::allocator<unsigned char>>

Alloc& boost::gil::image< Pixel, IsPlanar, Alloc >::allocator ( )

inline

template<typename Pixel, bool IsPlanar = false, typename Alloc = std::allocator<unsigned char>>

Alloc const& boost::gil::image< Pixel, IsPlanar, Alloc >::allocator ( ) const

inline

template<typename Pixel, bool IsPlanar = false, typename Alloc = std::allocator<unsigned char>>

const point_t& boost::gil::image< Pixel, IsPlanar, Alloc >::dimensions ( ) const

inline

References boost::gil::image< Pixel, IsPlanar, Alloc >::_view.

Referenced by boost::gil::image< Pixel, IsPlanar, Alloc >::image(), and boost::gil::image< Pixel, IsPlanar, Alloc >::operator=().

template<typename Pixel, bool IsPlanar = false, typename Alloc = std::allocator<unsigned char>>

y_coord_t boost::gil::image< Pixel, IsPlanar, Alloc >::height ( ) const

inline

References boost::gil::image< Pixel, IsPlanar, Alloc >::_view.

template<typename Pixel, bool IsPlanar = false, typename Alloc = std::allocator<unsigned char>>

image& boost::gil::image< Pixel, IsPlanar, Alloc >::operator= ( const image< Pixel, IsPlanar, Alloc > & img )

inline

References boost::gil::image< Pixel, IsPlanar, Alloc >::_view, boost::gil::copy_pixels(), boost::gil::image< Pixel, IsPlanar, Alloc >::dimensions(), and boost::gil::image< Pixel, IsPlanar, Alloc >::swap().

template<typename Pixel, bool IsPlanar = false, typename Alloc = std::allocator<unsigned char>>

template<typename Img >

image& boost::gil::image< Pixel, IsPlanar, Alloc >::operator= ( const Img & img )

inline

References boost::gil::image< Pixel, IsPlanar, Alloc >::_view, boost::gil::copy_pixels(), boost::gil::image< Pixel, IsPlanar, Alloc >::dimensions(), and boost::gil::image< Pixel, IsPlanar, Alloc >::swap().

template<typename Pixel, bool IsPlanar = false, typename Alloc = std::allocator<unsigned char>>

void boost::gil::image< Pixel, IsPlanar, Alloc >::recreate	(	const point_t &	dims,
		std::size_t	alignment = `0`,
		const Alloc	alloc_in = `Alloc()`
	)

inline

References boost::gil::image< Pixel, IsPlanar, Alloc >::_view, and boost::gil::image< Pixel, IsPlanar, Alloc >::swap().

Referenced by boost::gil::image< Pixel, IsPlanar, Alloc >::recreate().

template<typename Pixel, bool IsPlanar = false, typename Alloc = std::allocator<unsigned char>>

void boost::gil::image< Pixel, IsPlanar, Alloc >::recreate	(	x_coord_t	width,
		y_coord_t	height,
		std::size_t	alignment = `0`,
		const Alloc	alloc_in = `Alloc()`
	)

inline

References boost::gil::image< Pixel, IsPlanar, Alloc >::recreate().

template<typename Pixel, bool IsPlanar = false, typename Alloc = std::allocator<unsigned char>>

void boost::gil::image< Pixel, IsPlanar, Alloc >::recreate	(	const point_t &	dims,
		const Pixel &	p_in,
		std::size_t	alignment,
		const Alloc	alloc_in = `Alloc()`
	)

inline

References boost::gil::image< Pixel, IsPlanar, Alloc >::_view, and boost::gil::image< Pixel, IsPlanar, Alloc >::swap().

template<typename Pixel, bool IsPlanar = false, typename Alloc = std::allocator<unsigned char>>

void boost::gil::image< Pixel, IsPlanar, Alloc >::recreate	(	x_coord_t	width,
		y_coord_t	height,
		const Pixel &	p_in,
		std::size_t	alignment,
		const Alloc	alloc_in = `Alloc()`
	)

inline

References boost::gil::image< Pixel, IsPlanar, Alloc >::recreate().

template<typename Pixel, bool IsPlanar = false, typename Alloc = std::allocator<unsigned char>>

void boost::gil::image< Pixel, IsPlanar, Alloc >::swap ( image< Pixel, IsPlanar, Alloc > & img )

inline

References boost::gil::image< Pixel, IsPlanar, Alloc >::_view, and boost::gil::swap().

Referenced by boost::gil::image< Pixel, IsPlanar, Alloc >::operator=(), boost::gil::image< Pixel, IsPlanar, Alloc >::recreate(), and boost::gil::swap().

template<typename Pixel, bool IsPlanar = false, typename Alloc = std::allocator<unsigned char>>

x_coord_t boost::gil::image< Pixel, IsPlanar, Alloc >::width ( ) const

inline

References boost::gil::image< Pixel, IsPlanar, Alloc >::_view.

Member Data Documentation

template<typename Pixel, bool IsPlanar = false, typename Alloc = std::allocator<unsigned char>>

view_t boost::gil::image< Pixel, IsPlanar, Alloc >::_view

Referenced by boost::gil::const_view(), boost::gil::image< Pixel, IsPlanar, Alloc >::dimensions(), boost::gil::image< Pixel, IsPlanar, Alloc >::height(), boost::gil::image< Pixel, IsPlanar, Alloc >::image(), boost::gil::image< Pixel, IsPlanar, Alloc >::operator=(), boost::gil::image< Pixel, IsPlanar, Alloc >::recreate(), boost::gil::image< Pixel, IsPlanar, Alloc >::swap(), boost::gil::view(), boost::gil::image< Pixel, IsPlanar, Alloc >::width(), and boost::gil::image< Pixel, IsPlanar, Alloc >::~image().

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

boost_1_57_0/boost/gil/image.hpp

boost
gil
image
Generated on Mon Jan 12 2015 00:06:11 for Boost by 1.8.8