Updated manual.

arklumpus · Dec 25, 2024 · 08df5ad · 08df5ad
1 parent f952fb6
commit 08df5ad
Show file tree

Hide file tree

Showing 472 changed files with 30,326 additions and 7,417 deletions.
diff --git a/Doxyfile b/Doxyfile
@@ -38,7 +38,7 @@ PROJECT_NAME           = MuPDFCore
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = 1.8.0
+PROJECT_NUMBER         = 2.0.0
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a

diff --git a/Readme.md b/Readme.md
diff --git a/docs/MuPDFCore.pdf b/docs/MuPDFCore.pdf
diff --git a/docs/_mu_p_d_f_8cs_source.html b/docs/_mu_p_d_f_8cs_source.html
diff --git a/docs/_mu_p_d_f_color_space_8cs_source.html b/docs/_mu_p_d_f_color_space_8cs_source.html
diff --git a/docs/_mu_p_d_f_context_8cs_source.html b/docs/_mu_p_d_f_context_8cs_source.html
diff --git a/docs/_mu_p_d_f_display_list_8cs_source.html b/docs/_mu_p_d_f_display_list_8cs_source.html
@@ -27,7 +27,7 @@
  <tr id="projectrow">
   <td id="projectlogo"><img alt="Logo" src="icon.svg"/></td>
   <td id="projectalign">
-   <div id="projectname">MuPDFCore<span id="projectnumber">&#160;1.8.0</span>
+   <div id="projectname">MuPDFCore<span id="projectnumber">&#160;2.0.0</span>
    </div>
    <div id="projectbrief">Multiplatform .NET bindings for MuPDF</div>
   </td>
@@ -189,8 +189,8 @@
 <div class="line"><a id="l00092" name="l00092"></a><span class="lineno">   92</span>        }</div>
 <div class="line"><a id="l00093" name="l00093"></a><span class="lineno">   93</span>    }</div>
 <div class="line"><a id="l00094" name="l00094"></a><span class="lineno">   94</span>}</div>
-<div class="ttc" id="anamespace_mu_p_d_f_core_html"><div class="ttname"><a href="namespace_mu_p_d_f_core.html">MuPDFCore</a></div><div class="ttdef"><b>Definition:</b> <a href="_mu_p_d_f_8cs_source.html#l00026">MuPDF.cs:27</a></div></div>
-<div class="ttc" id="anamespace_mu_p_d_f_core_html_aa6919d62a772f0334777d47f9c2d6c59"><div class="ttname"><a href="namespace_mu_p_d_f_core.html#aa6919d62a772f0334777d47f9c2d6c59">MuPDFCore.ExitCodes</a></div><div class="ttdeci">ExitCodes</div><div class="ttdoc">Exit codes returned by native methods describing various errors that can occur.</div><div class="ttdef"><b>Definition:</b> <a href="_mu_p_d_f_8cs_source.html#l00031">MuPDF.cs:32</a></div></div>
+<div class="ttc" id="anamespace_mu_p_d_f_core_html"><div class="ttname"><a href="namespace_mu_p_d_f_core.html">MuPDFCore</a></div><div class="ttdef"><b>Definition:</b> <a href="_mu_p_d_f_8cs_source.html#l00027">MuPDF.cs:28</a></div></div>
+<div class="ttc" id="anamespace_mu_p_d_f_core_html_aa6919d62a772f0334777d47f9c2d6c59"><div class="ttname"><a href="namespace_mu_p_d_f_core.html#aa6919d62a772f0334777d47f9c2d6c59">MuPDFCore.ExitCodes</a></div><div class="ttdeci">ExitCodes</div><div class="ttdoc">Exit codes returned by native methods describing various errors that can occur.</div><div class="ttdef"><b>Definition:</b> <a href="_mu_p_d_f_8cs_source.html#l00032">MuPDF.cs:33</a></div></div>
 </div><!-- fragment --></div><!-- contents -->
 </div><!-- doc-content -->
 <!-- start footer part -->

diff --git a/docs/_mu_p_d_f_document_8_create_8cs_source.html b/docs/_mu_p_d_f_document_8_create_8cs_source.html
diff --git a/docs/_mu_p_d_f_document_8cs_source.html b/docs/_mu_p_d_f_document_8cs_source.html
diff --git a/docs/_mu_p_d_f_font_8cs_source.html b/docs/_mu_p_d_f_font_8cs_source.html
diff --git a/docs/_mu_p_d_f_image_8cs_source.html b/docs/_mu_p_d_f_image_8cs_source.html
diff --git a/docs/_mu_p_d_f_links_8cs_source.html b/docs/_mu_p_d_f_links_8cs_source.html
diff --git a/docs/_mu_p_d_f_multi_threaded_page_renderer_8cs_source.html b/docs/_mu_p_d_f_multi_threaded_page_renderer_8cs_source.html
@@ -27,7 +27,7 @@
  <tr id="projectrow">
   <td id="projectlogo"><img alt="Logo" src="icon.svg"/></td>
   <td id="projectalign">
-   <div id="projectname">MuPDFCore<span id="projectnumber">&#160;1.8.0</span>
+   <div id="projectname">MuPDFCore<span id="projectnumber">&#160;2.0.0</span>
    </div>
    <div id="projectbrief">Multiplatform .NET bindings for MuPDF</div>
   </td>
@@ -459,7 +459,7 @@
 <div class="line"><a id="l00362" name="l00362"></a><span class="lineno">  362</span>                RenderingThreads = <span class="keyword">new</span> RenderingThread[threadCount];</div>
 <div class="line"><a id="l00363" name="l00363"></a><span class="lineno">  363</span>                <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i &lt; threadCount; i++)</div>
 <div class="line"><a id="l00364" name="l00364"></a><span class="lineno">  364</span>                {</div>
-<div class="line"><a id="l00365" name="l00365"></a><span class="lineno">  365</span>                    Contexts[i] = <span class="keyword">new</span> MuPDFContext(contexts[i]);</div>
+<div class="line"><a id="l00365" name="l00365"></a><span class="lineno">  365</span>                    Contexts[i] = <span class="keyword">new</span> MuPDFContext(context, contexts[i]);</div>
 <div class="line"><a id="l00366" name="l00366"></a><span class="lineno">  366</span>                    RenderingThreads[i] = <span class="keyword">new</span> RenderingThread();</div>
 <div class="line"><a id="l00367" name="l00367"></a><span class="lineno">  367</span>                }</div>
 <div class="line"><a id="l00368" name="l00368"></a><span class="lineno">  368</span>            }</div>
@@ -693,21 +693,21 @@
 <div class="line"><a id="l00596" name="l00596"></a><span class="lineno">  596</span>        }</div>
 <div class="line"><a id="l00597" name="l00597"></a><span class="lineno">  597</span>    }</div>
 <div class="line"><a id="l00598" name="l00598"></a><span class="lineno">  598</span>}</div>
-<div class="ttc" id="aclass_mu_p_d_f_core_1_1_disposable_int_ptr_html"><div class="ttname"><a href="class_mu_p_d_f_core_1_1_disposable_int_ptr.html">MuPDFCore.DisposableIntPtr</a></div><div class="ttdoc">An IDisposable wrapper around an IntPtr that frees the allocated memory when it is disposed.</div><div class="ttdef"><b>Definition:</b> <a href="_mu_p_d_f_8cs_source.html#l00421">MuPDF.cs:422</a></div></div>
-<div class="ttc" id="aclass_mu_p_d_f_core_1_1_mu_p_d_f_context_html"><div class="ttname"><a href="class_mu_p_d_f_core_1_1_mu_p_d_f_context.html">MuPDFCore.MuPDFContext</a></div><div class="ttdoc">A wrapper around a MuPDF context object, which contains the exception stack and the resource cache st...</div><div class="ttdef"><b>Definition:</b> <a href="_mu_p_d_f_context_8cs_source.html#l00025">MuPDFContext.cs:26</a></div></div>
-<div class="ttc" id="aclass_mu_p_d_f_core_1_1_mu_p_d_f_exception_html"><div class="ttname"><a href="class_mu_p_d_f_core_1_1_mu_p_d_f_exception.html">MuPDFCore.MuPDFException</a></div><div class="ttdoc">The exception that is thrown when a MuPDF operation fails.</div><div class="ttdef"><b>Definition:</b> <a href="_mu_p_d_f_8cs_source.html#l00493">MuPDF.cs:494</a></div></div>
+<div class="ttc" id="aclass_mu_p_d_f_core_1_1_disposable_int_ptr_html"><div class="ttname"><a href="class_mu_p_d_f_core_1_1_disposable_int_ptr.html">MuPDFCore.DisposableIntPtr</a></div><div class="ttdoc">An IDisposable wrapper around an IntPtr that frees the allocated memory when it is disposed.</div><div class="ttdef"><b>Definition:</b> <a href="_mu_p_d_f_8cs_source.html#l00523">MuPDF.cs:524</a></div></div>
+<div class="ttc" id="aclass_mu_p_d_f_core_1_1_mu_p_d_f_context_html"><div class="ttname"><a href="class_mu_p_d_f_core_1_1_mu_p_d_f_context.html">MuPDFCore.MuPDFContext</a></div><div class="ttdoc">A wrapper around a MuPDF context object, which contains the exception stack and the resource cache st...</div><div class="ttdef"><b>Definition:</b> <a href="_mu_p_d_f_context_8cs_source.html#l00026">MuPDFContext.cs:27</a></div></div>
+<div class="ttc" id="aclass_mu_p_d_f_core_1_1_mu_p_d_f_exception_html"><div class="ttname"><a href="class_mu_p_d_f_core_1_1_mu_p_d_f_exception.html">MuPDFCore.MuPDFException</a></div><div class="ttdoc">The exception that is thrown when a MuPDF operation fails.</div><div class="ttdef"><b>Definition:</b> <a href="_mu_p_d_f_8cs_source.html#l00595">MuPDF.cs:596</a></div></div>
 <div class="ttc" id="aclass_mu_p_d_f_core_1_1_mu_p_d_f_multi_threaded_page_renderer_html"><div class="ttname"><a href="class_mu_p_d_f_core_1_1_mu_p_d_f_multi_threaded_page_renderer.html">MuPDFCore.MuPDFMultiThreadedPageRenderer</a></div><div class="ttdoc">A class that holds the necessary resources to render a page of a MuPDF document using multiple thread...</div><div class="ttdef"><b>Definition:</b> <a href="_mu_p_d_f_multi_threaded_page_renderer_8cs_source.html#l00276">MuPDFMultiThreadedPageRenderer.cs:277</a></div></div>
 <div class="ttc" id="aclass_mu_p_d_f_core_1_1_mu_p_d_f_multi_threaded_page_renderer_html_a05eca723202ae5ca1b535b8fe32ef405"><div class="ttname"><a href="class_mu_p_d_f_core_1_1_mu_p_d_f_multi_threaded_page_renderer.html#a05eca723202ae5ca1b535b8fe32ef405">MuPDFCore.MuPDFMultiThreadedPageRenderer.Abort</a></div><div class="ttdeci">void Abort()</div><div class="ttdoc">Signal to the rendering threads that they should abort rendering as soon as possible.</div><div class="ttdef"><b>Definition:</b> <a href="_mu_p_d_f_multi_threaded_page_renderer_8cs_source.html#l00543">MuPDFMultiThreadedPageRenderer.cs:543</a></div></div>
 <div class="ttc" id="aclass_mu_p_d_f_core_1_1_mu_p_d_f_multi_threaded_page_renderer_html_a9f2e30c872e3b409af2333aede3503f7"><div class="ttname"><a href="class_mu_p_d_f_core_1_1_mu_p_d_f_multi_threaded_page_renderer.html#a9f2e30c872e3b409af2333aede3503f7">MuPDFCore.MuPDFMultiThreadedPageRenderer.ThreadCount</a></div><div class="ttdeci">int ThreadCount</div><div class="ttdoc">The number of threads that are used to render the image.</div><div class="ttdef"><b>Definition:</b> <a href="_mu_p_d_f_multi_threaded_page_renderer_8cs_source.html#l00306">MuPDFMultiThreadedPageRenderer.cs:306</a></div></div>
 <div class="ttc" id="aclass_mu_p_d_f_core_1_1_mu_p_d_f_multi_threaded_page_renderer_html_ab3967195e249f10b89eadaeed551a409"><div class="ttname"><a href="class_mu_p_d_f_core_1_1_mu_p_d_f_multi_threaded_page_renderer.html#ab3967195e249f10b89eadaeed551a409">MuPDFCore.MuPDFMultiThreadedPageRenderer.GetProgress</a></div><div class="ttdeci">RenderProgress GetProgress()</div><div class="ttdoc">Get the current rendering progress of all the threads.</div><div class="ttdef"><b>Definition:</b> <a href="_mu_p_d_f_multi_threaded_page_renderer_8cs_source.html#l00555">MuPDFMultiThreadedPageRenderer.cs:555</a></div></div>
 <div class="ttc" id="aclass_mu_p_d_f_core_1_1_mu_p_d_f_multi_threaded_page_renderer_html_ae618aac7a0b15dd131d4f6637007b4f3"><div class="ttname"><a href="class_mu_p_d_f_core_1_1_mu_p_d_f_multi_threaded_page_renderer.html#ae618aac7a0b15dd131d4f6637007b4f3">MuPDFCore.MuPDFMultiThreadedPageRenderer.Render</a></div><div class="ttdeci">GetSpanItem Render(RoundedSize targetSize, Rectangle region, out IDisposable[] disposables, PixelFormats pixelFormat)</div><div class="ttdoc">Render the specified region to an image of the specified size, split in a number of tiles equal to th...</div><div class="ttdef"><b>Definition:</b> <a href="_mu_p_d_f_multi_threaded_page_renderer_8cs_source.html#l00509">MuPDFMultiThreadedPageRenderer.cs:509</a></div></div>
 <div class="ttc" id="aclass_mu_p_d_f_core_1_1_mu_p_d_f_multi_threaded_page_renderer_html_aeb76562e49532298efc7964aa87283e2"><div class="ttname"><a href="class_mu_p_d_f_core_1_1_mu_p_d_f_multi_threaded_page_renderer.html#aeb76562e49532298efc7964aa87283e2">MuPDFCore.MuPDFMultiThreadedPageRenderer.GetSpanItem</a></div><div class="ttdeci">delegate Span&lt; byte &gt; GetSpanItem(int index)</div><div class="ttdoc">Gets an element from a collection of Span&lt;byte&gt;</div></div>
 <div class="ttc" id="aclass_mu_p_d_f_core_1_1_mu_p_d_f_multi_threaded_page_renderer_html_afb748f194d7f6983f68c475b53943da5"><div class="ttname"><a href="class_mu_p_d_f_core_1_1_mu_p_d_f_multi_threaded_page_renderer.html#afb748f194d7f6983f68c475b53943da5">MuPDFCore.MuPDFMultiThreadedPageRenderer.Render</a></div><div class="ttdeci">void Render(RoundedSize targetSize, Rectangle region, IntPtr[] destinations, PixelFormats pixelFormat)</div><div class="ttdoc">Render the specified region to an image of the specified size, split in a number of tiles equal to th...</div><div class="ttdef"><b>Definition:</b> <a href="_mu_p_d_f_multi_threaded_page_renderer_8cs_source.html#l00383">MuPDFMultiThreadedPageRenderer.cs:383</a></div></div>
-<div class="ttc" id="aclass_mu_p_d_f_core_1_1_render_progress_html"><div class="ttname"><a href="class_mu_p_d_f_core_1_1_render_progress.html">MuPDFCore.RenderProgress</a></div><div class="ttdoc">Holds a summary of the progress of the current rendering operation.</div><div class="ttdef"><b>Definition:</b> <a href="_mu_p_d_f_8cs_source.html#l00383">MuPDF.cs:384</a></div></div>
-<div class="ttc" id="anamespace_mu_p_d_f_core_html"><div class="ttname"><a href="namespace_mu_p_d_f_core.html">MuPDFCore</a></div><div class="ttdef"><b>Definition:</b> <a href="_mu_p_d_f_8cs_source.html#l00026">MuPDF.cs:27</a></div></div>
-<div class="ttc" id="anamespace_mu_p_d_f_core_html_aa6919d62a772f0334777d47f9c2d6c59"><div class="ttname"><a href="namespace_mu_p_d_f_core.html#aa6919d62a772f0334777d47f9c2d6c59">MuPDFCore.ExitCodes</a></div><div class="ttdeci">ExitCodes</div><div class="ttdoc">Exit codes returned by native methods describing various errors that can occur.</div><div class="ttdef"><b>Definition:</b> <a href="_mu_p_d_f_8cs_source.html#l00031">MuPDF.cs:32</a></div></div>
-<div class="ttc" id="anamespace_mu_p_d_f_core_html_ade1eb4d4f9c9c8a66bde9152ea9e41bb"><div class="ttname"><a href="namespace_mu_p_d_f_core.html#ade1eb4d4f9c9c8a66bde9152ea9e41bb">MuPDFCore.PixelFormats</a></div><div class="ttdeci">PixelFormats</div><div class="ttdoc">Pixel formats supported by the library.</div><div class="ttdef"><b>Definition:</b> <a href="_mu_p_d_f_8cs_source.html#l00250">MuPDF.cs:251</a></div></div>
-<div class="ttc" id="astruct_mu_p_d_f_core_1_1_cookie_html"><div class="ttname"><a href="struct_mu_p_d_f_core_1_1_cookie.html">MuPDFCore.Cookie</a></div><div class="ttdef"><b>Definition:</b> <a href="_mu_p_d_f_8cs_source.html#l00371">MuPDF.cs:372</a></div></div>
+<div class="ttc" id="aclass_mu_p_d_f_core_1_1_render_progress_html"><div class="ttname"><a href="class_mu_p_d_f_core_1_1_render_progress.html">MuPDFCore.RenderProgress</a></div><div class="ttdoc">Holds a summary of the progress of the current rendering operation.</div><div class="ttdef"><b>Definition:</b> <a href="_mu_p_d_f_8cs_source.html#l00485">MuPDF.cs:486</a></div></div>
+<div class="ttc" id="anamespace_mu_p_d_f_core_html"><div class="ttname"><a href="namespace_mu_p_d_f_core.html">MuPDFCore</a></div><div class="ttdef"><b>Definition:</b> <a href="_mu_p_d_f_8cs_source.html#l00027">MuPDF.cs:28</a></div></div>
+<div class="ttc" id="anamespace_mu_p_d_f_core_html_aa6919d62a772f0334777d47f9c2d6c59"><div class="ttname"><a href="namespace_mu_p_d_f_core.html#aa6919d62a772f0334777d47f9c2d6c59">MuPDFCore.ExitCodes</a></div><div class="ttdeci">ExitCodes</div><div class="ttdoc">Exit codes returned by native methods describing various errors that can occur.</div><div class="ttdef"><b>Definition:</b> <a href="_mu_p_d_f_8cs_source.html#l00032">MuPDF.cs:33</a></div></div>
+<div class="ttc" id="anamespace_mu_p_d_f_core_html_ade1eb4d4f9c9c8a66bde9152ea9e41bb"><div class="ttname"><a href="namespace_mu_p_d_f_core.html#ade1eb4d4f9c9c8a66bde9152ea9e41bb">MuPDFCore.PixelFormats</a></div><div class="ttdeci">PixelFormats</div><div class="ttdoc">Pixel formats supported by the library.</div><div class="ttdef"><b>Definition:</b> <a href="_mu_p_d_f_8cs_source.html#l00316">MuPDF.cs:317</a></div></div>
+<div class="ttc" id="astruct_mu_p_d_f_core_1_1_cookie_html"><div class="ttname"><a href="struct_mu_p_d_f_core_1_1_cookie.html">MuPDFCore.Cookie</a></div><div class="ttdef"><b>Definition:</b> <a href="_mu_p_d_f_8cs_source.html#l00473">MuPDF.cs:474</a></div></div>
 <div class="ttc" id="astruct_mu_p_d_f_core_1_1_rectangle_html"><div class="ttname"><a href="struct_mu_p_d_f_core_1_1_rectangle.html">MuPDFCore.Rectangle</a></div><div class="ttdoc">Represents a rectangle.</div><div class="ttdef"><b>Definition:</b> <a href="_rectangles_8cs_source.html#l00326">Rectangles.cs:327</a></div></div>
 <div class="ttc" id="astruct_mu_p_d_f_core_1_1_rectangle_html_a27cf4d4747a8677f8103746ee3386595"><div class="ttname"><a href="struct_mu_p_d_f_core_1_1_rectangle.html#a27cf4d4747a8677f8103746ee3386595">MuPDFCore.Rectangle.Round</a></div><div class="ttdeci">RoundedRectangle Round()</div><div class="ttdoc">Round the rectangle's coordinates to the closest integers.</div><div class="ttdef"><b>Definition:</b> <a href="_rectangles_8cs_source.html#l00392">Rectangles.cs:392</a></div></div>
 <div class="ttc" id="astruct_mu_p_d_f_core_1_1_rectangle_html_a4ea4052094e051b974b7ca1bc9346655"><div class="ttname"><a href="struct_mu_p_d_f_core_1_1_rectangle.html#a4ea4052094e051b974b7ca1bc9346655">MuPDFCore.Rectangle.Width</a></div><div class="ttdeci">float Width</div><div class="ttdoc">The width of the rectangle.</div><div class="ttdef"><b>Definition:</b> <a href="_rectangles_8cs_source.html#l00351">Rectangles.cs:351</a></div></div>