ToxicMushroom/Dalamud
1
0
Fork 0
mirror of https://github.com/goatcorp/Dalamud.git synced 2025-12-12 18:27:23 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 3
Dalamud/docs/api/ImGuiScene.html
goat 6fd636c26c
docs: regenerate
2022-10-29 15:34:04 +02:00

205 lines
10 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Namespace ImGuiScene
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Namespace ImGuiScene
">
<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="ImGuiScene">
<h1 id="ImGuiScene" data-uid="ImGuiScene" class="text-break">Namespace ImGuiScene
</h1>
<div class="markdown level0 summary"></div>
<div class="markdown level0 conceptual"></div>
<div class="markdown level0 remarks"></div>
<h3 id="classes">Classes
</h3>
<h4><a class="xref" href="ImGuiScene.FramerateLimit.html">FramerateLimit</a></h4>
<section><p>Simple encapsulation of framerate limiting behavior, allowing for fully unbounded (no control),
Vsync-enabled (sync to monitor refresh), or a specified fixed framerate (vsync disabled, hard time cap)</p>
</section>
<h4><a class="xref" href="ImGuiScene.GLTextureWrap.html">GLTextureWrap</a></h4>
<section><p>OpenGL 3 Implementation of <a class="xref" href="ImGuiScene.TextureWrap.html">TextureWrap</a>.
Provides a simple wrapped view of the disposeable resource as well as the handle for ImGui.</p>
</section>
<h4><a class="xref" href="ImGuiScene.ImGui_Impl_DX11.html">ImGui_Impl_DX11</a></h4>
<section><p>Currently undocumented because it is a horrible mess.
A near-direct port of <a href="https://github.com/ocornut/imgui/blob/master/examples/imgui_impl_dx11.cpp">https://github.com/ocornut/imgui/blob/master/examples/imgui_impl_dx11.cpp</a>
State backup follows the general layout of imgui's sample (which is a mess), but has been rather
expanded to cover the vast majority of render state, following the example here
<a href="https://github.com/GPUOpen-LibrariesAndSDKs/CrossfireAPI11/blob/master/amd_lib/src/AMD_SaveRestoreState.cpp">https://github.com/GPUOpen-LibrariesAndSDKs/CrossfireAPI11/blob/master/amd_lib/src/AMD_SaveRestoreState.cpp</a>
Would be nice to organize it better, but it seems to work</p>
</section>
<h4><a class="xref" href="ImGuiScene.ImGui_Impl_OpenGL3.html">ImGui_Impl_OpenGL3</a></h4>
<section><p>Currently undocumented because it is a horrible mess.
A near-direct port of <a href="https://github.com/ocornut/imgui/blob/master/examples/imgui_impl_opengl3.cpp">https://github.com/ocornut/imgui/blob/master/examples/imgui_impl_opengl3.cpp</a>
State backup IS done for this renderer, because SDL does not play nicely when using OpenGL.</p>
</section>
<h4><a class="xref" href="ImGuiScene.ImGui_Impl_SDL.html">ImGui_Impl_SDL</a></h4>
<section><p>Currently undocumented because it is a horrible mess.
A near-direct port of <a href="https://github.com/ocornut/imgui/blob/master/examples/imgui_impl_sdl.cpp">https://github.com/ocornut/imgui/blob/master/examples/imgui_impl_sdl.cpp</a></p>
</section>
<h4><a class="xref" href="ImGuiScene.ImGui_Input_Impl_Direct.html">ImGui_Input_Impl_Direct</a></h4>
<section></section>
<h4><a class="xref" href="ImGuiScene.MemUtil.html">MemUtil</a></h4>
<section></section>
<h4><a class="xref" href="ImGuiScene.RawDX11Scene.html">RawDX11Scene</a></h4>
<section></section>
<h4><a class="xref" href="ImGuiScene.RendererFactory.html">RendererFactory</a></h4>
<section><p>Simple factory to create a renderer for a given backend API/version/etc.</p>
</section>
<h4><a class="xref" href="ImGuiScene.SDLWindowGL.html">SDLWindowGL</a></h4>
<section><p>OpenGL specialization of SimpleSDLWindow, for setting up additional necessary states during window creation.</p>
</section>
<h4><a class="xref" href="ImGuiScene.SimpleD3D.html">SimpleD3D</a></h4>
<section><p>A simple wrapper for a minimal DirectX 11 renderer. Consumers of this class will need to implement all actual pipeline and render logic externally.</p>
</section>
<h4><a class="xref" href="ImGuiScene.SimpleImGuiScene.html">SimpleImGuiScene</a></h4>
<section><p>Simple class to wrap everything necessary to use ImGui inside a window.
Currently this always creates a new window rather than take ownership of an existing one.</p>
<p>Internally this uses SDL and DirectX 11 or OpenGL 3.2. Rendering is tied to vsync.</p>
</section>
<h4><a class="xref" href="ImGuiScene.SimpleOGL3.html">SimpleOGL3</a></h4>
<section><p>A simple wrapper for a minimal OpenGL 3.2 renderer. Consumers of this class will need to implement all actual pipeline and render logic externally.</p>
</section>
<h4><a class="xref" href="ImGuiScene.SimpleSDLWindow.html">SimpleSDLWindow</a></h4>
<section><p>A very basic SDL wrapper to handle creating a window and processing SDL events.</p>
</section>
<h4><a class="xref" href="ImGuiScene.WindowCreateInfo.html">WindowCreateInfo</a></h4>
<section><p>Simple wrapper for information necessary to create an application window</p>
</section>
<h4><a class="xref" href="ImGuiScene.WindowFactory.html">WindowFactory</a></h4>
<section><p>Factory used to create a SimpleSDLWindow set up to work with the selected renderer.</p>
</section>
<h3 id="interfaces">Interfaces
</h3>
<h4><a class="xref" href="ImGuiScene.IImGuiInputHandler.html">IImGuiInputHandler</a></h4>
<section></section>
<h4><a class="xref" href="ImGuiScene.IImGuiRenderer.html">IImGuiRenderer</a></h4>
<section><p>A simple shared public interface that all ImGui render implementations follow.</p>
</section>
<h4><a class="xref" href="ImGuiScene.IRenderer.html">IRenderer</a></h4>
<section><p>Abstraction for a simple renderer that can be used with ImGui</p>
</section>
<h4><a class="xref" href="ImGuiScene.TextureWrap.html">TextureWrap</a></h4>
<section><p>Simple wrapper to handle texture resources from different APIs, while accounting for resource freeing and ImGui interaction.</p>
</section>
<h3 id="enums">Enums
</h3>
<h4><a class="xref" href="ImGuiScene.FramerateLimit.LimitType.html">FramerateLimit.LimitType</a></h4>
<section><p>The different methods of limiting framerate.</p>
</section>
<h4><a class="xref" href="ImGuiScene.RendererFactory.RendererBackend.html">RendererFactory.RendererBackend</a></h4>
<section></section>
<h3 id="delegates">Delegates
</h3>
<h4><a class="xref" href="ImGuiScene.RawDX11Scene.BuildUIDelegate.html">RawDX11Scene.BuildUIDelegate</a></h4>
<section></section>
<h4><a class="xref" href="ImGuiScene.RawDX11Scene.NewInputFrameDelegate.html">RawDX11Scene.NewInputFrameDelegate</a></h4>
<section></section>
<h4><a class="xref" href="ImGuiScene.RawDX11Scene.NewRenderFrameDelegate.html">RawDX11Scene.NewRenderFrameDelegate</a></h4>
<section></section>
<h4><a class="xref" href="ImGuiScene.SimpleImGuiScene.BuildUIDelegate.html">SimpleImGuiScene.BuildUIDelegate</a></h4>
<section></section>
<h4><a class="xref" href="ImGuiScene.SimpleSDLWindow.ProcessEventDelegate.html">SimpleSDLWindow.ProcessEventDelegate</a></h4>
<section></section>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
</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>
Reference in a new issue View git blame Copy permalink