mirror of
https://github.com/goatcorp/Dalamud.git
synced 2025-12-12 18:27:23 +01:00
1092 lines
53 KiB
HTML
1092 lines
53 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 ImGuiHelpers
|
|
</title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="Class ImGuiHelpers
|
|
">
|
|
<meta name="generator" content="docfx 2.59.4.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.ImGuiHelpers">
|
|
|
|
|
|
<h1 id="Dalamud_Interface_ImGuiHelpers" data-uid="Dalamud.Interface.ImGuiHelpers" class="text-break">Class ImGuiHelpers
|
|
</h1>
|
|
<div class="markdown level0 summary"><p>Class containing various helper methods for use with ImGui inside Dalamud.</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">ImGuiHelpers</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_ImGuiHelpers_syntax">Syntax</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static class ImGuiHelpers</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_ImGuiHelpers_GlobalScale.md&value=---%0Auid%3A%20Dalamud.Interface.ImGuiHelpers.GlobalScale%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/ImGuiHelpers.cs/#L26">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Interface_ImGuiHelpers_GlobalScale_" data-uid="Dalamud.Interface.ImGuiHelpers.GlobalScale*"></a>
|
|
<h4 id="Dalamud_Interface_ImGuiHelpers_GlobalScale" data-uid="Dalamud.Interface.ImGuiHelpers.GlobalScale">GlobalScale</h4>
|
|
<div class="markdown level1 summary"><p>Gets the global Dalamud scale.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static float GlobalScale { 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.Single</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_ImGuiHelpers_MainViewport.md&value=---%0Auid%3A%20Dalamud.Interface.ImGuiHelpers.MainViewport%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/ImGuiHelpers.cs/#L21">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Interface_ImGuiHelpers_MainViewport_" data-uid="Dalamud.Interface.ImGuiHelpers.MainViewport*"></a>
|
|
<h4 id="Dalamud_Interface_ImGuiHelpers_MainViewport" data-uid="Dalamud.Interface.ImGuiHelpers.MainViewport">MainViewport</h4>
|
|
<div class="markdown level1 summary"><p>Gets the main viewport.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static ImGuiViewportPtr MainViewport { 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.ImGuiViewportPtr.html">ImGuiViewportPtr</a></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_ImGuiHelpers_CenterCursorFor_System_Int32_.md&value=---%0Auid%3A%20Dalamud.Interface.ImGuiHelpers.CenterCursorFor(System.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/ImGuiHelpers.cs/#L271">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Interface_ImGuiHelpers_CenterCursorFor_" data-uid="Dalamud.Interface.ImGuiHelpers.CenterCursorFor*"></a>
|
|
<h4 id="Dalamud_Interface_ImGuiHelpers_CenterCursorFor_System_Int32_" data-uid="Dalamud.Interface.ImGuiHelpers.CenterCursorFor(System.Int32)">CenterCursorFor(Int32)</h4>
|
|
<div class="markdown level1 summary"><p>Center the ImGui cursor for an item with a certain width.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static void CenterCursorFor(int itemWidth)</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.Int32</span></td>
|
|
<td><span class="parametername">itemWidth</span></td>
|
|
<td><p>The width to center 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_ImGuiHelpers_CenterCursorForText_System_String_.md&value=---%0Auid%3A%20Dalamud.Interface.ImGuiHelpers.CenterCursorForText(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/ImGuiHelpers.cs/#L261">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Interface_ImGuiHelpers_CenterCursorForText_" data-uid="Dalamud.Interface.ImGuiHelpers.CenterCursorForText*"></a>
|
|
<h4 id="Dalamud_Interface_ImGuiHelpers_CenterCursorForText_System_String_" data-uid="Dalamud.Interface.ImGuiHelpers.CenterCursorForText(System.String)">CenterCursorForText(String)</h4>
|
|
<div class="markdown level1 summary"><p>Center the ImGui cursor for a certain text.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static void CenterCursorForText(string text)</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">text</span></td>
|
|
<td><p>The text to center 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_ImGuiHelpers_CenteredText_System_String_.md&value=---%0Auid%3A%20Dalamud.Interface.ImGuiHelpers.CenteredText(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/ImGuiHelpers.cs/#L251">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Interface_ImGuiHelpers_CenteredText_" data-uid="Dalamud.Interface.ImGuiHelpers.CenteredText*"></a>
|
|
<h4 id="Dalamud_Interface_ImGuiHelpers_CenteredText_System_String_" data-uid="Dalamud.Interface.ImGuiHelpers.CenteredText(System.String)">CenteredText(String)</h4>
|
|
<div class="markdown level1 summary"><p>Show centered text.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static void CenteredText(string text)</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">text</span></td>
|
|
<td><p>Text to show.</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_ImGuiHelpers_ClickToCopyText_System_String_System_String_.md&value=---%0Auid%3A%20Dalamud.Interface.ImGuiHelpers.ClickToCopyText(System.String%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/goatcorp/Dalamud/blob/master/Dalamud/Interface/ImGuiHelpers.cs/#L132">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Interface_ImGuiHelpers_ClickToCopyText_" data-uid="Dalamud.Interface.ImGuiHelpers.ClickToCopyText*"></a>
|
|
<h4 id="Dalamud_Interface_ImGuiHelpers_ClickToCopyText_System_String_System_String_" data-uid="Dalamud.Interface.ImGuiHelpers.ClickToCopyText(System.String,System.String)">ClickToCopyText(String, String)</h4>
|
|
<div class="markdown level1 summary"><p>Print out text that can be copied when clicked.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static void ClickToCopyText(string text, string textCopy = null)</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">text</span></td>
|
|
<td><p>The text to show.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">textCopy</span></td>
|
|
<td><p>The text to copy when clicked.</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_ImGuiHelpers_CopyGlyphsAcrossFonts_System_Nullable_ImGuiNET_ImFontPtr__System_Nullable_ImGuiNET_ImFontPtr__System_Boolean_System_Boolean_System_Int32_System_Int32_.md&value=---%0Auid%3A%20Dalamud.Interface.ImGuiHelpers.CopyGlyphsAcrossFonts(System.Nullable%7BImGuiNET.ImFontPtr%7D%2CSystem.Nullable%7BImGuiNET.ImFontPtr%7D%2CSystem.Boolean%2CSystem.Boolean%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/ImGuiHelpers.cs/#L160">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Interface_ImGuiHelpers_CopyGlyphsAcrossFonts_" data-uid="Dalamud.Interface.ImGuiHelpers.CopyGlyphsAcrossFonts*"></a>
|
|
<h4 id="Dalamud_Interface_ImGuiHelpers_CopyGlyphsAcrossFonts_System_Nullable_ImGuiNET_ImFontPtr__System_Nullable_ImGuiNET_ImFontPtr__System_Boolean_System_Boolean_System_Int32_System_Int32_" data-uid="Dalamud.Interface.ImGuiHelpers.CopyGlyphsAcrossFonts(System.Nullable{ImGuiNET.ImFontPtr},System.Nullable{ImGuiNET.ImFontPtr},System.Boolean,System.Boolean,System.Int32,System.Int32)">CopyGlyphsAcrossFonts(Nullable<ImFontPtr>, Nullable<ImFontPtr>, Boolean, Boolean, Int32, Int32)</h4>
|
|
<div class="markdown level1 summary"><p>Fills missing glyphs in target font from source font, if both are not null.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static void CopyGlyphsAcrossFonts(ImFontPtr? source, ImFontPtr? target, bool missingOnly, bool rebuildLookupTable, int rangeLow = 32, int rangeHigh = 65534)</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.Nullable</span><<a class="xref" href="ImGuiNET.ImFontPtr.html">ImFontPtr</a>></td>
|
|
<td><span class="parametername">source</span></td>
|
|
<td><p>Source font.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Nullable</span><<a class="xref" href="ImGuiNET.ImFontPtr.html">ImFontPtr</a>></td>
|
|
<td><span class="parametername">target</span></td>
|
|
<td><p>Target font.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Boolean</span></td>
|
|
<td><span class="parametername">missingOnly</span></td>
|
|
<td><p>Whether to copy missing glyphs only.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Boolean</span></td>
|
|
<td><span class="parametername">rebuildLookupTable</span></td>
|
|
<td><p>Whether to call target.BuildLookupTable().</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Int32</span></td>
|
|
<td><span class="parametername">rangeLow</span></td>
|
|
<td><p>Low codepoint range to copy.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Int32</span></td>
|
|
<td><span class="parametername">rangeHigh</span></td>
|
|
<td><p>High codepoing range to copy.</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_ImGuiHelpers_DefaultColorPalette_System_Int32_.md&value=---%0Auid%3A%20Dalamud.Interface.ImGuiHelpers.DefaultColorPalette(System.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/ImGuiHelpers.cs/#L108">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Interface_ImGuiHelpers_DefaultColorPalette_" data-uid="Dalamud.Interface.ImGuiHelpers.DefaultColorPalette*"></a>
|
|
<h4 id="Dalamud_Interface_ImGuiHelpers_DefaultColorPalette_System_Int32_" data-uid="Dalamud.Interface.ImGuiHelpers.DefaultColorPalette(System.Int32)">DefaultColorPalette(Int32)</h4>
|
|
<div class="markdown level1 summary"><p>Creates default color palette for use with color pickers.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static List<Vector4> DefaultColorPalette(int swatchCount = 32)</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.Int32</span></td>
|
|
<td><span class="parametername">swatchCount</span></td>
|
|
<td><p>The total number of swatches to use.</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><span class="xref">System.Collections.Generic.List</span><<span class="xref">System.Numerics.Vector4</span>></td>
|
|
<td><p>Default color palette.</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_ImGuiHelpers_ForceNextWindowMainViewport.md&value=---%0Auid%3A%20Dalamud.Interface.ImGuiHelpers.ForceNextWindowMainViewport%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/ImGuiHelpers.cs/#L56">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Interface_ImGuiHelpers_ForceNextWindowMainViewport_" data-uid="Dalamud.Interface.ImGuiHelpers.ForceNextWindowMainViewport*"></a>
|
|
<h4 id="Dalamud_Interface_ImGuiHelpers_ForceNextWindowMainViewport" data-uid="Dalamud.Interface.ImGuiHelpers.ForceNextWindowMainViewport">ForceNextWindowMainViewport()</h4>
|
|
<div class="markdown level1 summary"><p>Force the next ImGui window to stay inside the main game window.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static void ForceNextWindowMainViewport()</code></pre>
|
|
</div>
|
|
<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_ImGuiHelpers_GetButtonSize_System_String_.md&value=---%0Auid%3A%20Dalamud.Interface.ImGuiHelpers.GetButtonSize(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/ImGuiHelpers.cs/#L125">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Interface_ImGuiHelpers_GetButtonSize_" data-uid="Dalamud.Interface.ImGuiHelpers.GetButtonSize*"></a>
|
|
<h4 id="Dalamud_Interface_ImGuiHelpers_GetButtonSize_System_String_" data-uid="Dalamud.Interface.ImGuiHelpers.GetButtonSize(System.String)">GetButtonSize(String)</h4>
|
|
<div class="markdown level1 summary"><p>Get the size of a button considering the default frame padding.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static Vector2 GetButtonSize(string text)</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">text</span></td>
|
|
<td><p>Text in the button.</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><span class="xref">System.Numerics.Vector2</span></td>
|
|
<td><p><span class="xref">System.Numerics.Vector2</span> with the size of the button.</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_ImGuiHelpers_ImGuiKeyToVirtualKey_ImGuiNET_ImGuiKey_.md&value=---%0Auid%3A%20Dalamud.Interface.ImGuiHelpers.ImGuiKeyToVirtualKey(ImGuiNET.ImGuiKey)%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/ImGuiHelpers.cs/#L242">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Interface_ImGuiHelpers_ImGuiKeyToVirtualKey_" data-uid="Dalamud.Interface.ImGuiHelpers.ImGuiKeyToVirtualKey*"></a>
|
|
<h4 id="Dalamud_Interface_ImGuiHelpers_ImGuiKeyToVirtualKey_ImGuiNET_ImGuiKey_" data-uid="Dalamud.Interface.ImGuiHelpers.ImGuiKeyToVirtualKey(ImGuiNET.ImGuiKey)">ImGuiKeyToVirtualKey(ImGuiKey)</h4>
|
|
<div class="markdown level1 summary"><p>Map an ImGuiKey enum value to a VirtualKey code.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static VirtualKey ImGuiKeyToVirtualKey(ImGuiKey key)</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="ImGuiNET.ImGuiKey.html">ImGuiKey</a></td>
|
|
<td><span class="parametername">key</span></td>
|
|
<td><p>The ImGuiKey value to retrieve the VirtualKey counterpart for.</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.Game.ClientState.Keys.VirtualKey.html">VirtualKey</a></td>
|
|
<td><p>The VirtualKey that corresponds to this ImGuiKey, or <code>VirtualKey.NO_KEY</code> otherwise.</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_ImGuiHelpers_SafeTextWrapped_System_String_.md&value=---%0Auid%3A%20Dalamud.Interface.ImGuiHelpers.SafeTextWrapped(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/ImGuiHelpers.cs/#L149">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Interface_ImGuiHelpers_SafeTextWrapped_" data-uid="Dalamud.Interface.ImGuiHelpers.SafeTextWrapped*"></a>
|
|
<h4 id="Dalamud_Interface_ImGuiHelpers_SafeTextWrapped_System_String_" data-uid="Dalamud.Interface.ImGuiHelpers.SafeTextWrapped(System.String)">SafeTextWrapped(String)</h4>
|
|
<div class="markdown level1 summary"><p>Write unformatted text wrapped.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static void SafeTextWrapped(string text)</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">text</span></td>
|
|
<td><p>The text to write.</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_ImGuiHelpers_ScaledDummy_System_Numerics_Vector2_.md&value=---%0Auid%3A%20Dalamud.Interface.ImGuiHelpers.ScaledDummy(System.Numerics.Vector2)%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/ImGuiHelpers.cs/#L75">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Interface_ImGuiHelpers_ScaledDummy_" data-uid="Dalamud.Interface.ImGuiHelpers.ScaledDummy*"></a>
|
|
<h4 id="Dalamud_Interface_ImGuiHelpers_ScaledDummy_System_Numerics_Vector2_" data-uid="Dalamud.Interface.ImGuiHelpers.ScaledDummy(System.Numerics.Vector2)">ScaledDummy(Vector2)</h4>
|
|
<div class="markdown level1 summary"><p>Create a dummy scaled by the global Dalamud scale.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static void ScaledDummy(Vector2 size)</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.Numerics.Vector2</span></td>
|
|
<td><span class="parametername">size</span></td>
|
|
<td><p>The size of the dummy.</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_ImGuiHelpers_ScaledDummy_System_Single_.md&value=---%0Auid%3A%20Dalamud.Interface.ImGuiHelpers.ScaledDummy(System.Single)%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/ImGuiHelpers.cs/#L62">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Interface_ImGuiHelpers_ScaledDummy_" data-uid="Dalamud.Interface.ImGuiHelpers.ScaledDummy*"></a>
|
|
<h4 id="Dalamud_Interface_ImGuiHelpers_ScaledDummy_System_Single_" data-uid="Dalamud.Interface.ImGuiHelpers.ScaledDummy(System.Single)">ScaledDummy(Single)</h4>
|
|
<div class="markdown level1 summary"><p>Create a dummy scaled by the global Dalamud scale.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static void ScaledDummy(float size)</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.Single</span></td>
|
|
<td><span class="parametername">size</span></td>
|
|
<td><p>The size of the dummy.</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_ImGuiHelpers_ScaledDummy_System_Single_System_Single_.md&value=---%0Auid%3A%20Dalamud.Interface.ImGuiHelpers.ScaledDummy(System.Single%2CSystem.Single)%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/ImGuiHelpers.cs/#L69">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Interface_ImGuiHelpers_ScaledDummy_" data-uid="Dalamud.Interface.ImGuiHelpers.ScaledDummy*"></a>
|
|
<h4 id="Dalamud_Interface_ImGuiHelpers_ScaledDummy_System_Single_System_Single_" data-uid="Dalamud.Interface.ImGuiHelpers.ScaledDummy(System.Single,System.Single)">ScaledDummy(Single, Single)</h4>
|
|
<div class="markdown level1 summary"><p>Create a dummy scaled by the global Dalamud scale.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static void ScaledDummy(float x, float y)</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.Single</span></td>
|
|
<td><span class="parametername">x</span></td>
|
|
<td><p>Vector2 X parameter.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Single</span></td>
|
|
<td><span class="parametername">y</span></td>
|
|
<td><p>Vector2 Y parameter.</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_ImGuiHelpers_ScaledRelativeSameLine_System_Single_System_Single_.md&value=---%0Auid%3A%20Dalamud.Interface.ImGuiHelpers.ScaledRelativeSameLine(System.Single%2CSystem.Single)%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/ImGuiHelpers.cs/#L82">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Interface_ImGuiHelpers_ScaledRelativeSameLine_" data-uid="Dalamud.Interface.ImGuiHelpers.ScaledRelativeSameLine*"></a>
|
|
<h4 id="Dalamud_Interface_ImGuiHelpers_ScaledRelativeSameLine_System_Single_System_Single_" data-uid="Dalamud.Interface.ImGuiHelpers.ScaledRelativeSameLine(System.Single,System.Single)">ScaledRelativeSameLine(Single, Single)</h4>
|
|
<div class="markdown level1 summary"><p>Use a relative ImGui.SameLine() from your current cursor position, scaled by the Dalamud global scale.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static void ScaledRelativeSameLine(float offset, float spacing = -1F)</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.Single</span></td>
|
|
<td><span class="parametername">offset</span></td>
|
|
<td><p>The offset from your current cursor position.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Single</span></td>
|
|
<td><span class="parametername">spacing</span></td>
|
|
<td><p>The spacing to use.</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_ImGuiHelpers_ScaledVector2_System_Single_.md&value=---%0Auid%3A%20Dalamud.Interface.ImGuiHelpers.ScaledVector2(System.Single)%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/ImGuiHelpers.cs/#L33">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Interface_ImGuiHelpers_ScaledVector2_" data-uid="Dalamud.Interface.ImGuiHelpers.ScaledVector2*"></a>
|
|
<h4 id="Dalamud_Interface_ImGuiHelpers_ScaledVector2_System_Single_" data-uid="Dalamud.Interface.ImGuiHelpers.ScaledVector2(System.Single)">ScaledVector2(Single)</h4>
|
|
<div class="markdown level1 summary"><p>Gets a <span class="xref">System.Numerics.Vector2</span> that is pre-scaled with the <a class="xref" href="Dalamud.Interface.ImGuiHelpers.html#Dalamud_Interface_ImGuiHelpers_GlobalScale">GlobalScale</a> multiplier.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static Vector2 ScaledVector2(float x)</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.Single</span></td>
|
|
<td><span class="parametername">x</span></td>
|
|
<td><p>Vector2 X/Y parameter.</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><span class="xref">System.Numerics.Vector2</span></td>
|
|
<td><p>A scaled Vector2.</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_ImGuiHelpers_ScaledVector2_System_Single_System_Single_.md&value=---%0Auid%3A%20Dalamud.Interface.ImGuiHelpers.ScaledVector2(System.Single%2CSystem.Single)%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/ImGuiHelpers.cs/#L41">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Interface_ImGuiHelpers_ScaledVector2_" data-uid="Dalamud.Interface.ImGuiHelpers.ScaledVector2*"></a>
|
|
<h4 id="Dalamud_Interface_ImGuiHelpers_ScaledVector2_System_Single_System_Single_" data-uid="Dalamud.Interface.ImGuiHelpers.ScaledVector2(System.Single,System.Single)">ScaledVector2(Single, Single)</h4>
|
|
<div class="markdown level1 summary"><p>Gets a <span class="xref">System.Numerics.Vector2</span> that is pre-scaled with the <a class="xref" href="Dalamud.Interface.ImGuiHelpers.html#Dalamud_Interface_ImGuiHelpers_GlobalScale">GlobalScale</a> multiplier.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static Vector2 ScaledVector2(float x, float y)</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.Single</span></td>
|
|
<td><span class="parametername">x</span></td>
|
|
<td><p>Vector2 X parameter.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Single</span></td>
|
|
<td><span class="parametername">y</span></td>
|
|
<td><p>Vector2 Y parameter.</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><span class="xref">System.Numerics.Vector2</span></td>
|
|
<td><p>A scaled Vector2.</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_ImGuiHelpers_ScaledVector4_System_Single_System_Single_System_Single_System_Single_.md&value=---%0Auid%3A%20Dalamud.Interface.ImGuiHelpers.ScaledVector4(System.Single%2CSystem.Single%2CSystem.Single%2CSystem.Single)%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/ImGuiHelpers.cs/#L51">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Interface_ImGuiHelpers_ScaledVector4_" data-uid="Dalamud.Interface.ImGuiHelpers.ScaledVector4*"></a>
|
|
<h4 id="Dalamud_Interface_ImGuiHelpers_ScaledVector4_System_Single_System_Single_System_Single_System_Single_" data-uid="Dalamud.Interface.ImGuiHelpers.ScaledVector4(System.Single,System.Single,System.Single,System.Single)">ScaledVector4(Single, Single, Single, Single)</h4>
|
|
<div class="markdown level1 summary"><p>Gets a <span class="xref">System.Numerics.Vector4</span> that is pre-scaled with the <a class="xref" href="Dalamud.Interface.ImGuiHelpers.html#Dalamud_Interface_ImGuiHelpers_GlobalScale">GlobalScale</a> multiplier.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static Vector4 ScaledVector4(float x, float y, float z, float w)</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.Single</span></td>
|
|
<td><span class="parametername">x</span></td>
|
|
<td><p>Vector4 X parameter.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Single</span></td>
|
|
<td><span class="parametername">y</span></td>
|
|
<td><p>Vector4 Y parameter.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Single</span></td>
|
|
<td><span class="parametername">z</span></td>
|
|
<td><p>Vector4 Z parameter.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Single</span></td>
|
|
<td><span class="parametername">w</span></td>
|
|
<td><p>Vector4 W parameter.</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><span class="xref">System.Numerics.Vector4</span></td>
|
|
<td><p>A scaled Vector2.</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_ImGuiHelpers_SetNextWindowPosRelativeMainViewport_System_Numerics_Vector2_ImGuiNET_ImGuiCond_System_Numerics_Vector2_.md&value=---%0Auid%3A%20Dalamud.Interface.ImGuiHelpers.SetNextWindowPosRelativeMainViewport(System.Numerics.Vector2%2CImGuiNET.ImGuiCond%2CSystem.Numerics.Vector2)%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/ImGuiHelpers.cs/#L91">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Interface_ImGuiHelpers_SetNextWindowPosRelativeMainViewport_" data-uid="Dalamud.Interface.ImGuiHelpers.SetNextWindowPosRelativeMainViewport*"></a>
|
|
<h4 id="Dalamud_Interface_ImGuiHelpers_SetNextWindowPosRelativeMainViewport_System_Numerics_Vector2_ImGuiNET_ImGuiCond_System_Numerics_Vector2_" data-uid="Dalamud.Interface.ImGuiHelpers.SetNextWindowPosRelativeMainViewport(System.Numerics.Vector2,ImGuiNET.ImGuiCond,System.Numerics.Vector2)">SetNextWindowPosRelativeMainViewport(Vector2, ImGuiCond, Vector2)</h4>
|
|
<div class="markdown level1 summary"><p>Set the position of the next window relative to the main viewport.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static void SetNextWindowPosRelativeMainViewport(Vector2 position, ImGuiCond condition = ImGuiCond.None, Vector2 pivot = default(Vector2))</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.Numerics.Vector2</span></td>
|
|
<td><span class="parametername">position</span></td>
|
|
<td><p>The position of the next window.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="ImGuiNET.ImGuiCond.html">ImGuiCond</a></td>
|
|
<td><span class="parametername">condition</span></td>
|
|
<td><p>When to set the position.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Numerics.Vector2</span></td>
|
|
<td><span class="parametername">pivot</span></td>
|
|
<td><p>The pivot to set the position around.</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_ImGuiHelpers_SetWindowPosRelativeMainViewport_System_String_System_Numerics_Vector2_ImGuiNET_ImGuiCond_.md&value=---%0Auid%3A%20Dalamud.Interface.ImGuiHelpers.SetWindowPosRelativeMainViewport(System.String%2CSystem.Numerics.Vector2%2CImGuiNET.ImGuiCond)%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/ImGuiHelpers.cs/#L100">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Interface_ImGuiHelpers_SetWindowPosRelativeMainViewport_" data-uid="Dalamud.Interface.ImGuiHelpers.SetWindowPosRelativeMainViewport*"></a>
|
|
<h4 id="Dalamud_Interface_ImGuiHelpers_SetWindowPosRelativeMainViewport_System_String_System_Numerics_Vector2_ImGuiNET_ImGuiCond_" data-uid="Dalamud.Interface.ImGuiHelpers.SetWindowPosRelativeMainViewport(System.String,System.Numerics.Vector2,ImGuiNET.ImGuiCond)">SetWindowPosRelativeMainViewport(String, Vector2, ImGuiCond)</h4>
|
|
<div class="markdown level1 summary"><p>Set the position of a window relative to the main viewport.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static void SetWindowPosRelativeMainViewport(string name, Vector2 position, ImGuiCond condition = ImGuiCond.None)</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">name</span></td>
|
|
<td><p>The name/ID of the window.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Numerics.Vector2</span></td>
|
|
<td><span class="parametername">position</span></td>
|
|
<td><p>The position of the window.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="ImGuiNET.ImGuiCond.html">ImGuiCond</a></td>
|
|
<td><span class="parametername">condition</span></td>
|
|
<td><p>When to set the position.</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_ImGuiHelpers_VirtualKeyToImGuiKey_Dalamud_Game_ClientState_Keys_VirtualKey_.md&value=---%0Auid%3A%20Dalamud.Interface.ImGuiHelpers.VirtualKeyToImGuiKey(Dalamud.Game.ClientState.Keys.VirtualKey)%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/ImGuiHelpers.cs/#L232">View Source</a>
|
|
</span>
|
|
<a id="Dalamud_Interface_ImGuiHelpers_VirtualKeyToImGuiKey_" data-uid="Dalamud.Interface.ImGuiHelpers.VirtualKeyToImGuiKey*"></a>
|
|
<h4 id="Dalamud_Interface_ImGuiHelpers_VirtualKeyToImGuiKey_Dalamud_Game_ClientState_Keys_VirtualKey_" data-uid="Dalamud.Interface.ImGuiHelpers.VirtualKeyToImGuiKey(Dalamud.Game.ClientState.Keys.VirtualKey)">VirtualKeyToImGuiKey(VirtualKey)</h4>
|
|
<div class="markdown level1 summary"><p>Map a VirtualKey keycode to an ImGuiKey enum value.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static ImGuiKey VirtualKeyToImGuiKey(VirtualKey key)</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.Game.ClientState.Keys.VirtualKey.html">VirtualKey</a></td>
|
|
<td><span class="parametername">key</span></td>
|
|
<td><p>The VirtualKey value to retrieve the ImGuiKey counterpart for.</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="ImGuiNET.ImGuiKey.html">ImGuiKey</a></td>
|
|
<td><p>The ImGuiKey that corresponds to this VirtualKey, or <code>ImGuiKey.None</code> otherwise.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</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_ImGuiHelpers.md&value=---%0Auid%3A%20Dalamud.Interface.ImGuiHelpers%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/ImGuiHelpers.cs/#L16" 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>
|