mirror of
https://github.com/goatcorp/Dalamud.git
synced 2026-02-09 09:24:35 +01:00
docs: regenerate
This commit is contained in:
goat
parent
e10941d2be
commit
879ef34d75
67 changed files with 8551 additions and 2686 deletions
|
|
@ -123,7 +123,7 @@ It can be used to draw custom windows and overlays.</p>
|
|||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_UiBuilder__ctor_Dalamud_Interface_InterfaceManager_System_String_.md&value=---%0Auid%3A%20Dalamud.Interface.UiBuilder.%23ctor(Dalamud.Interface.InterfaceManager%2CSystem.String)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Interface/UiBuilder.cs/#L31">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Interface/UiBuilder.cs/#L32">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Interface_UiBuilder__ctor_" data-uid="Dalamud.Interface.UiBuilder.#ctor*"></a>
|
||||
<h4 id="Dalamud_Interface_UiBuilder__ctor_Dalamud_Interface_InterfaceManager_System_String_" data-uid="Dalamud.Interface.UiBuilder.#ctor(Dalamud.Interface.InterfaceManager,System.String)">UiBuilder(InterfaceManager, String)</h4>
|
||||
|
|
@ -165,7 +165,7 @@ It can be used to draw custom windows and overlays.</p>
|
|||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_UiBuilder_OnOpenConfigUi.md&value=---%0Auid%3A%20Dalamud.Interface.UiBuilder.OnOpenConfigUi%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Interface/UiBuilder.cs/#L64">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Interface/UiBuilder.cs/#L76">View Source</a>
|
||||
</span>
|
||||
<h4 id="Dalamud_Interface_UiBuilder_OnOpenConfigUi" data-uid="Dalamud.Interface.UiBuilder.OnOpenConfigUi">OnOpenConfigUi</h4>
|
||||
<div class="markdown level1 summary"><p>Event that is fired when the plugin should open its configuration interface.</p>
|
||||
|
|
@ -197,7 +197,7 @@ It can be used to draw custom windows and overlays.</p>
|
|||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_UiBuilder_Dispose.md&value=---%0Auid%3A%20Dalamud.Interface.UiBuilder.Dispose%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Interface/UiBuilder.cs/#L41">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Interface/UiBuilder.cs/#L42">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Interface_UiBuilder_Dispose_" data-uid="Dalamud.Interface.UiBuilder.Dispose*"></a>
|
||||
<h4 id="Dalamud_Interface_UiBuilder_Dispose" data-uid="Dalamud.Interface.UiBuilder.Dispose">Dispose()</h4>
|
||||
|
|
@ -213,7 +213,7 @@ It can be used to draw custom windows and overlays.</p>
|
|||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_UiBuilder_LoadImage_System_Byte___.md&value=---%0Auid%3A%20Dalamud.Interface.UiBuilder.LoadImage(System.Byte%5B%5D)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Interface/UiBuilder.cs/#L58">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Interface/UiBuilder.cs/#L59">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Interface_UiBuilder_LoadImage_" data-uid="Dalamud.Interface.UiBuilder.LoadImage*"></a>
|
||||
<h4 id="Dalamud_Interface_UiBuilder_LoadImage_System_Byte___" data-uid="Dalamud.Interface.UiBuilder.LoadImage(System.Byte[])">LoadImage(Byte[])</h4>
|
||||
|
|
@ -263,7 +263,7 @@ It can be used to draw custom windows and overlays.</p>
|
|||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_UiBuilder_LoadImage_System_String_.md&value=---%0Auid%3A%20Dalamud.Interface.UiBuilder.LoadImage(System.String)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Interface/UiBuilder.cs/#L50">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Interface/UiBuilder.cs/#L51">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Interface_UiBuilder_LoadImage_" data-uid="Dalamud.Interface.UiBuilder.LoadImage*"></a>
|
||||
<h4 id="Dalamud_Interface_UiBuilder_LoadImage_System_String_" data-uid="Dalamud.Interface.UiBuilder.LoadImage(System.String)">LoadImage(String)</h4>
|
||||
|
|
@ -304,6 +304,74 @@ It can be used to draw custom windows and overlays.</p>
|
|||
<tr>
|
||||
<td><a class="xref" href="ImGuiScene.TextureWrap.html">TextureWrap</a></td>
|
||||
<td><p>A <a class="xref" href="ImGuiScene.TextureWrap.html">TextureWrap</a> object wrapping the created image. Use <a class="xref" href="ImGuiScene.TextureWrap.html#ImGuiScene_TextureWrap_ImGuiHandle">ImGuiHandle</a> inside ImGui.Image()</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_UiBuilder_LoadImageRaw_System_Byte___System_Int32_System_Int32_System_Int32_.md&value=---%0Auid%3A%20Dalamud.Interface.UiBuilder.LoadImageRaw(System.Byte%5B%5D%2CSystem.Int32%2CSystem.Int32%2CSystem.Int32)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Interface/UiBuilder.cs/#L70">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Interface_UiBuilder_LoadImageRaw_" data-uid="Dalamud.Interface.UiBuilder.LoadImageRaw*"></a>
|
||||
<h4 id="Dalamud_Interface_UiBuilder_LoadImageRaw_System_Byte___System_Int32_System_Int32_System_Int32_" data-uid="Dalamud.Interface.UiBuilder.LoadImageRaw(System.Byte[],System.Int32,System.Int32,System.Int32)">LoadImageRaw(Byte[], Int32, Int32, Int32)</h4>
|
||||
<div class="markdown level1 summary"><p>Loads an image from raw unformatted pixel data, with no type or header information. To load formatted data, use <a class="xref" href="Dalamud.Interface.UiBuilder.html#Dalamud_Interface_UiBuilder_LoadImage_System_Byte___">LoadImage(Byte[])</a>.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public TextureWrap LoadImageRaw(byte[] imageData, int width, int height, int numChannels)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Byte</span>[]</td>
|
||||
<td><span class="parametername">imageData</span></td>
|
||||
<td><p>A byte array containing the raw pixel data.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Int32</span></td>
|
||||
<td><span class="parametername">width</span></td>
|
||||
<td><p>The width of the image contained in <code data-dev-comment-type="paramref" class="paramref">imageData</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Int32</span></td>
|
||||
<td><span class="parametername">height</span></td>
|
||||
<td><p>The height of the image contained in <code data-dev-comment-type="paramref" class="paramref">imageData</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Int32</span></td>
|
||||
<td><span class="parametername">numChannels</span></td>
|
||||
<td><p>The number of channels (bytes per pixel) of the image contained in <code data-dev-comment-type="paramref" class="paramref">imageData</code>. This should usually be 4.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="returns">Returns</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="ImGuiScene.TextureWrap.html">TextureWrap</a></td>
|
||||
<td><p>A <a class="xref" href="ImGuiScene.TextureWrap.html">TextureWrap</a> object wrapping the created image. Use <a class="xref" href="ImGuiScene.TextureWrap.html#ImGuiScene_TextureWrap_ImGuiHandle">ImGuiHandle</a> inside ImGui.Image()</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
|
@ -315,7 +383,7 @@ It can be used to draw custom windows and overlays.</p>
|
|||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_UiBuilder_OnBuildUi.md&value=---%0Auid%3A%20Dalamud.Interface.UiBuilder.OnBuildUi%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
||||
</span>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Interface/UiBuilder.cs/#L22">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Interface/UiBuilder.cs/#L23">View Source</a>
|
||||
</span>
|
||||
<h4 id="Dalamud_Interface_UiBuilder_OnBuildUi" data-uid="Dalamud.Interface.UiBuilder.OnBuildUi">OnBuildUi</h4>
|
||||
<div class="markdown level1 summary"><p>The delegate that gets called when Dalamud is ready to draw your windows or overlays.
|
||||
|
|
@ -356,7 +424,7 @@ When it is called, you can use static ImGui calls.</p>
|
|||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_UiBuilder.md&value=---%0Auid%3A%20Dalamud.Interface.UiBuilder%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Interface/UiBuilder.cs/#L15" class="contribution-link">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Interface/UiBuilder.cs/#L16" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue