mirror of
https://github.com/goatcorp/Dalamud.git
synced 2025-12-12 10:17:22 +01:00
585 lines
28 KiB
HTML
585 lines
28 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 SimpleSDLWindow
|
|
</title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="Class SimpleSDLWindow
|
|
">
|
|
<meta name="generator" content="docfx 2.58.0.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.SimpleSDLWindow">
|
|
|
|
|
|
<h1 id="ImGuiScene_SimpleSDLWindow" data-uid="ImGuiScene.SimpleSDLWindow" class="text-break">Class SimpleSDLWindow
|
|
</h1>
|
|
<div class="markdown level0 summary"><p>A very basic SDL wrapper to handle creating a window and processing SDL events.</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">SimpleSDLWindow</span></div>
|
|
<div class="level2"><a class="xref" href="ImGuiScene.SDLWindowGL.html">SDLWindowGL</a></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="ImGuiScene.html">ImGuiScene</a></h6>
|
|
<h6><strong>Assembly</strong>: ImGuiScene.dll</h6>
|
|
<h5 id="ImGuiScene_SimpleSDLWindow_syntax">Syntax</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public class SimpleSDLWindow : IDisposable</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/master/apiSpec/new?filename=ImGuiScene_SimpleSDLWindow_Gl.md&value=---%0Auid%3A%20ImGuiScene.SimpleSDLWindow.Gl%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/master/ImGuiScene/Windowing/SimpleSDLWindow.cs/#L13">View Source</a>
|
|
</span>
|
|
<h4 id="ImGuiScene_SimpleSDLWindow_Gl" data-uid="ImGuiScene.SimpleSDLWindow.Gl">Gl</h4>
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">protected static readonly GL Gl</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">Silk.NET.OpenGL.GL</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="properties">Properties
|
|
</h3>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/ImGuiScene/new/master/apiSpec/new?filename=ImGuiScene_SimpleSDLWindow_OnSDLEvent.md&value=---%0Auid%3A%20ImGuiScene.SimpleSDLWindow.OnSDLEvent%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/master/ImGuiScene/Windowing/SimpleSDLWindow.cs/#L51">View Source</a>
|
|
</span>
|
|
<a id="ImGuiScene_SimpleSDLWindow_OnSDLEvent_" data-uid="ImGuiScene.SimpleSDLWindow.OnSDLEvent*"></a>
|
|
<h4 id="ImGuiScene_SimpleSDLWindow_OnSDLEvent" data-uid="ImGuiScene.SimpleSDLWindow.OnSDLEvent">OnSDLEvent</h4>
|
|
<div class="markdown level1 summary"><p>Delegate for providing user event handler methods that want to respond to SDL_Events.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public SimpleSDLWindow.ProcessEventDelegate OnSDLEvent { 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><a class="xref" href="ImGuiScene.SimpleSDLWindow.ProcessEventDelegate.html">SimpleSDLWindow.ProcessEventDelegate</a></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/master/apiSpec/new?filename=ImGuiScene_SimpleSDLWindow_WantsClose.md&value=---%0Auid%3A%20ImGuiScene.SimpleSDLWindow.WantsClose%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/master/ImGuiScene/Windowing/SimpleSDLWindow.cs/#L46">View Source</a>
|
|
</span>
|
|
<a id="ImGuiScene_SimpleSDLWindow_WantsClose_" data-uid="ImGuiScene.SimpleSDLWindow.WantsClose*"></a>
|
|
<h4 id="ImGuiScene_SimpleSDLWindow_WantsClose" data-uid="ImGuiScene.SimpleSDLWindow.WantsClose">WantsClose</h4>
|
|
<div class="markdown level1 summary"><p>Whether an event has closed this window.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public bool WantsClose { 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/ImGuiScene/new/master/apiSpec/new?filename=ImGuiScene_SimpleSDLWindow_Window.md&value=---%0Auid%3A%20ImGuiScene.SimpleSDLWindow.Window%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/master/ImGuiScene/Windowing/SimpleSDLWindow.cs/#L41">View Source</a>
|
|
</span>
|
|
<a id="ImGuiScene_SimpleSDLWindow_Window_" data-uid="ImGuiScene.SimpleSDLWindow.Window*"></a>
|
|
<h4 id="ImGuiScene_SimpleSDLWindow_Window" data-uid="ImGuiScene.SimpleSDLWindow.Window">Window</h4>
|
|
<div class="markdown level1 summary"><p>The SDL_Window pointer for this window.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public IntPtr Window { 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/ImGuiScene/new/master/apiSpec/new?filename=ImGuiScene_SimpleSDLWindow_CreateColorKey_System_Single_System_Single_System_Single_.md&value=---%0Auid%3A%20ImGuiScene.SimpleSDLWindow.CreateColorKey(System.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/ImGuiScene/blob/master/ImGuiScene/Windowing/SimpleSDLWindow.cs/#L31">View Source</a>
|
|
</span>
|
|
<a id="ImGuiScene_SimpleSDLWindow_CreateColorKey_" data-uid="ImGuiScene.SimpleSDLWindow.CreateColorKey*"></a>
|
|
<h4 id="ImGuiScene_SimpleSDLWindow_CreateColorKey_System_Single_System_Single_System_Single_" data-uid="ImGuiScene.SimpleSDLWindow.CreateColorKey(System.Single,System.Single,System.Single)">CreateColorKey(Single, Single, Single)</h4>
|
|
<div class="markdown level1 summary"><p>Creates a color key for use as a mask for <a class="xref" href="ImGuiScene.SimpleSDLWindow.html#ImGuiScene_SimpleSDLWindow_MakeTransparent_System_UInt32_">MakeTransparent(UInt32)</a></p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public static uint CreateColorKey(float r, float g, float b)</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">r</span></td>
|
|
<td><p>The red component of the mask color (0-1)</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Single</span></td>
|
|
<td><span class="parametername">g</span></td>
|
|
<td><p>The green component of the mask color (0-1)</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.Single</span></td>
|
|
<td><span class="parametername">b</span></td>
|
|
<td><p>The blue component of the mask color (0-1)</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.UInt32</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/master/apiSpec/new?filename=ImGuiScene_SimpleSDLWindow_Dispose.md&value=---%0Auid%3A%20ImGuiScene.SimpleSDLWindow.Dispose%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/goatcorp/ImGuiScene/blob/master/ImGuiScene/Windowing/SimpleSDLWindow.cs/#L215">View Source</a>
|
|
</span>
|
|
<a id="ImGuiScene_SimpleSDLWindow_Dispose_" data-uid="ImGuiScene.SimpleSDLWindow.Dispose*"></a>
|
|
<h4 id="ImGuiScene_SimpleSDLWindow_Dispose" data-uid="ImGuiScene.SimpleSDLWindow.Dispose">Dispose()</h4>
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void Dispose()</code></pre>
|
|
</div>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/ImGuiScene/new/master/apiSpec/new?filename=ImGuiScene_SimpleSDLWindow_Dispose_System_Boolean_.md&value=---%0Auid%3A%20ImGuiScene.SimpleSDLWindow.Dispose(System.Boolean)%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/master/ImGuiScene/Windowing/SimpleSDLWindow.cs/#L188">View Source</a>
|
|
</span>
|
|
<a id="ImGuiScene_SimpleSDLWindow_Dispose_" data-uid="ImGuiScene.SimpleSDLWindow.Dispose*"></a>
|
|
<h4 id="ImGuiScene_SimpleSDLWindow_Dispose_System_Boolean_" data-uid="ImGuiScene.SimpleSDLWindow.Dispose(System.Boolean)">Dispose(Boolean)</h4>
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">protected virtual void Dispose(bool disposing)</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.Boolean</span></td>
|
|
<td><span class="parametername">disposing</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/master/apiSpec/new?filename=ImGuiScene_SimpleSDLWindow_Finalize.md&value=---%0Auid%3A%20ImGuiScene.SimpleSDLWindow.Finalize%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/master/ImGuiScene/Windowing/SimpleSDLWindow.cs/#L210">View Source</a>
|
|
</span>
|
|
<a id="ImGuiScene_SimpleSDLWindow_Finalize_" data-uid="ImGuiScene.SimpleSDLWindow.Finalize*"></a>
|
|
<h4 id="ImGuiScene_SimpleSDLWindow_Finalize" data-uid="ImGuiScene.SimpleSDLWindow.Finalize">Finalize()</h4>
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">protected void Finalize()</code></pre>
|
|
</div>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/ImGuiScene/new/master/apiSpec/new?filename=ImGuiScene_SimpleSDLWindow_GetHWnd.md&value=---%0Auid%3A%20ImGuiScene.SimpleSDLWindow.GetHWnd%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/master/ImGuiScene/Windowing/SimpleSDLWindow.cs/#L123">View Source</a>
|
|
</span>
|
|
<a id="ImGuiScene_SimpleSDLWindow_GetHWnd_" data-uid="ImGuiScene.SimpleSDLWindow.GetHWnd*"></a>
|
|
<h4 id="ImGuiScene_SimpleSDLWindow_GetHWnd" data-uid="ImGuiScene.SimpleSDLWindow.GetHWnd">GetHWnd()</h4>
|
|
<div class="markdown level1 summary"><p>Gets the HWND of this window for interop with Windows methods.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public IntPtr GetHWnd()</code></pre>
|
|
</div>
|
|
<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.IntPtr</span></td>
|
|
<td><p>This window's HWND</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/ImGuiScene/new/master/apiSpec/new?filename=ImGuiScene_SimpleSDLWindow_InitForRenderer_ImGuiScene_IRenderer_.md&value=---%0Auid%3A%20ImGuiScene.SimpleSDLWindow.InitForRenderer(ImGuiScene.IRenderer)%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/master/ImGuiScene/Windowing/SimpleSDLWindow.cs/#L90">View Source</a>
|
|
</span>
|
|
<a id="ImGuiScene_SimpleSDLWindow_InitForRenderer_" data-uid="ImGuiScene.SimpleSDLWindow.InitForRenderer*"></a>
|
|
<h4 id="ImGuiScene_SimpleSDLWindow_InitForRenderer_ImGuiScene_IRenderer_" data-uid="ImGuiScene.SimpleSDLWindow.InitForRenderer(ImGuiScene.IRenderer)">InitForRenderer(IRenderer)</h4>
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">protected virtual void InitForRenderer(IRenderer renderer)</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="ImGuiScene.IRenderer.html">IRenderer</a></td>
|
|
<td><span class="parametername">renderer</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/master/apiSpec/new?filename=ImGuiScene_SimpleSDLWindow_MakeTransparent_System_UInt32_.md&value=---%0Auid%3A%20ImGuiScene.SimpleSDLWindow.MakeTransparent(System.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/ImGuiScene/blob/master/ImGuiScene/Windowing/SimpleSDLWindow.cs/#L142">View Source</a>
|
|
</span>
|
|
<a id="ImGuiScene_SimpleSDLWindow_MakeTransparent_" data-uid="ImGuiScene.SimpleSDLWindow.MakeTransparent*"></a>
|
|
<h4 id="ImGuiScene_SimpleSDLWindow_MakeTransparent_System_UInt32_" data-uid="ImGuiScene.SimpleSDLWindow.MakeTransparent(System.UInt32)">MakeTransparent(UInt32)</h4>
|
|
<div class="markdown level1 summary"><p>Converts this to a layered window and makes any region that matches <code data-dev-comment-type="paramref" class="paramref">transparentColorKey</code> fully transparent.
|
|
Transparent regions behave as if they are not present, and can be clicked through etc.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">protected void MakeTransparent(uint transparentColorKey)</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.UInt32</span></td>
|
|
<td><span class="parametername">transparentColorKey</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 id="ImGuiScene_SimpleSDLWindow_MakeTransparent_System_UInt32__seealso">See Also</h5>
|
|
<div class="seealso">
|
|
<div><a class="xref" href="ImGuiScene.SimpleSDLWindow.html#ImGuiScene_SimpleSDLWindow_CreateColorKey_System_Single_System_Single_System_Single_">CreateColorKey(Single, Single, Single)</a></div>
|
|
</div>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/ImGuiScene/new/master/apiSpec/new?filename=ImGuiScene_SimpleSDLWindow_ProcessEvents.md&value=---%0Auid%3A%20ImGuiScene.SimpleSDLWindow.ProcessEvents%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/master/ImGuiScene/Windowing/SimpleSDLWindow.cs/#L161">View Source</a>
|
|
</span>
|
|
<a id="ImGuiScene_SimpleSDLWindow_ProcessEvents_" data-uid="ImGuiScene.SimpleSDLWindow.ProcessEvents*"></a>
|
|
<h4 id="ImGuiScene_SimpleSDLWindow_ProcessEvents" data-uid="ImGuiScene.SimpleSDLWindow.ProcessEvents">ProcessEvents()</h4>
|
|
<div class="markdown level1 summary"><p>Basic SDL event loop to consume all events and handle window closure.
|
|
User handlers from <a class="xref" href="ImGuiScene.SimpleSDLWindow.html#ImGuiScene_SimpleSDLWindow_OnSDLEvent">OnSDLEvent</a> are invoked for every event.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void ProcessEvents()</code></pre>
|
|
</div>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goatcorp/ImGuiScene/new/master/apiSpec/new?filename=ImGuiScene_SimpleSDLWindow_WindowCreationFlags_ImGuiScene_WindowCreateInfo_.md&value=---%0Auid%3A%20ImGuiScene.SimpleSDLWindow.WindowCreationFlags(ImGuiScene.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">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/goatcorp/ImGuiScene/blob/master/ImGuiScene/Windowing/SimpleSDLWindow.cs/#L100">View Source</a>
|
|
</span>
|
|
<a id="ImGuiScene_SimpleSDLWindow_WindowCreationFlags_" data-uid="ImGuiScene.SimpleSDLWindow.WindowCreationFlags*"></a>
|
|
<h4 id="ImGuiScene_SimpleSDLWindow_WindowCreationFlags_ImGuiScene_WindowCreateInfo_" data-uid="ImGuiScene.SimpleSDLWindow.WindowCreationFlags(ImGuiScene.WindowCreateInfo)">WindowCreationFlags(WindowCreateInfo)</h4>
|
|
<div class="markdown level1 summary"><p>Return the set of window flags necessary to create a window matching what is requested in <code data-dev-comment-type="paramref" class="paramref">createInfo</code></p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">protected virtual SDL.SDL_WindowFlags WindowCreationFlags(WindowCreateInfo createInfo)</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="ImGuiScene.WindowCreateInfo.html">WindowCreateInfo</a></td>
|
|
<td><span class="parametername">createInfo</span></td>
|
|
<td><p>The requested creation parameters for the window.</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="SDL2.SDL.SDL_WindowFlags.html">SDL.SDL_WindowFlags</a></td>
|
|
<td><p>The full set of SDL_WindowFlags to use when creating this window.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<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/ImGuiScene/new/master/apiSpec/new?filename=ImGuiScene_SimpleSDLWindow.md&value=---%0Auid%3A%20ImGuiScene.SimpleSDLWindow%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/master/ImGuiScene/Windowing/SimpleSDLWindow.cs/#L11" 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>
|