mirror of
https://github.com/goatcorp/Dalamud.git
synced 2025-12-12 18:27:23 +01:00
977 lines
48 KiB
HTML
977 lines
48 KiB
HTML
<!DOCTYPE html>
|
|
<!--[if IE]><![endif]-->
|
|
<html>
|
|
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
|
<title>Class UiBuilder
|
|
</title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="Class UiBuilder
|
|
">
|
|
<meta name="generator" content="docfx 2.59.1.0">
|
|
|
|
<link rel="shortcut icon" href="../favicon.ico">
|
|
<link rel="stylesheet" href="../styles/docfx.vendor.css">
|
|
<link rel="stylesheet" href="../styles/docfx.css">
|
|
<link rel="stylesheet" href="../styles/main.css">
|
|
<meta property="docfx:navrel" content="">
|
|
<meta property="docfx:tocrel" content="toc.html">
|
|
|
|
|
|
|
|
</head>
|
|
<body data-spy="scroll" data-target="#affix" data-offset="120">
|
|
<div id="wrapper">
|
|
<header>
|
|
|
|
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
|
|
<div class="container">
|
|
<div class="navbar-header">
|
|
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
|
|
<span class="sr-only">Toggle navigation</span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
</button>
|
|
|
|
<a class="navbar-brand" href="../index.html">
|
|
<img id="logo" class="svg" src="../logo.svg" alt="">
|
|
</a>
|
|
</div>
|
|
<div class="collapse navbar-collapse" id="navbar">
|
|
<form class="navbar-form navbar-right" role="search" id="search">
|
|
<div class="form-group">
|
|
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
|
|
</div>
|
|
</form>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<div class="subnav navbar navbar-default">
|
|
<div class="container hide-when-search" id="breadcrumb">
|
|
<ul class="breadcrumb">
|
|
<li></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div role="main" class="container body-content hide-when-search">
|
|
|
|
<div class="sidenav hide-when-search">
|
|
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
|
<div class="sidetoggle collapse" id="sidetoggle">
|
|
<div id="sidetoc"></div>
|
|
</div>
|
|
</div>
|
|
<div class="article row grid-right">
|
|
<div class="col-md-10">
|
|
<article class="content wrap" id="_content" data-uid="Dalamud.Interface.UiBuilder">
|
|
|
|
|
|
<h1 id="Dalamud_Interface_UiBuilder" data-uid="Dalamud.Interface.UiBuilder" class="text-break">Class UiBuilder
|
|
</h1>
|
|
<div class="markdown level0 summary"><p>This class represents the Dalamud UI that is drawn on top of the game.
|
|
It can be used to draw custom windows and overlays.</p>
|
|
</div>
|
|
<div class="markdown level0 conceptual"></div>
|
|
<div class="inheritance">
|
|
<h5>Inheritance</h5>
|
|
<div class="level0"><span class="xref">System.Object</span></div>
|
|
<div class="level1"><span class="xref">UiBuilder</span></div>
|
|
</div>
|
|
<div classs="implements">
|
|
<h5>Implements</h5>
|
|
<div><span class="xref">System.IDisposable</span></div>
|
|
</div>
|
|
<div class="inheritedMembers">
|
|
<h5>Inherited Members</h5>
|
|
<div>
|
|
<span class="xref">System.Object.Equals(System.Object)</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.GetHashCode()</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.GetType()</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.MemberwiseClone()</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.ToString()</span>
|
|
</div>
|
|
</div>
|
|
<h6><strong>Namespace</strong>: <a class="xref" href="Dalamud.Interface.html">Dalamud.Interface</a></h6>
|
|
<h6><strong>Assembly</strong>: Dalamud.dll</h6>
|
|
<h5 id="Dalamud_Interface_UiBuilder_syntax">Syntax</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public sealed class UiBuilder : IDisposable</code></pre>
|
|
</div>
|
|
<h3 id="properties">Properties
|
|
</h3>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_UiBuilder_DefaultFont.md&value=---%0Auid%3A%20Dalamud.Interface.UiBuilder.DefaultFont%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/goatcorp/Dalamud/blob/master/Dalamud/Interface/UiBuilder.cs/#L84">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Interface_UiBuilder_DefaultFont_" data-uid="Dalamud.Interface.UiBuilder.DefaultFont*"></a>
|
|
<h4 id="Dalamud_Interface_UiBuilder_DefaultFont" data-uid="Dalamud.Interface.UiBuilder.DefaultFont">DefaultFont</h4>
|
|
<div class="markdown level1 summary"><p>Gets the default Dalamud font based on Noto Sans CJK Medium in 17pt - supporting all game languages and icons.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static ImFontPtr DefaultFont { get; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</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="ImGuiNET.ImFontPtr.html">ImFontPtr</a></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_UiBuilder_Device.md&value=---%0Auid%3A%20Dalamud.Interface.UiBuilder.Device%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/goatcorp/Dalamud/blob/master/Dalamud/Interface/UiBuilder.cs/#L99">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Interface_UiBuilder_Device_" data-uid="Dalamud.Interface.UiBuilder.Device*"></a>
|
|
<h4 id="Dalamud_Interface_UiBuilder_Device" data-uid="Dalamud.Interface.UiBuilder.Device">Device</h4>
|
|
<div class="markdown level1 summary"><p>Gets the game's active Direct3D device.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public Device Device { get; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">Device</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_UiBuilder_DisableAutomaticUiHide.md&value=---%0Auid%3A%20Dalamud.Interface.UiBuilder.DisableAutomaticUiHide%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/goatcorp/Dalamud/blob/master/Dalamud/Interface/UiBuilder.cs/#L109">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Interface_UiBuilder_DisableAutomaticUiHide_" data-uid="Dalamud.Interface.UiBuilder.DisableAutomaticUiHide*"></a>
|
|
<h4 id="Dalamud_Interface_UiBuilder_DisableAutomaticUiHide" data-uid="Dalamud.Interface.UiBuilder.DisableAutomaticUiHide">DisableAutomaticUiHide</h4>
|
|
<div class="markdown level1 summary"><p>Gets or sets a value indicating whether this plugin should hide its UI automatically when the game's UI is hidden.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public bool DisableAutomaticUiHide { get; set; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Boolean</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_UiBuilder_DisableCutsceneUiHide.md&value=---%0Auid%3A%20Dalamud.Interface.UiBuilder.DisableCutsceneUiHide%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/goatcorp/Dalamud/blob/master/Dalamud/Interface/UiBuilder.cs/#L119">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Interface_UiBuilder_DisableCutsceneUiHide_" data-uid="Dalamud.Interface.UiBuilder.DisableCutsceneUiHide*"></a>
|
|
<h4 id="Dalamud_Interface_UiBuilder_DisableCutsceneUiHide" data-uid="Dalamud.Interface.UiBuilder.DisableCutsceneUiHide">DisableCutsceneUiHide</h4>
|
|
<div class="markdown level1 summary"><p>Gets or sets a value indicating whether this plugin should hide its UI automatically during cutscenes.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public bool DisableCutsceneUiHide { get; set; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Boolean</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_UiBuilder_DisableGposeUiHide.md&value=---%0Auid%3A%20Dalamud.Interface.UiBuilder.DisableGposeUiHide%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/goatcorp/Dalamud/blob/master/Dalamud/Interface/UiBuilder.cs/#L124">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Interface_UiBuilder_DisableGposeUiHide_" data-uid="Dalamud.Interface.UiBuilder.DisableGposeUiHide*"></a>
|
|
<h4 id="Dalamud_Interface_UiBuilder_DisableGposeUiHide" data-uid="Dalamud.Interface.UiBuilder.DisableGposeUiHide">DisableGposeUiHide</h4>
|
|
<div class="markdown level1 summary"><p>Gets or sets a value indicating whether this plugin should hide its UI automatically while gpose is active.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public bool DisableGposeUiHide { get; set; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Boolean</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_UiBuilder_DisableUserUiHide.md&value=---%0Auid%3A%20Dalamud.Interface.UiBuilder.DisableUserUiHide%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/goatcorp/Dalamud/blob/master/Dalamud/Interface/UiBuilder.cs/#L114">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Interface_UiBuilder_DisableUserUiHide_" data-uid="Dalamud.Interface.UiBuilder.DisableUserUiHide*"></a>
|
|
<h4 id="Dalamud_Interface_UiBuilder_DisableUserUiHide" data-uid="Dalamud.Interface.UiBuilder.DisableUserUiHide">DisableUserUiHide</h4>
|
|
<div class="markdown level1 summary"><p>Gets or sets a value indicating whether this plugin should hide its UI automatically when the user toggles the UI.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public bool DisableUserUiHide { get; set; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Boolean</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_UiBuilder_FrameCount.md&value=---%0Auid%3A%20Dalamud.Interface.UiBuilder.FrameCount%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/goatcorp/Dalamud/blob/master/Dalamud/Interface/UiBuilder.cs/#L138">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Interface_UiBuilder_FrameCount_" data-uid="Dalamud.Interface.UiBuilder.FrameCount*"></a>
|
|
<h4 id="Dalamud_Interface_UiBuilder_FrameCount" data-uid="Dalamud.Interface.UiBuilder.FrameCount">FrameCount</h4>
|
|
<div class="markdown level1 summary"><p>Gets the count of Draw calls made since plugin creation.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public ulong FrameCount { get; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.UInt64</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_UiBuilder_IconFont.md&value=---%0Auid%3A%20Dalamud.Interface.UiBuilder.IconFont%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/goatcorp/Dalamud/blob/master/Dalamud/Interface/UiBuilder.cs/#L89">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Interface_UiBuilder_IconFont_" data-uid="Dalamud.Interface.UiBuilder.IconFont*"></a>
|
|
<h4 id="Dalamud_Interface_UiBuilder_IconFont" data-uid="Dalamud.Interface.UiBuilder.IconFont">IconFont</h4>
|
|
<div class="markdown level1 summary"><p>Gets the default Dalamud icon font based on FontAwesome 5 Free solid in 17pt.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static ImFontPtr IconFont { get; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</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="ImGuiNET.ImFontPtr.html">ImFontPtr</a></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_UiBuilder_MonoFont.md&value=---%0Auid%3A%20Dalamud.Interface.UiBuilder.MonoFont%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/goatcorp/Dalamud/blob/master/Dalamud/Interface/UiBuilder.cs/#L94">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Interface_UiBuilder_MonoFont_" data-uid="Dalamud.Interface.UiBuilder.MonoFont*"></a>
|
|
<h4 id="Dalamud_Interface_UiBuilder_MonoFont" data-uid="Dalamud.Interface.UiBuilder.MonoFont">MonoFont</h4>
|
|
<div class="markdown level1 summary"><p>Gets the default Dalamud monospaced font based on Inconsolata Regular in 16pt.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static ImFontPtr MonoFont { get; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</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="ImGuiNET.ImFontPtr.html">ImFontPtr</a></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_UiBuilder_OverrideGameCursor.md&value=---%0Auid%3A%20Dalamud.Interface.UiBuilder.OverrideGameCursor%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/goatcorp/Dalamud/blob/master/Dalamud/Interface/UiBuilder.cs/#L129">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Interface_UiBuilder_OverrideGameCursor_" data-uid="Dalamud.Interface.UiBuilder.OverrideGameCursor*"></a>
|
|
<h4 id="Dalamud_Interface_UiBuilder_OverrideGameCursor" data-uid="Dalamud.Interface.UiBuilder.OverrideGameCursor">OverrideGameCursor</h4>
|
|
<div class="markdown level1 summary"><p>Gets or sets a value indicating whether or not the game's cursor should be overridden with the ImGui cursor.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public bool OverrideGameCursor { get; set; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Boolean</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_UiBuilder_WindowHandlePtr.md&value=---%0Auid%3A%20Dalamud.Interface.UiBuilder.WindowHandlePtr%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/goatcorp/Dalamud/blob/master/Dalamud/Interface/UiBuilder.cs/#L104">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Interface_UiBuilder_WindowHandlePtr_" data-uid="Dalamud.Interface.UiBuilder.WindowHandlePtr*"></a>
|
|
<h4 id="Dalamud_Interface_UiBuilder_WindowHandlePtr" data-uid="Dalamud.Interface.UiBuilder.WindowHandlePtr">WindowHandlePtr</h4>
|
|
<div class="markdown level1 summary"><p>Gets the game's main window handle.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public IntPtr WindowHandlePtr { get; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.IntPtr</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="methods">Methods
|
|
</h3>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_UiBuilder_AddNotification_System_String_System_String_Dalamud_Interface_Internal_Notifications_NotificationType_System_UInt32_.md&value=---%0Auid%3A%20Dalamud.Interface.UiBuilder.AddNotification(System.String%2CSystem.String%2CDalamud.Interface.Internal.Notifications.NotificationType%2CSystem.UInt32)%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/goatcorp/Dalamud/blob/master/Dalamud/Interface/UiBuilder.cs/#L240">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Interface_UiBuilder_AddNotification_" data-uid="Dalamud.Interface.UiBuilder.AddNotification*"></a>
|
|
<h4 id="Dalamud_Interface_UiBuilder_AddNotification_System_String_System_String_Dalamud_Interface_Internal_Notifications_NotificationType_System_UInt32_" data-uid="Dalamud.Interface.UiBuilder.AddNotification(System.String,System.String,Dalamud.Interface.Internal.Notifications.NotificationType,System.UInt32)">AddNotification(String, String, NotificationType, UInt32)</h4>
|
|
<div class="markdown level1 summary"><p>Add a notification to the notification queue.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void AddNotification(string content, string title = null, NotificationType type = NotificationType.None, uint msDelay = 3000U)</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.String</span></td>
|
|
<td><span class="parametername">content</span></td>
|
|
<td><p>The content of the notification.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">title</span></td>
|
|
<td><p>The title of the notification.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">Dalamud.Interface.Internal.Notifications.NotificationType</span></td>
|
|
<td><span class="parametername">type</span></td>
|
|
<td><p>The type of the notification.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.UInt32</span></td>
|
|
<td><span class="parametername">msDelay</span></td>
|
|
<td><p>The time the notification should be displayed for.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_UiBuilder_GetGameFontHandle_Dalamud_Interface_GameFonts_GameFontStyle_.md&value=---%0Auid%3A%20Dalamud.Interface.UiBuilder.GetGameFontHandle(Dalamud.Interface.GameFonts.GameFontStyle)%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/goatcorp/Dalamud/blob/master/Dalamud/Interface/UiBuilder.cs/#L220">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Interface_UiBuilder_GetGameFontHandle_" data-uid="Dalamud.Interface.UiBuilder.GetGameFontHandle*"></a>
|
|
<h4 id="Dalamud_Interface_UiBuilder_GetGameFontHandle_Dalamud_Interface_GameFonts_GameFontStyle_" data-uid="Dalamud.Interface.UiBuilder.GetGameFontHandle(Dalamud.Interface.GameFonts.GameFontStyle)">GetGameFontHandle(GameFontStyle)</h4>
|
|
<div class="markdown level1 summary"><p>Gets a game font.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public GameFontHandle GetGameFontHandle(GameFontStyle style)</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><a class="xref" href="Dalamud.Interface.GameFonts.GameFontStyle.html">GameFontStyle</a></td>
|
|
<td><span class="parametername">style</span></td>
|
|
<td><p>Font to get.</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="Dalamud.Interface.GameFonts.GameFontHandle.html">GameFontHandle</a></td>
|
|
<td><p>Handle to the game font which may or may not be available for use yet.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/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/goatcorp/Dalamud/blob/master/Dalamud/Interface/UiBuilder.cs/#L201">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>
|
|
<div class="markdown level1 summary"><p>Loads an image from a byte stream, such as a png downloaded into memory.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public TextureWrap LoadImage(byte[] imageData)</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 image data.</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>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/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/goatcorp/Dalamud/blob/master/Dalamud/Interface/UiBuilder.cs/#L193">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>
|
|
<div class="markdown level1 summary"><p>Loads an image from the specified file.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public TextureWrap LoadImage(string filePath)</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.String</span></td>
|
|
<td><span class="parametername">filePath</span></td>
|
|
<td><p>The full filepath to the image.</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>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/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/goatcorp/Dalamud/blob/master/Dalamud/Interface/UiBuilder.cs/#L212">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>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_UiBuilder_RebuildFonts.md&value=---%0Auid%3A%20Dalamud.Interface.UiBuilder.RebuildFonts%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/goatcorp/Dalamud/blob/master/Dalamud/Interface/UiBuilder.cs/#L227">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Interface_UiBuilder_RebuildFonts_" data-uid="Dalamud.Interface.UiBuilder.RebuildFonts*"></a>
|
|
<h4 id="Dalamud_Interface_UiBuilder_RebuildFonts" data-uid="Dalamud.Interface.UiBuilder.RebuildFonts">RebuildFonts()</h4>
|
|
<div class="markdown level1 summary"><p>Call this to queue a rebuild of the font atlas.<br>
|
|
This will invoke any <span class="xref">Dalamud.Interface.UiBuilder.OnBuildFonts</span> handlers and ensure that any loaded fonts are
|
|
ready to be used on the next UI frame.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void RebuildFonts()</code></pre>
|
|
</div>
|
|
<h3 id="events">Events
|
|
</h3>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_UiBuilder_AfterBuildFonts.md&value=---%0Auid%3A%20Dalamud.Interface.UiBuilder.AfterBuildFonts%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/goatcorp/Dalamud/blob/master/Dalamud/Interface/UiBuilder.cs/#L79">View Source</a>
|
|
</span>
|
|
<h4 id="Dalamud_Interface_UiBuilder_AfterBuildFonts" data-uid="Dalamud.Interface.UiBuilder.AfterBuildFonts">AfterBuildFonts</h4>
|
|
<div class="markdown level1 summary"><p>Gets or sets an action that is called any time right after ImGui fonts are rebuilt.<br>
|
|
Any ImFontPtr objects that you store <strong>can be invalidated</strong> when fonts are rebuilt
|
|
(at any time), so you should both reload your custom fonts and restore those
|
|
pointers inside this handler.<br>
|
|
<strong>PLEASE remove this handler inside Dispose, or when you no longer need your fonts!</strong></p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public event Action AfterBuildFonts</code></pre>
|
|
</div>
|
|
<h5 class="eventType">Event Type</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Action</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_UiBuilder_BuildFonts.md&value=---%0Auid%3A%20Dalamud.Interface.UiBuilder.BuildFonts%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/goatcorp/Dalamud/blob/master/Dalamud/Interface/UiBuilder.cs/#L70">View Source</a>
|
|
</span>
|
|
<h4 id="Dalamud_Interface_UiBuilder_BuildFonts" data-uid="Dalamud.Interface.UiBuilder.BuildFonts">BuildFonts</h4>
|
|
<div class="markdown level1 summary"><p>Gets or sets an action that is called any time ImGui fonts need to be rebuilt.<br>
|
|
Any ImFontPtr objects that you store <strong>can be invalidated</strong> when fonts are rebuilt
|
|
(at any time), so you should both reload your custom fonts and restore those
|
|
pointers inside this handler.<br>
|
|
<strong>PLEASE remove this handler inside Dispose, or when you no longer need your fonts!</strong></p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public event Action BuildFonts</code></pre>
|
|
</div>
|
|
<h5 class="eventType">Event Type</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Action</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_UiBuilder_Draw.md&value=---%0Auid%3A%20Dalamud.Interface.UiBuilder.Draw%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/goatcorp/Dalamud/blob/master/Dalamud/Interface/UiBuilder.cs/#L51">View Source</a>
|
|
</span>
|
|
<h4 id="Dalamud_Interface_UiBuilder_Draw" data-uid="Dalamud.Interface.UiBuilder.Draw">Draw</h4>
|
|
<div class="markdown level1 summary"><p>The event that gets called when Dalamud is ready to draw your windows or overlays.
|
|
When it is called, you can use static ImGui calls.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public event Action Draw</code></pre>
|
|
</div>
|
|
<h5 class="eventType">Event Type</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Action</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_UiBuilder_OpenConfigUi.md&value=---%0Auid%3A%20Dalamud.Interface.UiBuilder.OpenConfigUi%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/goatcorp/Dalamud/blob/master/Dalamud/Interface/UiBuilder.cs/#L61">View Source</a>
|
|
</span>
|
|
<h4 id="Dalamud_Interface_UiBuilder_OpenConfigUi" data-uid="Dalamud.Interface.UiBuilder.OpenConfigUi">OpenConfigUi</h4>
|
|
<div class="markdown level1 summary"><p>Event that is fired when the plugin should open its configuration interface.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public event Action OpenConfigUi</code></pre>
|
|
</div>
|
|
<h5 class="eventType">Event Type</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Action</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_UiBuilder_ResizeBuffers.md&value=---%0Auid%3A%20Dalamud.Interface.UiBuilder.ResizeBuffers%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/goatcorp/Dalamud/blob/master/Dalamud/Interface/UiBuilder.cs/#L56">View Source</a>
|
|
</span>
|
|
<h4 id="Dalamud_Interface_UiBuilder_ResizeBuffers" data-uid="Dalamud.Interface.UiBuilder.ResizeBuffers">ResizeBuffers</h4>
|
|
<div class="markdown level1 summary"><p>The event that is called when the game's DirectX device is requesting you to resize your buffers.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public event Action ResizeBuffers</code></pre>
|
|
</div>
|
|
<h5 class="eventType">Event Type</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Action</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="eii">Explicit Interface Implementations
|
|
</h3>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_UiBuilder_System_IDisposable_Dispose.md&value=---%0Auid%3A%20Dalamud.Interface.UiBuilder.System%23IDisposable%23Dispose%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/goatcorp/Dalamud/blob/master/Dalamud/Interface/UiBuilder.cs/#L247">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Interface_UiBuilder_System_IDisposable_Dispose_" data-uid="Dalamud.Interface.UiBuilder.System#IDisposable#Dispose*"></a>
|
|
<h4 id="Dalamud_Interface_UiBuilder_System_IDisposable_Dispose" data-uid="Dalamud.Interface.UiBuilder.System#IDisposable#Dispose">IDisposable.Dispose()</h4>
|
|
<div class="markdown level1 summary"><p>Unregister the UiBuilder. Do not call this in plugin code.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">void IDisposable.Dispose()</code></pre>
|
|
</div>
|
|
<h3 id="implements">Implements</h3>
|
|
<div>
|
|
<span class="xref">System.IDisposable</span>
|
|
</div>
|
|
</article>
|
|
</div>
|
|
|
|
<div class="hidden-sm col-md-2" role="complementary">
|
|
<div class="sideaffix">
|
|
<div class="contribution">
|
|
<ul class="nav">
|
|
<li>
|
|
<a href="https://github.com/goatcorp/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/goatcorp/Dalamud/blob/master/Dalamud/Interface/UiBuilder.cs/#L23" class="contribution-link">View Source</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
|
<h5>In This Article</h5>
|
|
<div></div>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<footer>
|
|
<div class="grad-bottom"></div>
|
|
<div class="footer">
|
|
<div class="container">
|
|
<span class="pull-right">
|
|
<a href="#top">Back to top</a>
|
|
</span>
|
|
|
|
<span>Generated by <strong>DocFX</strong></span>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
</div>
|
|
|
|
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
|
<script type="text/javascript" src="../styles/docfx.js"></script>
|
|
<script type="text/javascript" src="../styles/main.js"></script>
|
|
</body>
|
|
</html>
|