Deploying to gh-pages from @ e889eeb 🚀

kosude · Dec 22, 2023 · 1484439 · 1484439
1 parent ed5cd5d
commit 1484439
Show file tree

Hide file tree

Showing 27 changed files with 392 additions and 58 deletions.
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/.doctrees/pages/api/core/_core.doctree b/.doctrees/pages/api/core/_core.doctree
diff --git a/.doctrees/pages/api/core/debuggers.doctree b/.doctrees/pages/api/core/debuggers.doctree
diff --git a/.doctrees/pages/api/core/pipelines.doctree b/.doctrees/pages/api/core/pipelines.doctree
diff --git a/.doctrees/pages/api/core/renderers.doctree b/.doctrees/pages/api/core/renderers.doctree
diff --git a/_sources/pages/api/core/_core.rst.txt b/_sources/pages/api/core/_core.rst.txt
@@ -9,7 +9,8 @@ Objects and functions defined within the core Thallium library, exposed by ``tha
 
     context
     debuggers
+    pipelines
+    primitive_data
     renderers
     swapchains
-    primitive_data
     wsi
diff --git a/_sources/pages/api/core/pipelines.rst.txt b/_sources/pages/api/core/pipelines.rst.txt
@@ -0,0 +1,40 @@
+Pipelines
+=========
+
+This section describes the use of Thallium's cross-API **pipeline objects**.
+
+
+*****
+
+
+Types
+-----
+
+
+Objects
+^^^^^^^
+
+.. doxygentypedef:: TL_Pipeline_t
+
+
+Descriptors
+^^^^^^^^^^^
+
+.. doxygenstruct:: TL_PipelineDescriptor_t
+    :members:
+
+
+Enums
+^^^^^
+
+.. doxygenenum:: TL_PipelineType_t
+
+
+*****
+
+
+Functions
+---------
+
+.. doxygenfunction:: TL_PipelineCreate
+.. doxygenfunction:: TL_PipelineDestroy
diff --git a/_static/documentation_options.js b/_static/documentation_options.js
@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: 'v0.0.0dev_1468d8a (2023-12-22)',
+    VERSION: 'v0.0.0dev_e889eeb (2023-12-22)',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/genindex.html b/genindex.html
@@ -40,7 +40,7 @@
               <img src="_static/logo_wtext.svg" class="logo" alt="Logo"/>
           </a>
               <div class="version">
-                v0.0.0dev_1468d8a (2023-12-22)
+                v0.0.0dev_e889eeb (2023-12-22)
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
@@ -149,11 +149,31 @@ <h2 id="T">T</h2>
       <li><a href="pages/api/core/primitive_data.html#c.TL_Extent2D_t.height">TL_Extent2D_t.height (C var)</a>
 </li>
       <li><a href="pages/api/core/primitive_data.html#c.TL_Extent2D_t.width">TL_Extent2D_t.width (C var)</a>
+</li>
+      <li><a href="pages/api/core/pipelines.html#c.TL_Pipeline_t">TL_Pipeline_t (C type)</a>
+</li>
+      <li><a href="pages/api/core/pipelines.html#c.TL_PipelineCreate">TL_PipelineCreate (C function)</a>
+</li>
+      <li><a href="pages/api/core/pipelines.html#c.TL_PipelineDescriptor_t">TL_PipelineDescriptor_t (C struct)</a>
+</li>
+      <li><a href="pages/api/core/pipelines.html#c.TL_PipelineDescriptor_t.type">TL_PipelineDescriptor_t.type (C var)</a>
+</li>
+      <li><a href="pages/api/core/pipelines.html#c.TL_PipelineDestroy">TL_PipelineDestroy (C function)</a>
+</li>
+      <li><a href="pages/api/core/pipelines.html#c.TL_PipelineType_t">TL_PipelineType_t (C enum)</a>
+</li>
+      <li><a href="pages/api/core/pipelines.html#c.TL_PipelineType_t.TL_PIPELINE_TYPE_COMPUTE">TL_PipelineType_t.TL_PIPELINE_TYPE_COMPUTE (C enumerator)</a>
+</li>
+      <li><a href="pages/api/core/pipelines.html#c.TL_PipelineType_t.TL_PIPELINE_TYPE_GRAPHICS">TL_PipelineType_t.TL_PIPELINE_TYPE_GRAPHICS (C enumerator)</a>
+</li>
+      <li><a href="pages/api/core/pipelines.html#c.TL_PipelineType_t.TL_PIPELINE_TYPE_RAY_TRACING">TL_PipelineType_t.TL_PIPELINE_TYPE_RAY_TRACING (C enumerator)</a>
 </li>
       <li><a href="pages/api/core/renderers.html#c.TL_Renderer_t">TL_Renderer_t (C type)</a>
 </li>
       <li><a href="pages/api/core/renderers.html#c.TL_RendererAPIFlags_t">TL_RendererAPIFlags_t (C enum)</a>
 </li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="pages/api/core/renderers.html#c.TL_RendererAPIFlags_t.TL_RENDERER_API_NULL_BIT">TL_RendererAPIFlags_t.TL_RENDERER_API_NULL_BIT (C enumerator)</a>
 </li>
       <li><a href="pages/api/core/renderers.html#c.TL_RendererAPIFlags_t.TL_RENDERER_API_VULKAN_BIT">TL_RendererAPIFlags_t.TL_RENDERER_API_VULKAN_BIT (C enumerator)</a>
@@ -162,8 +182,6 @@ <h2 id="T">T</h2>
 </li>
       <li><a href="pages/api/core/renderers.html#c.TL_RendererDescriptor_t">TL_RendererDescriptor_t (C struct)</a>
 </li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="pages/api/core/renderers.html#c.TL_RendererDescriptor_t.api">TL_RendererDescriptor_t.api (C var)</a>
 </li>
       <li><a href="pages/api/core/renderers.html#c.TL_RendererDescriptor_t.api_version">TL_RendererDescriptor_t.api_version (C var)</a>
@@ -254,7 +272,7 @@ <h2 id="T">T</h2>
   </div>
 
 
-    v0.0.0dev_1468d8a (2023-12-22) » <a href="https://github.com/kosude/thallium">upstream url</a>
+    v0.0.0dev_e889eeb (2023-12-22) » <a href="https://github.com/kosude/thallium">upstream url</a>
 
 </footer>
         </div>

diff --git a/index.html b/index.html
@@ -42,7 +42,7 @@
               <img src="_static/logo_wtext.svg" class="logo" alt="Logo"/>
           </a>
               <div class="version">
-                v0.0.0dev_1468d8a (2023-12-22)
+                v0.0.0dev_e889eeb (2023-12-22)
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
@@ -175,7 +175,7 @@ <h2>Information for contributing<a class="headerlink" href="#information-for-con
   </div>
 
 
-    v0.0.0dev_1468d8a (2023-12-22) » <a href="https://github.com/kosude/thallium">upstream url</a>
+    v0.0.0dev_e889eeb (2023-12-22) » <a href="https://github.com/kosude/thallium">upstream url</a>
 
 </footer>
         </div>

diff --git a/objects.inv b/objects.inv
diff --git a/pages/api/_api.html b/pages/api/_api.html
@@ -43,7 +43,7 @@
               <img src="../../_static/logo_wtext.svg" class="logo" alt="Logo"/>
           </a>
               <div class="version">
-                v0.0.0dev_1468d8a (2023-12-22)
+                v0.0.0dev_e889eeb (2023-12-22)
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
@@ -112,7 +112,7 @@ <h1>API Reference<a class="headerlink" href="#api-reference" title="Permalink to
   </div>
 
 
-    v0.0.0dev_1468d8a (2023-12-22) » <a href="https://github.com/kosude/thallium">upstream url</a>
+    v0.0.0dev_e889eeb (2023-12-22) » <a href="https://github.com/kosude/thallium">upstream url</a>
 
 </footer>
         </div>

diff --git a/pages/api/core/_core.html b/pages/api/core/_core.html
@@ -43,7 +43,7 @@
               <img src="../../../_static/logo_wtext.svg" class="logo" alt="Logo"/>
           </a>
               <div class="version">
-                v0.0.0dev_1468d8a (2023-12-22)
+                v0.0.0dev_e889eeb (2023-12-22)
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
@@ -61,9 +61,10 @@
 <li class="toctree-l2 current"><a class="current reference internal" href="#">Core API</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="context.html">Context Object</a></li>
 <li class="toctree-l3"><a class="reference internal" href="debuggers.html">Debuggers</a></li>
+<li class="toctree-l3"><a class="reference internal" href="pipelines.html">Pipelines</a></li>
+<li class="toctree-l3"><a class="reference internal" href="primitive_data.html">Primitive Data Objects</a></li>
 <li class="toctree-l3"><a class="reference internal" href="renderers.html">Renderers</a></li>
 <li class="toctree-l3"><a class="reference internal" href="swapchains.html">Swapchains</a></li>
-<li class="toctree-l3"><a class="reference internal" href="primitive_data.html">Primitive Data Objects</a></li>
 <li class="toctree-l3"><a class="reference internal" href="wsi.html">WSI and Window Surfaces</a></li>
 </ul>
 </li>
@@ -105,9 +106,10 @@ <h1>Core API<a class="headerlink" href="#core-api" title="Permalink to this head
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="context.html">Context Object</a></li>
 <li class="toctree-l1"><a class="reference internal" href="debuggers.html">Debuggers</a></li>
+<li class="toctree-l1"><a class="reference internal" href="pipelines.html">Pipelines</a></li>
+<li class="toctree-l1"><a class="reference internal" href="primitive_data.html">Primitive Data Objects</a></li>
 <li class="toctree-l1"><a class="reference internal" href="renderers.html">Renderers</a></li>
 <li class="toctree-l1"><a class="reference internal" href="swapchains.html">Swapchains</a></li>
-<li class="toctree-l1"><a class="reference internal" href="primitive_data.html">Primitive Data Objects</a></li>
 <li class="toctree-l1"><a class="reference internal" href="wsi.html">WSI and Window Surfaces</a></li>
 </ul>
 </div>
@@ -125,7 +127,7 @@ <h1>Core API<a class="headerlink" href="#core-api" title="Permalink to this head
   </div>
 
 
-    v0.0.0dev_1468d8a (2023-12-22) » <a href="https://github.com/kosude/thallium">upstream url</a>
+    v0.0.0dev_e889eeb (2023-12-22) » <a href="https://github.com/kosude/thallium">upstream url</a>
 
 </footer>
         </div>

diff --git a/pages/api/core/context.html b/pages/api/core/context.html
@@ -43,7 +43,7 @@
               <img src="../../../_static/logo_wtext.svg" class="logo" alt="Logo"/>
           </a>
               <div class="version">
-                v0.0.0dev_1468d8a (2023-12-22)
+                v0.0.0dev_e889eeb (2023-12-22)
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
@@ -65,9 +65,10 @@
 </ul>
 </li>
 <li class="toctree-l3"><a class="reference internal" href="debuggers.html">Debuggers</a></li>
+<li class="toctree-l3"><a class="reference internal" href="pipelines.html">Pipelines</a></li>
+<li class="toctree-l3"><a class="reference internal" href="primitive_data.html">Primitive Data Objects</a></li>
 <li class="toctree-l3"><a class="reference internal" href="renderers.html">Renderers</a></li>
 <li class="toctree-l3"><a class="reference internal" href="swapchains.html">Swapchains</a></li>
-<li class="toctree-l3"><a class="reference internal" href="primitive_data.html">Primitive Data Objects</a></li>
 <li class="toctree-l3"><a class="reference internal" href="wsi.html">WSI and Window Surfaces</a></li>
 </ul>
 </li>
@@ -233,7 +234,7 @@ <h2>Functions<a class="headerlink" href="#functions" title="Permalink to this he
   </div>
 
 
-    v0.0.0dev_1468d8a (2023-12-22) » <a href="https://github.com/kosude/thallium">upstream url</a>
+    v0.0.0dev_e889eeb (2023-12-22) » <a href="https://github.com/kosude/thallium">upstream url</a>
 
 </footer>
         </div>

diff --git a/pages/api/core/debuggers.html b/pages/api/core/debuggers.html
@@ -26,7 +26,7 @@
     <script src="../../../_static/js/theme.js"></script>
     <link rel="index" title="Index" href="../../../genindex.html" />
     <link rel="search" title="Search" href="../../../search.html" />
-    <link rel="next" title="Renderers" href="renderers.html" />
+    <link rel="next" title="Pipelines" href="pipelines.html" />
     <link rel="prev" title="Context Object" href="context.html" /> 
 </head>
 
@@ -43,7 +43,7 @@
               <img src="../../../_static/logo_wtext.svg" class="logo" alt="Logo"/>
           </a>
               <div class="version">
-                v0.0.0dev_1468d8a (2023-12-22)
+                v0.0.0dev_e889eeb (2023-12-22)
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
@@ -65,9 +65,10 @@
 <li class="toctree-l4"><a class="reference internal" href="#functions">Functions</a></li>
 </ul>
 </li>
+<li class="toctree-l3"><a class="reference internal" href="pipelines.html">Pipelines</a></li>
+<li class="toctree-l3"><a class="reference internal" href="primitive_data.html">Primitive Data Objects</a></li>
 <li class="toctree-l3"><a class="reference internal" href="renderers.html">Renderers</a></li>
 <li class="toctree-l3"><a class="reference internal" href="swapchains.html">Swapchains</a></li>
-<li class="toctree-l3"><a class="reference internal" href="primitive_data.html">Primitive Data Objects</a></li>
 <li class="toctree-l3"><a class="reference internal" href="wsi.html">WSI and Window Surfaces</a></li>
 </ul>
 </li>
@@ -229,10 +230,6 @@ <h3>Enums<a class="headerlink" href="#enums" title="Permalink to this heading">
 <p class="admonition-title">See also</p>
 <p><a class="reference internal" href="#de/db9/structTL__DebuggerDescriptor__t"><span class="std std-ref">TL_DebuggerDescriptor_t</span></a></p>
 </div>
-<div class="admonition seealso">
-<p class="admonition-title">See also</p>
-<p><a class="reference internal" href="#dc/d72/debugger_8h_1a0c521b646e561d5ffcd88d311c40133c"><span class="std std-ref">TL_DebuggerCreate()</span></a></p>
-</div>
 </p>
 <p><em>Values:</em></p>
 <dl class="c enumerator">
@@ -284,7 +281,7 @@ <h3>Enums<a class="headerlink" href="#enums" title="Permalink to this heading">
 </div>
 <div class="admonition seealso">
 <p class="admonition-title">See also</p>
-<p><a class="reference internal" href="#dc/d72/debugger_8h_1a0c521b646e561d5ffcd88d311c40133c"><span class="std std-ref">TL_DebuggerCreate()</span></a></p>
+<p><a class="reference internal" href="#de/db9/structTL__DebuggerDescriptor__t"><span class="std std-ref">TL_DebuggerDescriptor_t</span></a></p>
 </div>
 </p>
 <p><em>Values:</em></p>
@@ -364,7 +361,7 @@ <h2>Functions<a class="headerlink" href="#functions" title="Permalink to this he
   </div>
 
 
-    v0.0.0dev_1468d8a (2023-12-22) » <a href="https://github.com/kosude/thallium">upstream url</a>
+    v0.0.0dev_e889eeb (2023-12-22) » <a href="https://github.com/kosude/thallium">upstream url</a>
 
 </footer>
         </div>