Commit 89b9dfa8 authored by Davis King's avatar Davis King

updated docs

parent 747088ea
......@@ -83,6 +83,7 @@
<item>save_bmp</item>
<item>save_dng</item>
<item>save_png</item>
<item>save_jpeg</item>
</section>
<section>
......@@ -974,6 +975,30 @@
</component>
<!-- ************************************************************************* -->
<component>
<name>save_jpeg</name>
<file>dlib/image_io.h</file>
<spec_file link="true">dlib/image_saver/save_jpeg_abstract.h</spec_file>
<description>
This global function writes an image to disk as a JPEG file.
<p>
Note that you must define DLIB_JPEG_SUPPORT if you want to use this function. You
must also set your build environment to link to the libjpeg library. However,
if you use CMake and dlib's default CMakeLists.txt file then it will get setup
automatically.
</p>
<p>
This routine can save images containing any type of pixel. However, save_jpeg() can
only natively store the following pixel types: <b>rgb_pixel</b>
and <b>uint8</b>. All other pixel types will be converted into
one of these types as appropriate before being saved to disk.
</p>
</description>
</component>
<!-- ************************************************************************* -->
<component>
......
......@@ -1223,6 +1223,7 @@
<term link="imaging.html#rgb_alpha_pixel" name="alpha"/>
<term file="imaging.html" name="save_bmp" include="dlib/image_io.h"/>
<term file="imaging.html" name="save_png" include="dlib/image_io.h"/>
<term file="imaging.html" name="save_jpeg" include="dlib/image_io.h"/>
<term file="imaging.html" name="load_image" include="dlib/image_io.h"/>
<term file="imaging.html" name="save_dng" include="dlib/image_io.h"/>
<term file="dlib/image_transforms/spatial_filtering_abstract.h.html" name="create_gaussian_filter" include="dlib/image_transforms.h"/>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment