Deploying to gh-pages from @ b87ba39 🚀

doc/libf3d/doxygen/_sources/api/program_listing_file_public_image.h.rst

@@ -93,6 +93,12 @@ Program Listing for File image.h
    
      std::string toTerminalText() const;
    
+     f3d::image& setMetadata(const std::string& key, const std::string& value);
+   
+     std::string getMetadata(const std::string& key) const;
+   
+     std::vector<std::string> allMetadata() const;
+   
      struct write_exception : public exception
      {
        explicit write_exception(const std::string& what = "");

doc/libf3d/doxygen/api/classf3d_1_1image.html

@@ -641,6 +641,24 @@ <h3>Enumeration of supported channel types<a class="headerlink" href="#classf3d_
 <dd><p>Convert to colored text using ANSI escape sequences for printing in a terminal. See <code class="docutils literal notranslate"><span class="pre">toTerminalText(std::ostream&amp;</span> <span class="pre">stream)</span></code>. Throw an exception if the type is not byte RGB or RGBA. </p>
 </dd></dl>
 
+<dl class="cpp function">
+<dt class="sig sig-object cpp" id="_CPPv4N3f3d5image11setMetadataERKNSt6stringERKNSt6stringE">
+<span id="_CPPv3N3f3d5image11setMetadataERKNSt6stringERKNSt6stringE"></span><span id="_CPPv2N3f3d5image11setMetadataERKNSt6stringERKNSt6stringE"></span><span id="f3d::image::setMetadata__ssCR.ssCR"></span><span class="target" id="classf3d_1_1image_1a32e0075670083a45a61dbdba0dc50977"></span><span class="n"><span class="pre">f3d</span></span><span class="p"><span class="pre">::</span></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">setMetadata</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">string</span></span><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">key</span></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">string</span></span><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">value</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N3f3d5image11setMetadataERKNSt6stringERKNSt6stringE" title="Permalink to this definition">#</a><br /></dt>
+<dd><p>Set the value for a metadata key. Setting an empty value (<code class="docutils literal notranslate"><span class="pre">&quot;&quot;</span></code>) removes the key. </p>
+</dd></dl>
+
+<dl class="cpp function">
+<dt class="sig sig-object cpp" id="_CPPv4NK3f3d5image11getMetadataERKNSt6stringE">
+<span id="_CPPv3NK3f3d5image11getMetadataERKNSt6stringE"></span><span id="_CPPv2NK3f3d5image11getMetadataERKNSt6stringE"></span><span id="f3d::image::getMetadata__ssCRC"></span><span class="target" id="classf3d_1_1image_1a9e10e64f8bde29faaba00e00d134e60f"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">getMetadata</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">string</span></span><span class="w"> </span><span class="p"><span class="pre">&amp;</span></span><span class="n sig-param"><span class="pre">key</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK3f3d5image11getMetadataERKNSt6stringE" title="Permalink to this definition">#</a><br /></dt>
+<dd><p>Get the value for a metadata key. Throw <code class="docutils literal notranslate"><span class="pre">std::invalid_argument</span></code> exception if key does not exist. </p>
+</dd></dl>
+
+<dl class="cpp function">
+<dt class="sig sig-object cpp" id="_CPPv4NK3f3d5image11allMetadataEv">
+<span id="_CPPv3NK3f3d5image11allMetadataEv"></span><span id="_CPPv2NK3f3d5image11allMetadataEv"></span><span id="f3d::image::allMetadataC"></span><span class="target" id="classf3d_1_1image_1ab38f65cfcaf6baadac1b46c50ae5da2f"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">vector</span></span><span class="p"><span class="pre">&lt;</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">&gt;</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">allMetadata</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK3f3d5image11allMetadataEv" title="Permalink to this definition">#</a><br /></dt>
+<dd><p>List all the metadata keys which have a value set. </p>
+</dd></dl>
+
 </div>
 <div class="breathe-sectiondef docutils container">
 <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-static-functions">Public Static Functions</p>

doc/libf3d/doxygen/api/program_listing_file_public_image.h.html

@@ -390,6 +390,12 @@ <h1>Program Listing for File image.h</h1>
 
 <span class="w">  </span><span class="n">std</span><span class="o">::</span><span class="n">string</span><span class="w"> </span><span class="nf">toTerminalText</span><span class="p">()</span><span class="w"> </span><span class="k">const</span><span class="p">;</span>
 
+<span class="w">  </span><span class="n">f3d</span><span class="o">::</span><span class="n">image</span><span class="o">&amp;</span><span class="w"> </span><span class="nf">setMetadata</span><span class="p">(</span><span class="k">const</span><span class="w"> </span><span class="n">std</span><span class="o">::</span><span class="n">string</span><span class="o">&amp;</span><span class="w"> </span><span class="n">key</span><span class="p">,</span><span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="n">std</span><span class="o">::</span><span class="n">string</span><span class="o">&amp;</span><span class="w"> </span><span class="n">value</span><span class="p">);</span>
+
+<span class="w">  </span><span class="n">std</span><span class="o">::</span><span class="n">string</span><span class="w"> </span><span class="nf">getMetadata</span><span class="p">(</span><span class="k">const</span><span class="w"> </span><span class="n">std</span><span class="o">::</span><span class="n">string</span><span class="o">&amp;</span><span class="w"> </span><span class="n">key</span><span class="p">)</span><span class="w"> </span><span class="k">const</span><span class="p">;</span>
+
+<span class="w">  </span><span class="n">std</span><span class="o">::</span><span class="n">vector</span><span class="o">&lt;</span><span class="n">std</span><span class="o">::</span><span class="n">string</span><span class="o">&gt;</span><span class="w"> </span><span class="n">allMetadata</span><span class="p">()</span><span class="w"> </span><span class="k">const</span><span class="p">;</span>
+
 <span class="w">  </span><span class="k">struct</span><span class="w"> </span><span class="nc">write_exception</span><span class="w"> </span><span class="o">:</span><span class="w"> </span><span class="k">public</span><span class="w"> </span><span class="n">exception</span>
 <span class="w">  </span><span class="p">{</span>
 <span class="w">    </span><span class="k">explicit</span><span class="w"> </span><span class="n">write_exception</span><span class="p">(</span><span class="k">const</span><span class="w"> </span><span class="n">std</span><span class="o">::</span><span class="n">string</span><span class="o">&amp;</span><span class="w"> </span><span class="n">what</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;&quot;</span><span class="p">);</span>

doc/libf3d/doxygen/genindex.html

@@ -406,6 +406,8 @@ <h2 id="F">F</h2>
       <li><a href="api/class_structf3d_1_1exception.html#_CPPv4N3f3d9exception9exceptionERKNSt6stringE">f3d::exception::exception (C++ function)</a>
 </li>
       <li><a href="api/classf3d_1_1image.html#_CPPv4N3f3d5imageE">f3d::image (C++ class)</a>
+</li>
+      <li><a href="api/classf3d_1_1image.html#_CPPv4NK3f3d5image11allMetadataEv">f3d::image::allMetadata (C++ function)</a>
 </li>
       <li><a href="api/classf3d_1_1image.html#_CPPv4N3f3d5image11ChannelTypeE">f3d::image::ChannelType (C++ enum)</a>
 </li>
@@ -426,6 +428,8 @@ <h2 id="F">F</h2>
       <li><a href="api/classf3d_1_1image.html#_CPPv4NK3f3d5image10getContentEv">f3d::image::getContent (C++ function)</a>
 </li>
       <li><a href="api/classf3d_1_1image.html#_CPPv4NK3f3d5image9getHeightEv">f3d::image::getHeight (C++ function)</a>
+</li>
+      <li><a href="api/classf3d_1_1image.html#_CPPv4NK3f3d5image11getMetadataERKNSt6stringE">f3d::image::getMetadata (C++ function)</a>
 </li>
       <li><a href="api/classf3d_1_1image.html#_CPPv4N3f3d5image19getSupportedFormatsEv">f3d::image::getSupportedFormats (C++ function)</a>
 </li>
@@ -458,11 +462,13 @@ <h2 id="F">F</h2>
       <li><a href="api/classf3d_1_1image.html#_CPPv4N3f3d5image10SaveFormat3TIFE">f3d::image::SaveFormat::TIF (C++ enumerator)</a>
 </li>
       <li><a href="api/classf3d_1_1image.html#_CPPv4N3f3d5image10setContentEPv">f3d::image::setContent (C++ function)</a>
-</li>
-      <li><a href="api/classf3d_1_1image.html#_CPPv4NK3f3d5image14toTerminalTextERNSt7ostreamE">f3d::image::toTerminalText (C++ function)</a>, <a href="api/classf3d_1_1image.html#_CPPv4NK3f3d5image14toTerminalTextEv">[1]</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api/classf3d_1_1image.html#_CPPv4N3f3d5image11setMetadataERKNSt6stringERKNSt6stringE">f3d::image::setMetadata (C++ function)</a>
+</li>
+      <li><a href="api/classf3d_1_1image.html#_CPPv4NK3f3d5image14toTerminalTextERNSt7ostreamE">f3d::image::toTerminalText (C++ function)</a>, <a href="api/classf3d_1_1image.html#_CPPv4NK3f3d5image14toTerminalTextEv">[1]</a>
+</li>
       <li><a href="api/classf3d_1_1image.html#_CPPv4N3f3d5image15write_exceptionE">f3d::image::write_exception (C++ struct)</a>, <a href="api/structf3d_1_1image_1_1write__exception.html#_CPPv4N3f3d5image15write_exceptionE">[1]</a>
 </li>
       <li><a href="api/classf3d_1_1image.html#_CPPv4N3f3d5image15write_exception15write_exceptionERKNSt6stringE">f3d::image::write_exception::write_exception (C++ function)</a>, <a href="api/structf3d_1_1image_1_1write__exception.html#_CPPv4N3f3d5image15write_exception15write_exceptionERKNSt6stringE">[1]</a>