📚 Documentation update for 0.1.0-preview.190

SceneGate · Sep 29, 2023 · 4f23496 · 4f23496
1 parent f066834
commit 4f23496
Show file tree

Hide file tree

Showing 4 changed files with 34 additions and 24 deletions.
diff --git a/api/Texim.Sprites.PixelSequenceFinder.html b/api/Texim.Sprites.PixelSequenceFinder.html
@@ -460,12 +460,12 @@ <h3 id="methods">Methods
 
 
   <a id="Texim_Sprites_PixelSequenceFinder_Search_" data-uid="Texim.Sprites.PixelSequenceFinder.Search*"></a>
-  <h4 id="Texim_Sprites_PixelSequenceFinder_Search_System_ReadOnlySpan_Texim_Pixels_IndexedPixel__System_ReadOnlySpan_Texim_Pixels_IndexedPixel__System_Int32_" data-uid="Texim.Sprites.PixelSequenceFinder.Search(System.ReadOnlySpan{Texim.Pixels.IndexedPixel},System.ReadOnlySpan{Texim.Pixels.IndexedPixel},System.Int32)">Search(ReadOnlySpan&lt;IndexedPixel&gt;, ReadOnlySpan&lt;IndexedPixel&gt;, Int32)</h4>
+  <h4 id="Texim_Sprites_PixelSequenceFinder_Search_System_ReadOnlySpan_Texim_Pixels_IndexedPixel__System_ReadOnlySpan_Texim_Pixels_IndexedPixel__System_Int32_Texim_Palettes_IPalette_" data-uid="Texim.Sprites.PixelSequenceFinder.Search(System.ReadOnlySpan{Texim.Pixels.IndexedPixel},System.ReadOnlySpan{Texim.Pixels.IndexedPixel},System.Int32,Texim.Palettes.IPalette)">Search(ReadOnlySpan&lt;IndexedPixel&gt;, ReadOnlySpan&lt;IndexedPixel&gt;, Int32, IPalette)</h4>
   <div class="markdown level1 summary"></div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
   <div class="codewrapper">
-    <pre><code class="lang-csharp hljs">public static int Search(ReadOnlySpan&lt;IndexedPixel&gt; pixels, ReadOnlySpan&lt;IndexedPixel&gt; sequence, int blockSize)</code></pre>
+    <pre><code class="lang-csharp hljs">public static int Search(ReadOnlySpan&lt;IndexedPixel&gt; pixels, ReadOnlySpan&lt;IndexedPixel&gt; sequence, int blockSize, IPalette palette = null)</code></pre>
   </div>
   <h5 class="parameters">Parameters</h5>
   <table class="table table-bordered table-striped table-condensed">
@@ -492,6 +492,11 @@ <h5 class="parameters">Parameters</h5>
         <td><span class="parametername">blockSize</span></td>
         <td></td>
       </tr>
+      <tr>
+        <td><a class="xref" href="Texim.Palettes.IPalette.html">IPalette</a></td>
+        <td><span class="parametername">palette</span></td>
+        <td></td>
+      </tr>
     </tbody>
   </table>
   <h5 class="returns">Returns</h5>
@@ -512,12 +517,12 @@ <h5 class="returns">Returns</h5>
 
 
   <a id="Texim_Sprites_PixelSequenceFinder_SearchFlipping_" data-uid="Texim.Sprites.PixelSequenceFinder.SearchFlipping*"></a>
-  <h4 id="Texim_Sprites_PixelSequenceFinder_SearchFlipping_System_ReadOnlySpan_Texim_Pixels_IndexedPixel__System_ReadOnlySpan_Texim_Pixels_IndexedPixel__System_Int32_System_Drawing_Size_" data-uid="Texim.Sprites.PixelSequenceFinder.SearchFlipping(System.ReadOnlySpan{Texim.Pixels.IndexedPixel},System.ReadOnlySpan{Texim.Pixels.IndexedPixel},System.Int32,System.Drawing.Size)">SearchFlipping(ReadOnlySpan&lt;IndexedPixel&gt;, ReadOnlySpan&lt;IndexedPixel&gt;, Int32, Size)</h4>
+  <h4 id="Texim_Sprites_PixelSequenceFinder_SearchFlipping_System_ReadOnlySpan_Texim_Pixels_IndexedPixel__System_ReadOnlySpan_Texim_Pixels_IndexedPixel__System_Int32_System_Drawing_Size_Texim_Palettes_IPalette_" data-uid="Texim.Sprites.PixelSequenceFinder.SearchFlipping(System.ReadOnlySpan{Texim.Pixels.IndexedPixel},System.ReadOnlySpan{Texim.Pixels.IndexedPixel},System.Int32,System.Drawing.Size,Texim.Palettes.IPalette)">SearchFlipping(ReadOnlySpan&lt;IndexedPixel&gt;, ReadOnlySpan&lt;IndexedPixel&gt;, Int32, Size, IPalette)</h4>
   <div class="markdown level1 summary"></div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
   <div class="codewrapper">
-    <pre><code class="lang-csharp hljs">public static (int, bool, bool) SearchFlipping(ReadOnlySpan&lt;IndexedPixel&gt; pixels, ReadOnlySpan&lt;IndexedPixel&gt; sequence, int blockSize, Size sequenceSize)</code></pre>
+    <pre><code class="lang-csharp hljs">public static (int, bool, bool) SearchFlipping(ReadOnlySpan&lt;IndexedPixel&gt; pixels, ReadOnlySpan&lt;IndexedPixel&gt; sequence, int blockSize, Size sequenceSize, IPalette palette = null)</code></pre>
   </div>
   <h5 class="parameters">Parameters</h5>
   <table class="table table-bordered table-striped table-condensed">
@@ -549,6 +554,11 @@ <h5 class="parameters">Parameters</h5>
         <td><span class="parametername">sequenceSize</span></td>
         <td></td>
       </tr>
+      <tr>
+        <td><a class="xref" href="Texim.Palettes.IPalette.html">IPalette</a></td>
+        <td><span class="parametername">palette</span></td>
+        <td></td>
+      </tr>
     </tbody>
   </table>
   <h5 class="returns">Returns</h5>

diff --git a/index.json b/index.json
@@ -457,7 +457,7 @@
   "api/Texim.Sprites.PixelSequenceFinder.html": {
     "href": "api/Texim.Sprites.PixelSequenceFinder.html",
     "title": "Class PixelSequenceFinder | Texim extensible image API",
-    "keywords": "Class PixelSequenceFinder Inheritance Object PixelSequenceFinder Namespace : Texim.Sprites Assembly : Texim.dll Syntax public static class PixelSequenceFinder : Object Methods Search(ReadOnlySpan<IndexedPixel>, ReadOnlySpan<IndexedPixel>, Int32) Declaration public static int Search(ReadOnlySpan<IndexedPixel> pixels, ReadOnlySpan<IndexedPixel> sequence, int blockSize) Parameters Type Name Description ReadOnlySpan < IndexedPixel > pixels ReadOnlySpan < IndexedPixel > sequence Int32 blockSize Returns Type Description Int32 SearchFlipping(ReadOnlySpan<IndexedPixel>, ReadOnlySpan<IndexedPixel>, Int32, Size) Declaration public static (int, bool, bool) SearchFlipping(ReadOnlySpan<IndexedPixel> pixels, ReadOnlySpan<IndexedPixel> sequence, int blockSize, Size sequenceSize) Parameters Type Name Description ReadOnlySpan < IndexedPixel > pixels ReadOnlySpan < IndexedPixel > sequence Int32 blockSize Size sequenceSize Returns Type Description (, , ) < Int32 , Boolean , Boolean >"
+    "keywords": "Class PixelSequenceFinder Inheritance Object PixelSequenceFinder Namespace : Texim.Sprites Assembly : Texim.dll Syntax public static class PixelSequenceFinder : Object Methods Search(ReadOnlySpan<IndexedPixel>, ReadOnlySpan<IndexedPixel>, Int32, IPalette) Declaration public static int Search(ReadOnlySpan<IndexedPixel> pixels, ReadOnlySpan<IndexedPixel> sequence, int blockSize, IPalette palette = null) Parameters Type Name Description ReadOnlySpan < IndexedPixel > pixels ReadOnlySpan < IndexedPixel > sequence Int32 blockSize IPalette palette Returns Type Description Int32 SearchFlipping(ReadOnlySpan<IndexedPixel>, ReadOnlySpan<IndexedPixel>, Int32, Size, IPalette) Declaration public static (int, bool, bool) SearchFlipping(ReadOnlySpan<IndexedPixel> pixels, ReadOnlySpan<IndexedPixel> sequence, int blockSize, Size sequenceSize, IPalette palette = null) Parameters Type Name Description ReadOnlySpan < IndexedPixel > pixels ReadOnlySpan < IndexedPixel > sequence Int32 blockSize Size sequenceSize IPalette palette Returns Type Description (, , ) < Int32 , Boolean , Boolean >"
   },
   "api/Texim.Sprites.Sprite.html": {
     "href": "api/Texim.Sprites.Sprite.html",

diff --git a/manifest.json b/manifest.json
@@ -1122,7 +1122,7 @@
       "output": {
         ".html": {
           "relative_path": "api/Texim.Sprites.PixelSequenceFinder.html",
-          "hash": "4xBCzHOL3/Ot50KVafQIjCZFP/FG1AnKwVD47QEkPQI="
+          "hash": "HLpE4u3MWLDoOYSnWkjMT08q1NDLxq/08h86UTyHzT8="
         }
       },
       "is_incremental": false,

diff --git a/xrefmap.yml b/xrefmap.yml
@@ -4816,30 +4816,30 @@ references:
   commentId: T:Texim.Sprites.PixelSequenceFinder
   fullName: Texim.Sprites.PixelSequenceFinder
   nameWithType: PixelSequenceFinder
-- uid: Texim.Sprites.PixelSequenceFinder.Search(System.ReadOnlySpan{Texim.Pixels.IndexedPixel},System.ReadOnlySpan{Texim.Pixels.IndexedPixel},System.Int32)
-  name: Search(ReadOnlySpan<IndexedPixel>, ReadOnlySpan<IndexedPixel>, Int32)
-  href: api/Texim.Sprites.PixelSequenceFinder.html#Texim_Sprites_PixelSequenceFinder_Search_System_ReadOnlySpan_Texim_Pixels_IndexedPixel__System_ReadOnlySpan_Texim_Pixels_IndexedPixel__System_Int32_
-  commentId: M:Texim.Sprites.PixelSequenceFinder.Search(System.ReadOnlySpan{Texim.Pixels.IndexedPixel},System.ReadOnlySpan{Texim.Pixels.IndexedPixel},System.Int32)
-  name.vb: Search(ReadOnlySpan(Of IndexedPixel), ReadOnlySpan(Of IndexedPixel), Int32)
-  fullName: Texim.Sprites.PixelSequenceFinder.Search(System.ReadOnlySpan<Texim.Pixels.IndexedPixel>, System.ReadOnlySpan<Texim.Pixels.IndexedPixel>, System.Int32)
-  fullName.vb: Texim.Sprites.PixelSequenceFinder.Search(System.ReadOnlySpan(Of Texim.Pixels.IndexedPixel), System.ReadOnlySpan(Of Texim.Pixels.IndexedPixel), System.Int32)
-  nameWithType: PixelSequenceFinder.Search(ReadOnlySpan<IndexedPixel>, ReadOnlySpan<IndexedPixel>, Int32)
-  nameWithType.vb: PixelSequenceFinder.Search(ReadOnlySpan(Of IndexedPixel), ReadOnlySpan(Of IndexedPixel), Int32)
+- uid: Texim.Sprites.PixelSequenceFinder.Search(System.ReadOnlySpan{Texim.Pixels.IndexedPixel},System.ReadOnlySpan{Texim.Pixels.IndexedPixel},System.Int32,Texim.Palettes.IPalette)
+  name: Search(ReadOnlySpan<IndexedPixel>, ReadOnlySpan<IndexedPixel>, Int32, IPalette)
+  href: api/Texim.Sprites.PixelSequenceFinder.html#Texim_Sprites_PixelSequenceFinder_Search_System_ReadOnlySpan_Texim_Pixels_IndexedPixel__System_ReadOnlySpan_Texim_Pixels_IndexedPixel__System_Int32_Texim_Palettes_IPalette_
+  commentId: M:Texim.Sprites.PixelSequenceFinder.Search(System.ReadOnlySpan{Texim.Pixels.IndexedPixel},System.ReadOnlySpan{Texim.Pixels.IndexedPixel},System.Int32,Texim.Palettes.IPalette)
+  name.vb: Search(ReadOnlySpan(Of IndexedPixel), ReadOnlySpan(Of IndexedPixel), Int32, IPalette)
+  fullName: Texim.Sprites.PixelSequenceFinder.Search(System.ReadOnlySpan<Texim.Pixels.IndexedPixel>, System.ReadOnlySpan<Texim.Pixels.IndexedPixel>, System.Int32, Texim.Palettes.IPalette)
+  fullName.vb: Texim.Sprites.PixelSequenceFinder.Search(System.ReadOnlySpan(Of Texim.Pixels.IndexedPixel), System.ReadOnlySpan(Of Texim.Pixels.IndexedPixel), System.Int32, Texim.Palettes.IPalette)
+  nameWithType: PixelSequenceFinder.Search(ReadOnlySpan<IndexedPixel>, ReadOnlySpan<IndexedPixel>, Int32, IPalette)
+  nameWithType.vb: PixelSequenceFinder.Search(ReadOnlySpan(Of IndexedPixel), ReadOnlySpan(Of IndexedPixel), Int32, IPalette)
 - uid: Texim.Sprites.PixelSequenceFinder.Search*
   name: Search
   href: api/Texim.Sprites.PixelSequenceFinder.html#Texim_Sprites_PixelSequenceFinder_Search_
   commentId: Overload:Texim.Sprites.PixelSequenceFinder.Search
   fullName: Texim.Sprites.PixelSequenceFinder.Search
   nameWithType: PixelSequenceFinder.Search
-- uid: Texim.Sprites.PixelSequenceFinder.SearchFlipping(System.ReadOnlySpan{Texim.Pixels.IndexedPixel},System.ReadOnlySpan{Texim.Pixels.IndexedPixel},System.Int32,System.Drawing.Size)
-  name: SearchFlipping(ReadOnlySpan<IndexedPixel>, ReadOnlySpan<IndexedPixel>, Int32, Size)
-  href: api/Texim.Sprites.PixelSequenceFinder.html#Texim_Sprites_PixelSequenceFinder_SearchFlipping_System_ReadOnlySpan_Texim_Pixels_IndexedPixel__System_ReadOnlySpan_Texim_Pixels_IndexedPixel__System_Int32_System_Drawing_Size_
-  commentId: M:Texim.Sprites.PixelSequenceFinder.SearchFlipping(System.ReadOnlySpan{Texim.Pixels.IndexedPixel},System.ReadOnlySpan{Texim.Pixels.IndexedPixel},System.Int32,System.Drawing.Size)
-  name.vb: SearchFlipping(ReadOnlySpan(Of IndexedPixel), ReadOnlySpan(Of IndexedPixel), Int32, Size)
-  fullName: Texim.Sprites.PixelSequenceFinder.SearchFlipping(System.ReadOnlySpan<Texim.Pixels.IndexedPixel>, System.ReadOnlySpan<Texim.Pixels.IndexedPixel>, System.Int32, System.Drawing.Size)
-  fullName.vb: Texim.Sprites.PixelSequenceFinder.SearchFlipping(System.ReadOnlySpan(Of Texim.Pixels.IndexedPixel), System.ReadOnlySpan(Of Texim.Pixels.IndexedPixel), System.Int32, System.Drawing.Size)
-  nameWithType: PixelSequenceFinder.SearchFlipping(ReadOnlySpan<IndexedPixel>, ReadOnlySpan<IndexedPixel>, Int32, Size)
-  nameWithType.vb: PixelSequenceFinder.SearchFlipping(ReadOnlySpan(Of IndexedPixel), ReadOnlySpan(Of IndexedPixel), Int32, Size)
+- uid: Texim.Sprites.PixelSequenceFinder.SearchFlipping(System.ReadOnlySpan{Texim.Pixels.IndexedPixel},System.ReadOnlySpan{Texim.Pixels.IndexedPixel},System.Int32,System.Drawing.Size,Texim.Palettes.IPalette)
+  name: SearchFlipping(ReadOnlySpan<IndexedPixel>, ReadOnlySpan<IndexedPixel>, Int32, Size, IPalette)
+  href: api/Texim.Sprites.PixelSequenceFinder.html#Texim_Sprites_PixelSequenceFinder_SearchFlipping_System_ReadOnlySpan_Texim_Pixels_IndexedPixel__System_ReadOnlySpan_Texim_Pixels_IndexedPixel__System_Int32_System_Drawing_Size_Texim_Palettes_IPalette_
+  commentId: M:Texim.Sprites.PixelSequenceFinder.SearchFlipping(System.ReadOnlySpan{Texim.Pixels.IndexedPixel},System.ReadOnlySpan{Texim.Pixels.IndexedPixel},System.Int32,System.Drawing.Size,Texim.Palettes.IPalette)
+  name.vb: SearchFlipping(ReadOnlySpan(Of IndexedPixel), ReadOnlySpan(Of IndexedPixel), Int32, Size, IPalette)
+  fullName: Texim.Sprites.PixelSequenceFinder.SearchFlipping(System.ReadOnlySpan<Texim.Pixels.IndexedPixel>, System.ReadOnlySpan<Texim.Pixels.IndexedPixel>, System.Int32, System.Drawing.Size, Texim.Palettes.IPalette)
+  fullName.vb: Texim.Sprites.PixelSequenceFinder.SearchFlipping(System.ReadOnlySpan(Of Texim.Pixels.IndexedPixel), System.ReadOnlySpan(Of Texim.Pixels.IndexedPixel), System.Int32, System.Drawing.Size, Texim.Palettes.IPalette)
+  nameWithType: PixelSequenceFinder.SearchFlipping(ReadOnlySpan<IndexedPixel>, ReadOnlySpan<IndexedPixel>, Int32, Size, IPalette)
+  nameWithType.vb: PixelSequenceFinder.SearchFlipping(ReadOnlySpan(Of IndexedPixel), ReadOnlySpan(Of IndexedPixel), Int32, Size, IPalette)
 - uid: Texim.Sprites.PixelSequenceFinder.SearchFlipping*
   name: SearchFlipping
   href: api/Texim.Sprites.PixelSequenceFinder.html#Texim_Sprites_PixelSequenceFinder_SearchFlipping_