Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Documentation #731

Merged
merged 1 commit into from
Mar 16, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions doc/design/dynamic_image.rst
Original file line number Diff line number Diff line change
Expand Up @@ -159,14 +159,14 @@ upside down:

.. code-block:: cpp

#include <boost\gil\extension\io\jpeg_dynamic_io.hpp>
#include <boost\gil\extension\io\jpeg.hpp>

template <typename Image> // Could be rgb8_image_t or any_image<...>
void save_180rot(const std::string& file_name)
{
Image img;
jpeg_read_image(file_name, img);
jpeg_write_view(file_name, rotated180_view(view(img)));
read_image(file_name, img, jpeg_tag());
write_view(file_name, rotated180_view(view(img)), jpeg_tag());
}

It can be instantiated with either a compile-time or a runtime image
Expand Down
6 changes: 4 additions & 2 deletions doc/io.rst
Original file line number Diff line number Diff line change
Expand Up @@ -172,6 +172,8 @@ provides access to the so-called backend.

For instance::

typedef bmp_tag tag_t;

typedef get_reader_backend< const std::string
, tag_t
>::type backend_t;
Expand Down Expand Up @@ -245,7 +247,7 @@ The following example shows this feature::
, gray16_image_t
, rgb8_image_t
, rgba8_image_t
> my_img_types > runtime_image;
> runtime_image;

read_image( filename
, runtime_image
Expand Down Expand Up @@ -323,7 +325,7 @@ Writing an any_image<...> is supported. See the following example::
, gray16_image_t
, rgb8_image_t
, rgba8_image_t
> my_img_types > runtime_image;
> runtime_image;

// fill any_image

Expand Down