Skip to content

Commit

Permalink
Deploying to gh-pages from @ d4ee580 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
mwestphal committed Jan 3, 2025
1 parent e4639a2 commit 331dd69
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion doc/libf3d/doxygen/api/classf3d_1_1image.html
Original file line number Diff line number Diff line change
Expand Up @@ -581,7 +581,7 @@ <h3>Enumeration of supported channel types<a class="headerlink" href="#classf3d_
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4NK3f3d5image4saveERKNSt10filesystem4pathE10SaveFormat">
<span id="_CPPv3NK3f3d5image4saveERKNSt10filesystem4pathE10SaveFormat"></span><span id="_CPPv2NK3f3d5image4saveERKNSt10filesystem4pathE10SaveFormat"></span><span id="f3d::image::save__std::filesystem::pathCR.SaveFormatC"></span><span class="target" id="classf3d_1_1image_1a7c19d3cc76a900fd25a9ac41fbb36d40"></span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N3f3d5imageE" title="f3d::image"><span class="n"><span class="pre">image</span></span></a><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="sig-name descname"><span class="n"><span class="pre">save</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">filesystem</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">path</span></span><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">filePath</span></span>, <a class="reference internal" href="#_CPPv4N3f3d5image10SaveFormatE" title="f3d::image::SaveFormat"><span class="n"><span class="pre">SaveFormat</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">format</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N3f3d5image10SaveFormatE" title="f3d::image::SaveFormat"><span class="n"><span class="pre">SaveFormat</span></span></a><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N3f3d5image10SaveFormat3PNGE" title="f3d::image::SaveFormat::PNG"><span class="n"><span class="pre">PNG</span></span></a><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK3f3d5image4saveERKNSt10filesystem4pathE10SaveFormat" title="Permalink to this definition">#</a><br /></dt>
<dd><p>Save an image to the provided file path, used as is, in the specified format. Default format is PNG if not specified. PNG: Supports channel type BYTE and SHORT with channel count of 1 to 4 JPG: Supports channel type BYTE with channel count of 1 or 3 TIF: Supports channel type BYTE, SHORT and FLOAT with channel count of 1 to 4 BMP: Supports channel type BYTE with channel count of 1 to 4 Throw an <code class="docutils literal notranslate"><a class="reference internal" href="structf3d_1_1image_1_1write__exception.html#structf3d_1_1image_1_1write__exception"><span class="std std-ref"><span class="pre">image::write_exception</span></span></a></code> if the format is incompatible with with image channel type or channel count </p>
<dd><p>Save an image to the provided file path, used as is, in the specified format. Default format is PNG if not specified. PNG: Supports channel type BYTE and SHORT with channel count of 1 to 4 JPG: Supports channel type BYTE with channel count of 1 or 3 TIF: Supports channel type BYTE, SHORT and FLOAT with channel count of 1 to 4 BMP: Supports channel type BYTE with channel count of 1 to 4 Throw an <code class="docutils literal notranslate"><a class="reference internal" href="structf3d_1_1image_1_1write__exception.html#structf3d_1_1image_1_1write__exception"><span class="std std-ref"><span class="pre">image::write_exception</span></span></a></code> if the format is incompatible with with image channel type or channel count or if the image cannot be written for any other reason. </p>
</dd></dl>

<dl class="cpp function">
Expand Down
2 changes: 1 addition & 1 deletion doc/libf3d/doxygen/searchindex.js

Large diffs are not rendered by default.

0 comments on commit 331dd69

Please sign in to comment.