Boost GIL


Class Hierarchy
This inheritance list is sorted roughly, but not completely, alphabetically:
[detail level 123]
 Calpha_tAlpha
 Cany_image< ImageTypes >Represents a run-time specified image. Note it does NOT model ImageConcept
 Cany_image_view< ImageViewTypes >Represents a run-time specified image view. Models HasDynamicXStepTypeConcept, HasDynamicYStepTypeConcept, Note that this class does NOT model ImageViewConcept
 Cbinary_operation_obj< Derived, Result >A generic binary operation on viewsUse this class as a convenience superclass when defining an operation for any image views. Many operations have different behavior when the two views are compatible. This class checks for compatibility and invokes apply_compatible(V1,V2) or apply_incompatible(V1,V2) of the subclass. You must provide apply_compatible(V1,V2) method in your subclass, but apply_incompatible(V1,V2) is not required and the default throws std::bad_cast
 Cbinary_operation_obj< copy_and_convert_pixels_fn< CC > >
 Cbinary_operation_obj< copy_pixels_fn >
 Cbinary_operation_obj< equal_pixels_fn, bool >
 Cbit_aligned_image_type< ChannelBitSizeVector, Layout, Alloc >Returns the type of a packed image whose pixels may not be byte aligned. For example, an "rgb222" image is bit-aligned because its pixel spans six bits
 Cbit_aligned_image_type< mpl::vector1_c< unsigned, Size1 >, Layout, Alloc >
 Cbit_aligned_image_type< mpl::vector2_c< unsigned, Size1, Size2 >, Layout, Alloc >
 Cbit_aligned_image_type< mpl::vector3_c< unsigned, Size1, Size2, Size3 >, Layout, Alloc >
 Cbit_aligned_image_type< mpl::vector4_c< unsigned, Size1, Size2, Size3, Size4 >, Layout, Alloc >
 Cbit_aligned_image_type< mpl::vector5_c< unsigned, Size1, Size2, Size3, Size4, Size5 >, Layout, Alloc >
 Cbit_aligned_pixel_iterator< NonAlignedPixelReference >An iterator over non-byte-aligned pixels. Models PixelIteratorConcept, PixelBasedConcept, MemoryBasedIteratorConcept, HasDynamicXStepTypeConcept
 Cbit_range< RangeSize, Mutable >
 Cbit_range< bit_size, IsMutable >
 Cblack_tBlack
 Cblue_tBlue
 Cbyte_to_memunit< T >
 Cbyte_to_memunit< Iterator >
 Cchannel_converter< SrcChannelV, DstChannelV >A unary function object converting between channel types
 Cchannel_converter_unsigned< float32_t, DstChannelV >Float32_t conversion
 Cchannel_converter_unsigned< float32_t, uint32_t >32 bit <-> float channel conversion
 Cchannel_converter_unsigned< uint32_t, float32_t >32 bit <-> float channel conversion
 Cchannel_converter_unsigned_impl< SrcChannelV, DstChannelV, SrcIsIntegral, DstIsIntegral >This is the default implementation. Performance specializatons are provided
 Cchannel_converter_unsigned_impl< SrcChannelV, DstChannelV, is_integral< SrcChannelV >::value, is_integral< DstChannelV >::value >
 Cchannel_mapping_type< planar_pixel_reference< ChannelReference, ColorSpace > >Specifies the color space type of a planar pixel reference. Required by PixelBasedConcept
 Cchannel_multiplier< ChannelValue >A function object to multiply two channels. result = a * b / max_value
 Cchannel_multiplier_unsigned< ChannelValue >This is the default implementation. Performance specializatons are provided
 Cchannel_multiplier_unsigned< float32_t >Specialization of channel_multiply for float 0..1 channels
 Cchannel_multiplier_unsigned< uint16_t >Specialization of channel_multiply for 16-bit unsigned channels
 Cchannel_multiplier_unsigned< uint8_t >Specialization of channel_multiply for 8-bit unsigned channels
 Cchannel_type< P >
 Cchannel_type< Deref::value_type >
 Cchannel_type< DFn::value_type >
 Cchannel_type< Iterator >
 Cchannel_type< L >
 Cchannel_type< Loc >
 Cchannel_type< memory_based_2d_locator< SI >::parent_t >
 Cchannel_type< Pixel >
 Cchannel_type< PixelBased >
 Cchannel_type< planar_pixel_reference< ChannelReference, ColorSpace > >Specifies the color space type of a planar pixel reference. Required by HomogeneousPixelBasedConcept
 Cchannel_type< virtual_2d_locator< D, TR >::parent_t >
 Cchannel_type< XIt >
 Ccolor_converted_view_type< SrcView, DstP, CC >Returns the type of a view that does color conversion upon dereferencing its pixels
 Ccolor_converted_view_type< any_image_view< ViewTypes >, DstP >Returns the type of a runtime-specified view, color-converted to a given pixel type with the default coor converter
 Ccolor_converted_view_type< any_image_view< ViewTypes >, DstP, CC >Returns the type of a runtime-specified view, color-converted to a given pixel type with user specified color converter
 Ccolor_converted_view_type< View, DstP, CC >
 Ccolor_space_type< planar_pixel_reference< ChannelReference, ColorSpace > >Specifies the color space type of a planar pixel reference. Required by PixelBasedConcept
 Cconst_iterator_type< It >Returns the type of an iterator just like the input iterator, except operating over immutable values
 Ccontains_color< ColorBase, Color >A predicate metafunction determining whether a given color base contains a given color
 Ccopier_n< I, O >
 Ccopier_n< I, iterator_from_2d< OL > >Destination range is delimited by image iterators
 Ccopier_n< iterator_from_2d< IL >, iterator_from_2d< OL > >Both source and destination ranges are delimited by image iterators
 Ccopier_n< iterator_from_2d< IL >, O >Source range is delimited by image iterators
 Ccyan_tCyan
 Cdec< T >Operator– wrapped in a function object
 Cdefault_channel_converterSame as channel_converter, except it takes the destination channel by reference, which allows us to move the templates from the class level to the method level. This is important when invoking it on heterogeneous pixels
 Cdefault_color_converterClass for color-converting one pixel to another
 Cdefault_color_converter_impl< C1, C2 >Color Convertion function object. To be specialized for every src/dst color space
 Cdefault_color_converter_impl< C, C >When the color space is the same, color convertion performs channel depth conversion
 Cdefault_color_converter_impl< C1, rgba_t >Converting any pixel type to RGBA. Note: Supports homogeneous pixels only
 Cdefault_color_converter_impl< cmyk_t, gray_t >CMYK to Gray
 Cdefault_color_converter_impl< cmyk_t, rgb_t >CMYK to RGB (not the fastest code in the world)
 Cdefault_color_converter_impl< gray_t, cmyk_t >Gray to CMYK
 Cdefault_color_converter_impl< gray_t, rgb_t >Gray to RGB
 Cdefault_color_converter_impl< rgb_t, cmyk_t >RGB to CMYK (not the fastest code in the world)
 Cdefault_color_converter_impl< rgb_t, gray_t >RGB to Gray
 Cdefault_color_converter_impl< rgba_t, C2 >Converting RGBA to any pixel type. Note: Supports homogeneous pixels only
 Cdefault_color_converter_impl< rgba_t, rgba_t >Unfortunately RGBA to RGBA must be explicitly provided - otherwise we get ambiguous specialization error
 Cderef_base< ConstT, Value, Reference, ConstReference, ArgType, ResultType, IsMutable >Helper base class for pixel dereference adaptors
 Cderef_base< color_convert_deref_fn< SrcConstRefP, DstP, CC >, DstP, DstP, const DstP &, SrcConstRefP, DstP, false >
 Cderef_base< deref_compose< D1::const_t, D2::const_t >, D1::value_type, D1::reference, D1::const_reference, D2::argument_type, D1::result_type, D1::is_mutable &&D2::is_mutable >
 Cdereference_iterator_adaptor< Iterator, DFn >An adaptor over an existing iterator that provides for custom filter on dereferencing the object. Models: IteratorAdaptorConcept, PixelIteratorConcept
 Cderived_image_type< Image, T, L, IsPlanar >Constructs a homogeneous image type from a source image type by changing some of the properties.Use use_default for the properties of the source image that you want to keep
 Cderived_iterator_type< Iterator, T, L, IsPlanar, IsStep, IsMutable >Constructs a pixel iterator type from a source pixel iterator type by changing some of the properties.Use use_default for the properties of the source view that you want to keep
 Cderived_pixel_reference_type< Ref, T, L, IsPlanar, IsMutable >Constructs a pixel reference type from a source pixel reference type by changing some of the properties.Use use_default for the properties of the source view that you want to keep
 Cderived_view_type< View, T, L, IsPlanar, StepX, IsMutable >Constructs an image view type from a source view type by changing some of the properties.Use use_default for the properties of the source view that you want to keep
 Cdevicen_color_t< N >Unnamed color
 Cdevicen_t< 1 >Unnamed color space of one channel
 Cdevicen_t< 2 >Unnamed color space of two channels
 Cdevicen_t< 3 >Unnamed color space of three channels
 Cdevicen_t< 4 >Unnamed color space of four channels
 Cdevicen_t< 5 >Unnamed color space of five channels
 Cdynamic_x_step_type< IteratorOrLocatorOrView >Base template for types that model HasDynamicXStepTypeConcept
 Cdynamic_y_step_type< LocatorOrView >Base template for types that model HasDynamicYStepTypeConcept
 Cdynamic_y_step_type< dynamic_x_step_type< transposed_type< View >::type >::type >
 Cdynamic_y_step_type< dynamic_x_step_type< View >::type >
 Celement_const_reference_type< ColorBase >Specifies the return type of the constant element accessor at_c of a homogeneous color base
 Celement_reference_type< ColorBase >Specifies the return type of the mutable element accessor at_c of a homogeneous color base
 Celement_type< ColorBase >Specifies the element type of a homogeneous color base
 Cequal_n_fn< boost::gil::iterator_from_2d< Loc >, I2 >Source range is delimited by image iterators
 Cequal_n_fn< boost::gil::iterator_from_2d< Loc1 >, boost::gil::iterator_from_2d< Loc2 > >Both source and destination ranges are delimited by image iterators
 Cequal_n_fn< const pixel< T, Cs > *, const pixel< T, Cs > * >
 Cequal_n_fn< I1, boost::gil::iterator_from_2d< Loc > >Destination range is delimited by image iterators
 Cequal_n_fn< planar_pixel_iterator< IC, Cs >, planar_pixel_iterator< IC, Cs > >
 Cgray_color_tGray
 Cgreen_tGreen
 Chomogeneous_color_base< Element, Layout, 1 >A homogeneous color base holding one color element. Models HomogeneousColorBaseConcept or HomogeneousColorBaseValueConcept
 Chomogeneous_color_base< Element, Layout, 2 >A homogeneous color base holding two color elements. Models HomogeneousColorBaseConcept or HomogeneousColorBaseValueConcept
 Chomogeneous_color_base< Element, Layout, 3 >A homogeneous color base holding three color elements. Models HomogeneousColorBaseConcept or HomogeneousColorBaseValueConcept
 Chomogeneous_color_base< Element, Layout, 4 >A homogeneous color base holding four color elements. Models HomogeneousColorBaseConcept or HomogeneousColorBaseValueConcept
 Chomogeneous_color_base< Element, Layout, 5 >A homogeneous color base holding five color elements. Models HomogeneousColorBaseConcept or HomogeneousColorBaseValueConcept
 Cidentity< T >Identity taken from SGI STL
 Cidentity< ChannelValue >
 Cimage< Pixel, IsPlanar, Alloc >Container interface over image view. Models ImageConcept, PixelBasedConcept
 Cimage_is_basic< Img >Basic images must use basic views and std::allocator
 Cimage_type< T, L, IsPlanar, Alloc >Returns the type of a homogeneous image given the channel type, layout, and whether it operates on planar data
 Cimage_view< Loc >A lightweight object that interprets memory as a 2D array of pixels. Models ImageViewConcept,PixelBasedConcept,HasDynamicXStepTypeConcept,HasDynamicYStepTypeConcept,HasTransposedTypeConcept
 Cinc< T >Operator++ wrapped in a function object
 Cis_iterator_adaptor< It >Metafunction predicate determining whether the given iterator is a plain one or an adaptor over another iterator. Examples of adaptors are the step iterator and the dereference iterator adaptor
 Cis_pixel< bit_aligned_pixel_reference< B, C, L, M > >Metafunction predicate that flags bit_aligned_pixel_reference as a model of PixelConcept. Required by PixelConcept
 Cis_pixel< planar_pixel_reference< ChannelReference, ColorSpace > >Metafunction predicate that flags planar_pixel_reference as a model of PixelConcept. Required by PixelConcept
 Cis_planar< planar_pixel_reference< ChannelReference, ColorSpace > >Specifies that planar_pixel_reference represents a planar construct. Required by PixelBasedConcept
 Citerator_adaptor_get_base< It >Returns the base iterator for a given iterator adaptor. Provide an specialization when introducing new iterator adaptors
 Citerator_adaptor_rebind< It, NewBaseIt >Changes the base iterator of an iterator adaptor. Provide an specialization when introducing new iterator adaptors
 Citerator_add_deref< Iterator, Deref >Returns the type (and creates an instance) of an iterator that invokes the given dereference adaptor upon dereferencing
 Citerator_add_deref< dereference_iterator_adaptor< Iterator, PREV_DEREF >, Deref >For dereference iterator adaptors, compose the new function object after the old one
 Citerator_from_2d< Loc2 >Provides 1D random-access navigation to the pixels of the image. Models: PixelIteratorConcept, PixelBasedConcept, HasDynamicXStepTypeConcept
 Citerator_is_basic< Iterator >Determines if a given pixel iterator is basic Basic iterators must use gil::pixel (if interleaved), gil::planar_pixel_iterator (if planar) and gil::memory_based_step_iterator (if step). They must use the standard constness rules
 Citerator_is_mutable< It >Metafunction predicate returning whether the given iterator allows for changing its values
 Citerator_is_mutable< Iterator >
 Citerator_is_mutable< L::x_iterator >
 Citerator_is_mutable< Loc::x_iterator >
 Citerator_is_mutable< V::x_iterator >
 Citerator_is_step< I >Determines if the given iterator has a step that could be set dynamically
 Citerator_is_step< iterator_adaptor_get_base< It >::type >
 Citerator_is_step< L::x_iterator >
 Citerator_is_step< L::y_iterator >
 Citerator_is_step< V::xy_locator ::x_iterator >
 Citerator_is_step< V::xy_locator ::y_iterator >
 Citerator_type< T, L, IsPlanar, IsStep, IsMutable >Returns the type of a homogeneous iterator given the channel type, layout, whether it operates on planar data, whether it is a step iterator, and whether it is mutable
 Citerator_type_from_pixel< Pixel, IsPlanar, IsStep, IsMutable >Returns the type of a pixel iterator given the pixel type, whether it operates on planar data, whether it is a step iterator, and whether it is mutable
 Citerator_type_from_pixel< const bit_aligned_pixel_reference< B, C, L, M >, IsPlanar, IsStep, IsMutable >
 Ckth_channel_deref_fn< K, SrcP >Function object that returns a grayscale reference of the K-th channel (specified as a template parameter) of a given reference. Models: PixelDereferenceAdaptorConcept.If the input is a pixel value or constant reference, the function object is immutable. Otherwise it is mutable (and returns non-const reference to the k-th channel)
 Ckth_channel_view_type< K, View >Given a source image view type View, returns the type of an image view over a given channel of View.If the channels in the source view are adjacent in memory (such as planar non-step view or single-channel view) then the return view is a single-channel non-step view. If the channels are non-adjacent (interleaved and/or step view) then the return view is a single-channel step view
 Ckth_semantic_element_const_reference_type< ColorBase, K >Specifies the return type of the constant semantic_at_c<K>(color_base);
 Ckth_semantic_element_const_reference_type< ColorBase, color_index_type< ColorBase, Color >::value >
 Ckth_semantic_element_reference_type< ColorBase, K >Specifies the return type of the mutable semantic_at_c<K>(color_base);
 Ckth_semantic_element_reference_type< ColorBase, color_index_type< ColorBase, Color >::value >
 Ckth_semantic_element_type< ColorBase, K >Specifies the type of the K-th semantic element of a color base
 Ckth_semantic_element_type< ColorBase, color_index_type< ColorBase, Color >::value >
 Clayout< ColorSpace, ChannelMapping >Represents a color space and ordering of channels in memory
 Clayout< devicen_t< N > >
 Clocator_is_basic< Loc >Determines if a given locator is basic. A basic locator is memory-based and has basic x_iterator and y_iterator
 Clocator_type< T, L, IsPlanar, IsStepX, IsMutable >Returns the type of a homogeneous locator given the channel type, layout, whether it operates on planar data and whether it has a step horizontally
 Cmagenta_tMagenta
 Cmemunit_step_fn< Iterator >Function object that returns the memory unit distance between two iterators and advances a given iterator a given number of mem units (bytes or bits)
 Cnth_channel_deref_fn< SrcP >Function object that returns a grayscale reference of the N-th channel of a given reference. Models: PixelDereferenceAdaptorConcept.If the input is a pixel value or constant reference, the function object is immutable. Otherwise it is mutable (and returns non-const reference to the n-th channel)
 Cnth_channel_view_type< View >Given a source image view type View, returns the type of an image view over a single channel of ViewIf the channels in the source view are adjacent in memory (such as planar non-step view or single-channel view) then the return view is a single-channel non-step view. If the channels are non-adjacent (interleaved and/or step view) then the return view is a single-channel step view
 Cnth_channel_view_type< any_image_view< ViewTypes > >Given a runtime source image view, returns the type of a runtime image view over a single channel of the source view
 Cnum_channels< PixelBased >Returns the number of channels of a pixel-based GIL construct
 Cpacked_dynamic_channel_reference< BitField, NumBits, false >Models a constant subbyte channel reference whose bit offset is a runtime parameter. Models ChannelConcept Same as packed_channel_reference, except that the offset is a runtime parameter
 Cpacked_dynamic_channel_reference< BitField, NumBits, true >Models a mutable subbyte channel reference whose bit offset is a runtime parameter. Models ChannelConcept Same as packed_channel_reference, except that the offset is a runtime parameter
 Cpacked_image_type< BitField, ChannelBitSizeVector, Layout, Alloc >Returns the type of an interleaved packed image: an image whose channels may not be byte-aligned, but whose pixels are byte aligned
 Cpacked_image_type< BitField, mpl::vector1_c< unsigned, Size1 >, Layout, Alloc >
 Cpacked_image_type< BitField, mpl::vector2_c< unsigned, Size1, Size2 >, Layout, Alloc >
 Cpacked_image_type< BitField, mpl::vector3_c< unsigned, Size1, Size2, Size3 >, Layout, Alloc >
 Cpacked_image_type< BitField, mpl::vector4_c< unsigned, Size1, Size2, Size3, Size4 >, Layout, Alloc >
 Cpacked_image_type< BitField, mpl::vector5_c< unsigned, Size1, Size2, Size3, Size4, Size5 >, Layout, Alloc >
 Cpacked_pixel< BitField, ChannelRefVec, Layout >Heterogeneous pixel value whose channel references can be constructed from the pixel bitfield and their index. Models ColorBaseValueConcept, PixelValueConcept, PixelBasedConcept Typical use for this is a model of a packed pixel (like 565 RGB)
 Cpacked_pixel_type< BitField, ChannelBitSizeVector, Layout >Returns the type of a packed pixel given its bitfield type, the bit size of its channels and its layout
 Cpacked_pixel_type< BitField, mpl::vector1_c< unsigned, NumBits >, Layout >
 Cpacked_pixel_type< detail::min_fast_uint< NumBits >::type, mpl::vector1_c< unsigned, NumBits >, Layout >
 Cpixel< ChannelValue, Layout >Represents a pixel value (a container of channels). Models: HomogeneousColorBaseValueConcept, PixelValueConcept, HomogeneousPixelBasedConcept
 Cpixel_2d_locator_base< Loc, XIterator, YIterator >Base class for models of PixelLocatorConceptPixel locator is similar to a pixel iterator, but allows for 2D navigation of pixels within an image view. It has a 2D difference_type and supports random access operations like:
 Cpixel_2d_locator_base< memory_based_2d_locator< StepIterator >, iterator_adaptor_get_base< StepIterator >::type, StepIterator >
 Cpixel_2d_locator_base< virtual_2d_locator< Deref, IsTransposed >, position_iterator< Deref, IsTransposed >, position_iterator< Deref, 1-IsTransposed > >
 Cpixel_is_reference< Pixel >Given a model of a pixel, determines whether the model represents a pixel reference (as opposed to pixel value)
 Cpixel_reference_is_basic< PixelRef >Determines if a given pixel reference is basic Basic references must use gil::pixel& (if interleaved), gil::planar_pixel_reference (if planar). They must use the standard constness rules
 Cpixel_reference_is_mutable< R >Determines if the given pixel reference is mutable (i.e. its channels can be changed)
 Cpixel_reference_is_proxy< PixelReference >Determines whether the given pixel reference is a proxy class or a native C++ reference
 Cpixel_reference_type< T, L, IsPlanar, IsMutable >Returns the type of a homogeneous pixel reference given the channel type, layout, whether it operates on planar data and whether it is mutable
 Cpixel_value_type< Channel, Layout >Returns the type of a homogeneous pixel given the channel type and layout
 Cplanar_pixel_iterator< ChannelPtr, ColorSpace >An iterator over planar pixels. Models HomogeneousColorBaseConcept, PixelIteratorConcept, HomogeneousPixelBasedConcept, MemoryBasedIteratorConcept, HasDynamicXStepTypeConcept
 Cplanar_pixel_reference< ChannelReference, ColorSpace >A reference proxy to a planar pixel. Models: HomogeneousColorBaseConcept, HomogeneousPixelConcept
 Cplus_asymmetric< T1, T2 >Plus function object whose arguments may be of different type
 Cpoint< T >2D point both axes of which have the same dimension typeModels: Point2DConcept
 Cpoint< std::ptrdiff_t >
 Cposition_iterator< Deref, Dim >An iterator that remembers its current X,Y position and invokes a function object with it upon dereferencing. Models PixelIteratorConcept. Used to create virtual image views. Models: StepIteratorConcept, PixelIteratorConcept, PixelBasedConcept, HasDynamicXStepTypeConcept
 Cpromote_integral< T, PromoteUnsignedToUnsigned, UseCheckedInteger, IsIntegral >Meta-function to define an integral type with size than is (roughly) twice the bit size of T
 Cred_tRed
 Crgb_to_luminance_fn< RedChannel, GreenChannel, BlueChannel, GrayChannelValue >Red * .3 + green * .59 + blue * .11 + .5
 Csize< ColorBase >Returns an MPL integral type specifying the number of elements in a color base
 Cstd_fill_tStruct to do std::fill
 Cstep_iterator_adaptor< Derived, Iterator, SFn >An adaptor over an existing iterator that changes the step unit
 Cstep_iterator_adaptor< memory_based_step_iterator< Iterator >, Iterator, memunit_step_fn< Iterator > >
 Ctransposed_type< LocatorOrView >
 Ctype_from_x_iterator< XIterator >Given a pixel iterator defining access to pixels along a row, returns the types of the corresponding built-in step_iterator, xy_locator, image_view
 Ctype_to_index< Types, T >Returns the index corresponding to the first occurrance of a given given type in
 Ctype_to_index< ColorBase::layout_t::color_space_t, Color >
 Cview_is_basic< View >Basic views must be over basic locators
 Cview_type< T, L, IsPlanar, IsStepX, IsMutable >Returns the type of a homogeneous view given the channel type, layout, whether it operates on planar data and whether it has a step horizontally
 Cview_type_from_pixel< Pixel, IsPlanar, IsStepX, IsMutable >Returns the type of a view the pixel type, whether it operates on planar data and whether it has a step horizontally
 Cview_type_from_pixel< Pixel, IsPlanar >
 Cyellow_tYellow