Reference

The complete API reference is generated from the header comments with MrDocs. This page groups the most commonly used types and concepts by area; browse the full boost::gil namespace index for everything else, including free functions and metafunctions (most of which are heavily overloaded and don’t have a single canonical page).

Point Channel Color Space & Layout

Point	Channel	Color Space & Layout
`point` `Point2DConcept` `PointNDConcept`	`ChannelConcept` `ChannelValueConcept` `MutableChannelConcept`	`ColorSpaceConcept` `ColorSpacesCompatibleConcept` `ChannelMappingConcept` `layout` `gray_t`, `rgb_t`, `rgba_t`, `cmyk_t`
Color Base	PixelBased	Pixel
`ColorBaseConcept` `HomogeneousColorBaseConcept` `MutableColorBaseConcept`	`PixelBasedConcept` `HomogeneousPixelBasedConcept`	`pixel` `packed_pixel` `bit_aligned_pixel_reference` `planar_pixel_reference` `PixelConcept` `HomogeneousPixelConcept` `MutablePixelConcept`
Pixel Iterator	Pixel Locator	Image View
`PixelIteratorConcept` `MutablePixelIteratorConcept` `memory_based_step_iterator` `planar_pixel_iterator` `bit_aligned_pixel_iterator`	`PixelLocatorConcept` `RandomAccess2DLocatorConcept` `memory_based_2d_locator` `virtual_2d_locator`	`ImageViewConcept` `RandomAccess2DImageViewConcept` `image_view`
Image	Dynamic Image (Variant)	Toolbox
`ImageConcept` `image`	`any_image` `any_image_view`	`indexed_image`
Numeric	IO
`matrix3x2` `kernel_1d` `kernel_1d_fixed`	`image_read_settings` `image_write_info` `format_tag` `reader_backend`

ChannelValueConcept

MutableChannelConcept

ColorSpaceConcept

ColorSpacesCompatibleConcept

ChannelMappingConcept

layout

gray_t, rgb_t, rgba_t, cmyk_t

Color Base

PixelBased

Pixel

ColorBaseConcept

HomogeneousColorBaseConcept

MutableColorBaseConcept

PixelBasedConcept

HomogeneousPixelBasedConcept

pixel

packed_pixel

bit_aligned_pixel_reference

planar_pixel_reference

PixelConcept

HomogeneousPixelConcept

MutablePixelConcept

Pixel Iterator

Pixel Locator

Image View

PixelIteratorConcept

MutablePixelIteratorConcept

memory_based_step_iterator

planar_pixel_iterator

bit_aligned_pixel_iterator

PixelLocatorConcept

RandomAccess2DLocatorConcept

memory_based_2d_locator

virtual_2d_locator

ImageViewConcept

RandomAccess2DImageViewConcept

image_view

Image

Dynamic Image (Variant)

Toolbox

Numeric

image_read_settings

image_write_info

format_tag

reader_backend

The extension/io/{jpeg,png,tiff,bmp,pnm,raw} format backends aren’t in this reference yet — MrDocs needs the corresponding image library (libjpeg, libpng, libtiff, …) just to parse those headers, and the doc build doesn’t pull those in. See doc/mrdocs-src/all.cpp for the exact scope.

Edit this Page