Skip to content

Commit

Permalink
Deploying to gh-pages from @ 1021f00 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
mwestphal committed Dec 30, 2024
1 parent f49132c commit ad6104c
Show file tree
Hide file tree
Showing 75 changed files with 666 additions and 45 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ Derived Types

- ``public f3d::context::loading_exception`` (:ref:`exhale_struct_structf3d_1_1context_1_1loading__exception`)
- ``public f3d::context::symbol_exception`` (:ref:`exhale_struct_structf3d_1_1context_1_1symbol__exception`)
- ``public f3d::engine::cache_exception`` (:ref:`exhale_struct_structf3d_1_1engine_1_1cache__exception`)
- ``public f3d::engine::no_interactor_exception`` (:ref:`exhale_struct_structf3d_1_1engine_1_1no__interactor__exception`)
- ``public f3d::engine::no_window_exception`` (:ref:`exhale_struct_structf3d_1_1engine_1_1no__window__exception`)
- ``public f3d::engine::plugin_exception`` (:ref:`exhale_struct_structf3d_1_1engine_1_1plugin__exception`)
Expand Down
1 change: 1 addition & 0 deletions doc/libf3d/doxygen/_sources/api/classf3d_1_1engine.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ Nested Relationships
Nested Types
************

- :ref:`exhale_struct_structf3d_1_1engine_1_1cache__exception`
- :ref:`exhale_struct_structf3d_1_1engine_1_1libInformation`
- :ref:`exhale_struct_structf3d_1_1engine_1_1no__interactor__exception`
- :ref:`exhale_struct_structf3d_1_1engine_1_1no__window__exception`
Expand Down
2 changes: 2 additions & 0 deletions doc/libf3d/doxygen/_sources/api/file_public_engine.h.rst
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,8 @@ Classes
-------


- :ref:`exhale_struct_structf3d_1_1engine_1_1cache__exception`

- :ref:`exhale_struct_structf3d_1_1engine_1_1libInformation`

- :ref:`exhale_struct_structf3d_1_1engine_1_1no__interactor__exception`
Expand Down
2 changes: 2 additions & 0 deletions doc/libf3d/doxygen/_sources/api/namespace_f3d.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ Classes

- :ref:`exhale_struct_structf3d_1_1context_1_1symbol__exception`

- :ref:`exhale_struct_structf3d_1_1engine_1_1cache__exception`

- :ref:`exhale_struct_structf3d_1_1engine_1_1libInformation`

- :ref:`exhale_struct_structf3d_1_1engine_1_1no__interactor__exception`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ Program Listing for File engine.h
engine& operator=(const engine& other) = delete;
engine& operator=(engine&& other) noexcept;
engine& setCachePath(const std::string& cachePath);
engine& setCachePath(const std::filesystem::path& cachePath);
engine& setOptions(const options& opt);
Expand All @@ -78,12 +78,13 @@ Program Listing for File engine.h
static std::map<std::string, bool> getRenderingBackendList();
static void loadPlugin(
const std::string& nameOrPath, const std::vector<std::string>& pluginSearchPaths = {});
static void loadPlugin(const std::string& pathOrName,
const std::vector<std::filesystem::path>& pluginSearchPaths = {});
static void autoloadPlugins();
[[nodiscard]] static std::vector<std::string> getPluginsList(const std::string& pluginPath);
[[nodiscard]] static std::vector<std::string> getPluginsList(
const std::filesystem::path& pluginPath);
struct libInformation
{
Expand Down Expand Up @@ -128,6 +129,11 @@ Program Listing for File engine.h
explicit plugin_exception(const std::string& what = "");
};
struct cache_exception : public exception
{
explicit cache_exception(const std::string& what = "");
};
private:
class internals;
internals* Internals;
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
.. _exhale_struct_structf3d_1_1engine_1_1cache__exception:

Struct engine::cache_exception
==============================

- Defined in :ref:`file_public_engine.h`


Nested Relationships
--------------------

This struct is a nested type of :ref:`exhale_class_classf3d_1_1engine`.


Inheritance Relationships
-------------------------

Base Type
*********

- ``public f3d::exception`` (:ref:`exhale_class_structf3d_1_1exception`)


Struct Documentation
--------------------


.. doxygenstruct:: f3d::engine::cache_exception
:project: libf3d
:members:
:protected-members:
:undoc-members:
4 changes: 3 additions & 1 deletion doc/libf3d/doxygen/api/class_structf3d_1_1exception.html
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,7 @@
<li class="toctree-l2"><a class="reference internal" href="structf3d_1_1camera__state__t.html">Struct camera_state_t</a></li>
<li class="toctree-l2"><a class="reference internal" href="structf3d_1_1context_1_1loading__exception.html">Struct context::loading_exception</a></li>
<li class="toctree-l2"><a class="reference internal" href="structf3d_1_1context_1_1symbol__exception.html">Struct context::symbol_exception</a></li>
<li class="toctree-l2"><a class="reference internal" href="structf3d_1_1engine_1_1cache__exception.html">Struct engine::cache_exception</a></li>
<li class="toctree-l2"><a class="reference internal" href="structf3d_1_1engine_1_1libInformation.html">Struct engine::libInformation</a></li>
<li class="toctree-l2"><a class="reference internal" href="structf3d_1_1engine_1_1no__interactor__exception.html">Struct engine::no_interactor_exception</a></li>
<li class="toctree-l2"><a class="reference internal" href="structf3d_1_1engine_1_1no__window__exception.html">Struct engine::no_window_exception</a></li>
Expand Down Expand Up @@ -348,6 +349,7 @@ <h3>Derived Types<a class="headerlink" href="#derived-types" title="Permalink to
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">public</span> <span class="pre">f3d::context::loading_exception</span></code> (<a class="reference internal" href="structf3d_1_1context_1_1loading__exception.html#exhale-struct-structf3d-1-1context-1-1loading-exception"><span class="std std-ref">Struct context::loading_exception</span></a>)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">public</span> <span class="pre">f3d::context::symbol_exception</span></code> (<a class="reference internal" href="structf3d_1_1context_1_1symbol__exception.html#exhale-struct-structf3d-1-1context-1-1symbol-exception"><span class="std std-ref">Struct context::symbol_exception</span></a>)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">public</span> <span class="pre">f3d::engine::cache_exception</span></code> (<a class="reference internal" href="structf3d_1_1engine_1_1cache__exception.html#exhale-struct-structf3d-1-1engine-1-1cache-exception"><span class="std std-ref">Struct engine::cache_exception</span></a>)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">public</span> <span class="pre">f3d::engine::no_interactor_exception</span></code> (<a class="reference internal" href="structf3d_1_1engine_1_1no__interactor__exception.html#exhale-struct-structf3d-1-1engine-1-1no-interactor-exception"><span class="std std-ref">Struct engine::no_interactor_exception</span></a>)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">public</span> <span class="pre">f3d::engine::no_window_exception</span></code> (<a class="reference internal" href="structf3d_1_1engine_1_1no__window__exception.html#exhale-struct-structf3d-1-1engine-1-1no-window-exception"><span class="std std-ref">Struct engine::no_window_exception</span></a>)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">public</span> <span class="pre">f3d::engine::plugin_exception</span></code> (<a class="reference internal" href="structf3d_1_1engine_1_1plugin__exception.html#exhale-struct-structf3d-1-1engine-1-1plugin-exception"><span class="std std-ref">Struct engine::plugin_exception</span></a>)</p></li>
Expand All @@ -369,7 +371,7 @@ <h2>Class Documentation<a class="headerlink" href="#class-documentation" title="
<span id="_CPPv3N3f3d9exceptionE"></span><span id="_CPPv2N3f3d9exceptionE"></span><span id="f3d::exception"></span><span class="target" id="structf3d_1_1exception"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">exception</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</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">runtime_error</span></span><a class="headerlink" href="#_CPPv4N3f3d9exceptionE" title="Permalink to this definition">#</a><br /></dt>
<dd><p>a generic exception used in the libf3d </p>
<p>A generic exception used in the libf3d. Can be used to catch all exceptions when needed. </p>
<p>Subclassed by <a class="reference internal" href="structf3d_1_1context_1_1loading__exception.html#structf3d_1_1context_1_1loading__exception"><span class="std std-ref">f3d::context::loading_exception</span></a>, <a class="reference internal" href="structf3d_1_1context_1_1symbol__exception.html#structf3d_1_1context_1_1symbol__exception"><span class="std std-ref">f3d::context::symbol_exception</span></a>, <a class="reference internal" href="structf3d_1_1engine_1_1no__interactor__exception.html#structf3d_1_1engine_1_1no__interactor__exception"><span class="std std-ref">f3d::engine::no_interactor_exception</span></a>, <a class="reference internal" href="structf3d_1_1engine_1_1no__window__exception.html#structf3d_1_1engine_1_1no__window__exception"><span class="std std-ref">f3d::engine::no_window_exception</span></a>, <a class="reference internal" href="structf3d_1_1engine_1_1plugin__exception.html#structf3d_1_1engine_1_1plugin__exception"><span class="std std-ref">f3d::engine::plugin_exception</span></a>, <a class="reference internal" href="structf3d_1_1image_1_1metadata__exception.html#structf3d_1_1image_1_1metadata__exception"><span class="std std-ref">f3d::image::metadata_exception</span></a>, <a class="reference internal" href="structf3d_1_1image_1_1read__exception.html#structf3d_1_1image_1_1read__exception"><span class="std std-ref">f3d::image::read_exception</span></a>, <a class="reference internal" href="structf3d_1_1image_1_1write__exception.html#structf3d_1_1image_1_1write__exception"><span class="std std-ref">f3d::image::write_exception</span></a>, <a class="reference internal" href="structf3d_1_1interactor_1_1already__exists__exception.html#structf3d_1_1interactor_1_1already__exists__exception"><span class="std std-ref">f3d::interactor::already_exists_exception</span></a>, <a class="reference internal" href="structf3d_1_1interactor_1_1command__runtime__exception.html#structf3d_1_1interactor_1_1command__runtime__exception"><span class="std std-ref">f3d::interactor::command_runtime_exception</span></a>, <a class="reference internal" href="structf3d_1_1interactor_1_1does__not__exists__exception.html#structf3d_1_1interactor_1_1does__not__exists__exception"><span class="std std-ref">f3d::interactor::does_not_exists_exception</span></a>, <a class="reference internal" href="structf3d_1_1scene_1_1load__failure__exception.html#structf3d_1_1scene_1_1load__failure__exception"><span class="std std-ref">f3d::scene::load_failure_exception</span></a>, <a class="reference internal" href="structf3d_1_1utils_1_1tokenize__exception.html#structf3d_1_1utils_1_1tokenize__exception"><span class="std std-ref">f3d::utils::tokenize_exception</span></a></p>
<p>Subclassed by <a class="reference internal" href="structf3d_1_1context_1_1loading__exception.html#structf3d_1_1context_1_1loading__exception"><span class="std std-ref">f3d::context::loading_exception</span></a>, <a class="reference internal" href="structf3d_1_1context_1_1symbol__exception.html#structf3d_1_1context_1_1symbol__exception"><span class="std std-ref">f3d::context::symbol_exception</span></a>, <a class="reference internal" href="structf3d_1_1engine_1_1cache__exception.html#structf3d_1_1engine_1_1cache__exception"><span class="std std-ref">f3d::engine::cache_exception</span></a>, <a class="reference internal" href="structf3d_1_1engine_1_1no__interactor__exception.html#structf3d_1_1engine_1_1no__interactor__exception"><span class="std std-ref">f3d::engine::no_interactor_exception</span></a>, <a class="reference internal" href="structf3d_1_1engine_1_1no__window__exception.html#structf3d_1_1engine_1_1no__window__exception"><span class="std std-ref">f3d::engine::no_window_exception</span></a>, <a class="reference internal" href="structf3d_1_1engine_1_1plugin__exception.html#structf3d_1_1engine_1_1plugin__exception"><span class="std std-ref">f3d::engine::plugin_exception</span></a>, <a class="reference internal" href="structf3d_1_1image_1_1metadata__exception.html#structf3d_1_1image_1_1metadata__exception"><span class="std std-ref">f3d::image::metadata_exception</span></a>, <a class="reference internal" href="structf3d_1_1image_1_1read__exception.html#structf3d_1_1image_1_1read__exception"><span class="std std-ref">f3d::image::read_exception</span></a>, <a class="reference internal" href="structf3d_1_1image_1_1write__exception.html#structf3d_1_1image_1_1write__exception"><span class="std std-ref">f3d::image::write_exception</span></a>, <a class="reference internal" href="structf3d_1_1interactor_1_1already__exists__exception.html#structf3d_1_1interactor_1_1already__exists__exception"><span class="std std-ref">f3d::interactor::already_exists_exception</span></a>, <a class="reference internal" href="structf3d_1_1interactor_1_1command__runtime__exception.html#structf3d_1_1interactor_1_1command__runtime__exception"><span class="std std-ref">f3d::interactor::command_runtime_exception</span></a>, <a class="reference internal" href="structf3d_1_1interactor_1_1does__not__exists__exception.html#structf3d_1_1interactor_1_1does__not__exists__exception"><span class="std std-ref">f3d::interactor::does_not_exists_exception</span></a>, <a class="reference internal" href="structf3d_1_1scene_1_1load__failure__exception.html#structf3d_1_1scene_1_1load__failure__exception"><span class="std std-ref">f3d::scene::load_failure_exception</span></a>, <a class="reference internal" href="structf3d_1_1utils_1_1tokenize__exception.html#structf3d_1_1utils_1_1tokenize__exception"><span class="std std-ref">f3d::utils::tokenize_exception</span></a></p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p>
<dl class="cpp function">
Expand Down
1 change: 1 addition & 0 deletions doc/libf3d/doxygen/api/classf3d_1_1camera.html
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,7 @@
<li class="toctree-l2"><a class="reference internal" href="structf3d_1_1camera__state__t.html">Struct camera_state_t</a></li>
<li class="toctree-l2"><a class="reference internal" href="structf3d_1_1context_1_1loading__exception.html">Struct context::loading_exception</a></li>
<li class="toctree-l2"><a class="reference internal" href="structf3d_1_1context_1_1symbol__exception.html">Struct context::symbol_exception</a></li>
<li class="toctree-l2"><a class="reference internal" href="structf3d_1_1engine_1_1cache__exception.html">Struct engine::cache_exception</a></li>
<li class="toctree-l2"><a class="reference internal" href="structf3d_1_1engine_1_1libInformation.html">Struct engine::libInformation</a></li>
<li class="toctree-l2"><a class="reference internal" href="structf3d_1_1engine_1_1no__interactor__exception.html">Struct engine::no_interactor_exception</a></li>
<li class="toctree-l2"><a class="reference internal" href="structf3d_1_1engine_1_1no__window__exception.html">Struct engine::no_window_exception</a></li>
Expand Down
1 change: 1 addition & 0 deletions doc/libf3d/doxygen/api/classf3d_1_1context.html
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,7 @@
<li class="toctree-l2"><a class="reference internal" href="structf3d_1_1camera__state__t.html">Struct camera_state_t</a></li>
<li class="toctree-l2"><a class="reference internal" href="structf3d_1_1context_1_1loading__exception.html">Struct context::loading_exception</a></li>
<li class="toctree-l2"><a class="reference internal" href="structf3d_1_1context_1_1symbol__exception.html">Struct context::symbol_exception</a></li>
<li class="toctree-l2"><a class="reference internal" href="structf3d_1_1engine_1_1cache__exception.html">Struct engine::cache_exception</a></li>
<li class="toctree-l2"><a class="reference internal" href="structf3d_1_1engine_1_1libInformation.html">Struct engine::libInformation</a></li>
<li class="toctree-l2"><a class="reference internal" href="structf3d_1_1engine_1_1no__interactor__exception.html">Struct engine::no_interactor_exception</a></li>
<li class="toctree-l2"><a class="reference internal" href="structf3d_1_1engine_1_1no__window__exception.html">Struct engine::no_window_exception</a></li>
Expand Down
Loading

0 comments on commit ad6104c

Please sign in to comment.