Dalamud/docs/api/ImGuiScene.WindowCreateInfo.html
2021-04-07 20:41:53 +02:00

371 lines
17 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 WindowCreateInfo
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class WindowCreateInfo
">
<meta name="generator" content="docfx 2.56.6.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="ImGuiScene.WindowCreateInfo">
<h1 id="ImGuiScene_WindowCreateInfo" data-uid="ImGuiScene.WindowCreateInfo" class="text-break">Class WindowCreateInfo
</h1>
<div class="markdown level0 summary"><p>Simple wrapper for information necessary to create an application window</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">WindowCreateInfo</span></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<span class="xref">System.Object.ToString()</span>
</div>
<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.ReferenceEquals(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>
<h6><strong>Namespace</strong>: <a class="xref" href="ImGuiScene.html">ImGuiScene</a></h6>
<h6><strong>Assembly</strong>: ImGuiScene.dll</h6>
<h5 id="ImGuiScene_WindowCreateInfo_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class WindowCreateInfo</code></pre>
</div>
<h3 id="fields">Fields
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/ImGuiScene/new/020033197d6802f64c794d8a44029bd75662ad33/apiSpec/new?filename=ImGuiScene_WindowCreateInfo_Fullscreen.md&amp;value=---%0Auid%3A%20ImGuiScene.WindowCreateInfo.Fullscreen%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/ImGuiScene/blob/020033197d6802f64c794d8a44029bd75662ad33/ImGuiScene/Windowing/WindowFactory.cs/#L35">View Source</a>
</span>
<h4 id="ImGuiScene_WindowCreateInfo_Fullscreen" data-uid="ImGuiScene.WindowCreateInfo.Fullscreen">Fullscreen</h4>
<div class="markdown level1 summary"><p>Whether the window should be created fullscreen. This is a borderless windowed mode and will not affect desktop resolution.
Fullscreen windows are &quot;always on top&quot;.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool Fullscreen</code></pre>
</div>
<h5 class="fieldValue">Field 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/ImGuiScene/new/020033197d6802f64c794d8a44029bd75662ad33/apiSpec/new?filename=ImGuiScene_WindowCreateInfo_Height.md&amp;value=---%0Auid%3A%20ImGuiScene.WindowCreateInfo.Height%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/ImGuiScene/blob/020033197d6802f64c794d8a44029bd75662ad33/ImGuiScene/Windowing/WindowFactory.cs/#L30">View Source</a>
</span>
<h4 id="ImGuiScene_WindowCreateInfo_Height" data-uid="ImGuiScene.WindowCreateInfo.Height">Height</h4>
<div class="markdown level1 summary"><p>The height of the window. Ignored for fullscreen windows.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int Height</code></pre>
</div>
<h5 class="fieldValue">Field 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.Int32</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/ImGuiScene/new/020033197d6802f64c794d8a44029bd75662ad33/apiSpec/new?filename=ImGuiScene_WindowCreateInfo_Title.md&amp;value=---%0Auid%3A%20ImGuiScene.WindowCreateInfo.Title%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/ImGuiScene/blob/020033197d6802f64c794d8a44029bd75662ad33/ImGuiScene/Windowing/WindowFactory.cs/#L14">View Source</a>
</span>
<h4 id="ImGuiScene_WindowCreateInfo_Title" data-uid="ImGuiScene.WindowCreateInfo.Title">Title</h4>
<div class="markdown level1 summary"><p>The window title. This will not be visible for fullscreen windows except in things like task manager.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string Title</code></pre>
</div>
<h5 class="fieldValue">Field 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.String</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/ImGuiScene/new/020033197d6802f64c794d8a44029bd75662ad33/apiSpec/new?filename=ImGuiScene_WindowCreateInfo_TransparentColor.md&amp;value=---%0Auid%3A%20ImGuiScene.WindowCreateInfo.TransparentColor%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/ImGuiScene/blob/020033197d6802f64c794d8a44029bd75662ad33/ImGuiScene/Windowing/WindowFactory.cs/#L41">View Source</a>
</span>
<h4 id="ImGuiScene_WindowCreateInfo_TransparentColor" data-uid="ImGuiScene.WindowCreateInfo.TransparentColor">TransparentColor</h4>
<div class="markdown level1 summary"><p>An optional float[4] color key used to make any matching portion of the window's client area transparent. For example, setting this to magenta will
then make any area where you render magenta instead be fully transparent to the window(s) behind this one.
Values are red, green, blue from 0 to 1.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public float[] TransparentColor</code></pre>
</div>
<h5 class="fieldValue">Field 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/ImGuiScene/new/020033197d6802f64c794d8a44029bd75662ad33/apiSpec/new?filename=ImGuiScene_WindowCreateInfo_Width.md&amp;value=---%0Auid%3A%20ImGuiScene.WindowCreateInfo.Width%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/ImGuiScene/blob/020033197d6802f64c794d8a44029bd75662ad33/ImGuiScene/Windowing/WindowFactory.cs/#L26">View Source</a>
</span>
<h4 id="ImGuiScene_WindowCreateInfo_Width" data-uid="ImGuiScene.WindowCreateInfo.Width">Width</h4>
<div class="markdown level1 summary"><p>The width of the window. Ignored for fullscreen windows.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int Width</code></pre>
</div>
<h5 class="fieldValue">Field 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.Int32</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/ImGuiScene/new/020033197d6802f64c794d8a44029bd75662ad33/apiSpec/new?filename=ImGuiScene_WindowCreateInfo_XPos.md&amp;value=---%0Auid%3A%20ImGuiScene.WindowCreateInfo.XPos%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/ImGuiScene/blob/020033197d6802f64c794d8a44029bd75662ad33/ImGuiScene/Windowing/WindowFactory.cs/#L18">View Source</a>
</span>
<h4 id="ImGuiScene_WindowCreateInfo_XPos" data-uid="ImGuiScene.WindowCreateInfo.XPos">XPos</h4>
<div class="markdown level1 summary"><p>The x location of the top left corner of the window. Ignored for fullscreen windows.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int XPos</code></pre>
</div>
<h5 class="fieldValue">Field 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.Int32</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/ImGuiScene/new/020033197d6802f64c794d8a44029bd75662ad33/apiSpec/new?filename=ImGuiScene_WindowCreateInfo_YPos.md&amp;value=---%0Auid%3A%20ImGuiScene.WindowCreateInfo.YPos%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/ImGuiScene/blob/020033197d6802f64c794d8a44029bd75662ad33/ImGuiScene/Windowing/WindowFactory.cs/#L22">View Source</a>
</span>
<h4 id="ImGuiScene_WindowCreateInfo_YPos" data-uid="ImGuiScene.WindowCreateInfo.YPos">YPos</h4>
<div class="markdown level1 summary"><p>The y location of the top left corner of the window. Ignored for fullscreen windows.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int YPos</code></pre>
</div>
<h5 class="fieldValue">Field 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.Int32</span></td>
<td></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/ImGuiScene/new/020033197d6802f64c794d8a44029bd75662ad33/apiSpec/new?filename=ImGuiScene_WindowCreateInfo.md&amp;value=---%0Auid%3A%20ImGuiScene.WindowCreateInfo%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/ImGuiScene/blob/020033197d6802f64c794d8a44029bd75662ad33/ImGuiScene/Windowing/WindowFactory.cs/#L9" 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>