color_element_type, color_element_reference_type, color_element_const_reference_type, get_color, contains_color

get_color: Named channel accessors More...

Classes
struct	boost::gil::contains_color< ColorBase, Color >
	A predicate metafunction determining whether a given color base contains a given color. More...
struct	boost::gil::color_element_type< ColorBase, Color >
	Specifies the type of the element associated with a given color tag. More...
struct	boost::gil::color_element_reference_type< ColorBase, Color >
	Specifies the return type of the mutable element accessor by color name, get_color(color_base, Color());. More...
struct	boost::gil::color_element_const_reference_type< ColorBase, Color >
	Specifies the return type of the constant element accessor by color name, get_color(color_base, Color());. More...

Functions
template<typename ColorBase , typename Color >
color_element_reference_type < ColorBase, Color >::type	boost::gil::get_color (ColorBase &cb, Color=Color())
	Mutable accessor to the element associated with a given color name. More...
template<typename ColorBase , typename Color >
color_element_const_reference_type < ColorBase, Color >::type	boost::gil::get_color (const ColorBase &cb, Color=Color())
	Constant accessor to the element associated with a given color name. More...

Detailed Description

get_color: Named channel accessors

Support for accessing the elements of a color base by color name

Example: A function that takes a generic pixel containing a red channel and sets it to 100%:

template <typename Pixel>
void set_red_to_max(Pixel& pixel) {
    boost::function_requires<MutablePixelConcept<Pixel> >();
    BOOST_STATIC_ASSERT((contains_color<Pixel, red_t>::value));

    typedef typename color_element_type<Pixel, red_t>::type red_channel_t;
    get_color(pixel, red_t()) = channel_traits<red_channel_t>::max_value(); 
}

Function Documentation

template<typename ColorBase , typename Color >

color_element_reference_type<ColorBase,Color>::type boost::gil::get_color	(	ColorBase &	cb,
		Color	= Color()
	)

#include <boost_1_57_0/boost/gil/color_base_algorithm.hpp>

Mutable accessor to the element associated with a given color name.

References boost::gil::kth_semantic_element_reference_type< ColorBase, color_index_type< ColorBase, Color >::value >::get().

Referenced by boost::gil::detail::alpha_or_max_impl(), boost::intrusive::rbtree_algorithms< NodeTraits >::erase(), boost::intrusive::rbtree_algorithms< NodeTraits >::is_header(), boost::intrusive::rbtree_node_cloner< NodeTraits, F >::operator()(), boost::intrusive::detail::rbtree_node_checker< ValueTraits, NodePtrCompare, ExtraChecker >::operator()(), boost::gil::default_color_converter_impl< gray_t, rgb_t >::operator()(), boost::gil::default_color_converter_impl< gray_t, cmyk_t >::operator()(), boost::gil::default_color_converter_impl< rgb_t, gray_t >::operator()(), boost::gil::default_color_converter_impl< rgb_t, cmyk_t >::operator()(), boost::gil::default_color_converter_impl< cmyk_t, rgb_t >::operator()(), boost::gil::default_color_converter_impl< cmyk_t, gray_t >::operator()(), boost::gil::default_color_converter_impl< C1, rgba_t >::operator()(), boost::gil::default_color_converter_impl< rgba_t, C2 >::operator()(), boost::intrusive::rbtree_algorithms< NodeTraits >::replace_node(), and boost::intrusive::rbtree_algorithms< NodeTraits >::swap_nodes().

template<typename ColorBase , typename Color >

color_element_const_reference_type<ColorBase,Color>::type boost::gil::get_color	(	const ColorBase &	cb,
		Color	= Color()
	)

#include <boost_1_57_0/boost/gil/color_base_algorithm.hpp>

Constant accessor to the element associated with a given color name.

References boost::gil::kth_semantic_element_const_reference_type< ColorBase, color_index_type< ColorBase, Color >::value >::get().