build based on 38eadb5

Gnimuc · Jul 29, 2024 · 014baea · 014baea
1 parent 0ba5fab
commit 014baea
Show file tree

Hide file tree

Showing 9 changed files with 44 additions and 42 deletions.
diff --git a/dev/.documenter-siteinfo.json b/dev/.documenter-siteinfo.json
@@ -1 +1 @@
-{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-07-20T10:47:32","documenter_version":"1.5.0"}}
+{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-07-29T11:52:44","documenter_version":"1.5.0"}}
diff --git a/dev/_changelog/index.html b/dev/_changelog/index.html
diff --git a/dev/api/index.html b/dev/api/index.html
diff --git a/dev/backends/index.html b/dev/backends/index.html
diff --git a/dev/changelog/index.html b/dev/changelog/index.html
diff --git a/dev/index.html b/dev/index.html
diff --git a/dev/makie/index.html b/dev/makie/index.html
@@ -0,0 +1,2 @@
+<!DOCTYPE html>
+<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Makie integration · CImGui.jl</title><meta name="title" content="Makie integration · CImGui.jl"/><meta property="og:title" content="Makie integration · CImGui.jl"/><meta property="twitter:title" content="Makie integration · CImGui.jl"/><meta name="description" content="Documentation for CImGui.jl."/><meta property="og:description" content="Documentation for CImGui.jl."/><meta property="twitter:description" content="Documentation for CImGui.jl."/><meta property="og:url" content="https://Gnimuc.github.io/CImGui.jl/makie/"/><meta property="twitter:url" content="https://Gnimuc.github.io/CImGui.jl/makie/"/><link rel="canonical" href="https://Gnimuc.github.io/CImGui.jl/makie/"/><script data-outdated-warner src="../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../search_index.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../">CImGui.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../">CImGui</a></li><li><a class="tocitem" href="../api/">API Reference</a></li><li><a class="tocitem" href="../backends/">Backends</a></li><li class="is-active"><a class="tocitem" href>Makie integration</a></li><li><a class="tocitem" href="../changelog/">Changelog</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Makie integration</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Makie integration</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/Gnimuc/CImGui.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/Gnimuc/CImGui.jl/blob/master/docs/src/makie.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Makie-integration"><a class="docs-heading-anchor" href="#Makie-integration">Makie integration</a><a id="Makie-integration-1"></a><a class="docs-heading-anchor-permalink" href="#Makie-integration" title="Permalink"></a></h1><p>We currently have <em>very experimental</em> <a href="https://docs.makie.org/stable">Makie</a> support through <a href="https://docs.makie.org/stable/explanations/backends/glmakie">GLMakie</a>. GLMakie mostly works around a <code>Screen{T}</code> object to display a scene, where <code>T</code> is some OpenGL-supporting window. GLMakie sets this to a <code>GLFW.Window</code>, but we&#39;ve made a custom window type to represent a single <code>Figure</code> to be drawn in ImGui. What we get from GLMakie is a framebuffer with a color image texture attachment, and that&#39;s displayed by us as an image.</p><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="CImGui.MakieFigure" href="#CImGui.MakieFigure"><code>CImGui.MakieFigure</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">MakieFigure(id::String, f::GLMakie.Figure; auto_resize_x=true, auto_resize_y=false)</code></pre><p>Display a Makie figure in ImGui. See <code>examples/makie_demo.jl</code> for an example of how to use it. This supports all the interaction features in GLMakie:</p><ul><li>Scrolling to zoom</li><li>Rectangle select to zoom</li><li>RMB to pan</li></ul><p>Note that scrolling to zoom will also cause the ImGui window to scroll, which can be annoying. This may be fixed in the future by using some other key combination for scrolling to zoom.</p><p>These are the <a href="https://docs.makie.org/stable/explanations/events#The-Events-struct">interaction events</a> that are wired up and can be used:</p><ul><li><code>hasfocus</code></li><li><code>entered_window</code></li><li><code>mousebutton</code></li><li><code>mouseposition</code></li></ul><p>Known issues:</p><ul><li>Changing tick labels don&#39;t trigger the scene to be re-layouted, causing them to be clipped if the labels change width. See <code>examples/makie_demo.jl</code> for an example workaround using <code>Makie.tight_ticklabel_spacing!()</code>.</li><li>The theming doesn&#39;t match the ImGui theme so plots look quite out of place by default.</li><li>Mouse events aren&#39;t delivered unless the mouse is hovered over the figure, so dragging the mouse from within the figure to somewhere outside the figure will keep the old mouse state. e.g. if you&#39;re RMB panning and the mouse goes outside the figure, when it enters the figure again panning will resume even the RMB was released.</li></ul><div class="admonition is-warning"><header class="admonition-header">Warning</header><div class="admonition-body"><p>This is very experimental, you will almost definitely encounter bugs (and if so please submit an issue/PR). We don&#39;t consider this covered under semver yet so there may be breaking changes in minor releases.</p></div></div></div><a class="docs-sourcelink" target="_blank" href="https://github.com/Gnimuc/CImGui.jl/blob/38eadb54028c1246f4caa858072f12c1e0ceac4d/src/CImGui.jl#L70-L107">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../backends/">« Backends</a><a class="docs-footer-nextpage" href="../changelog/">Changelog »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.5.0 on <span class="colophon-date" title="Monday 29 July 2024 11:52">Monday 29 July 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
diff --git a/dev/objects.inv b/dev/objects.inv
diff --git a/dev/search_index.js b/dev/search_index.js
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-07-20T10:47:32","documenter_version":"1.5.0"}}
		{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-07-29T11:52:44","documenter_version":"1.5.0"}}
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		<!DOCTYPE html>
		<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Makie integration · CImGui.jl</title><meta name="title" content="Makie integration · CImGui.jl"/><meta property="og:title" content="Makie integration · CImGui.jl"/><meta property="twitter:title" content="Makie integration · CImGui.jl"/><meta name="description" content="Documentation for CImGui.jl."/><meta property="og:description" content="Documentation for CImGui.jl."/><meta property="twitter:description" content="Documentation for CImGui.jl."/><meta property="og:url" content="https://Gnimuc.github.io/CImGui.jl/makie/"/><meta property="twitter:url" content="https://Gnimuc.github.io/CImGui.jl/makie/"/><link rel="canonical" href="https://Gnimuc.github.io/CImGui.jl/makie/"/><script data-outdated-warner src="../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../search_index.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../">CImGui.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../">CImGui</a></li><li><a class="tocitem" href="../api/">API Reference</a></li><li><a class="tocitem" href="../backends/">Backends</a></li><li class="is-active"><a class="tocitem" href>Makie integration</a></li><li><a class="tocitem" href="../changelog/">Changelog</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Makie integration</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Makie integration</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/Gnimuc/CImGui.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/Gnimuc/CImGui.jl/blob/master/docs/src/makie.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Makie-integration"><a class="docs-heading-anchor" href="#Makie-integration">Makie integration</a><a id="Makie-integration-1"></a><a class="docs-heading-anchor-permalink" href="#Makie-integration" title="Permalink"></a></h1><p>We currently have <em>very experimental</em> <a href="https://docs.makie.org/stable">Makie</a> support through <a href="https://docs.makie.org/stable/explanations/backends/glmakie">GLMakie</a>. GLMakie mostly works around a <code>Screen{T}</code> object to display a scene, where <code>T</code> is some OpenGL-supporting window. GLMakie sets this to a <code>GLFW.Window</code>, but we've made a custom window type to represent a single <code>Figure</code> to be drawn in ImGui. What we get from GLMakie is a framebuffer with a color image texture attachment, and that's displayed by us as an image.</p><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="CImGui.MakieFigure" href="#CImGui.MakieFigure"><code>CImGui.MakieFigure</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">MakieFigure(id::String, f::GLMakie.Figure; auto_resize_x=true, auto_resize_y=false)</code></pre><p>Display a Makie figure in ImGui. See <code>examples/makie_demo.jl</code> for an example of how to use it. This supports all the interaction features in GLMakie:</p><ul><li>Scrolling to zoom</li><li>Rectangle select to zoom</li><li>RMB to pan</li></ul><p>Note that scrolling to zoom will also cause the ImGui window to scroll, which can be annoying. This may be fixed in the future by using some other key combination for scrolling to zoom.</p><p>These are the <a href="https://docs.makie.org/stable/explanations/events#The-Events-struct">interaction events</a> that are wired up and can be used:</p><ul><li><code>hasfocus</code></li><li><code>entered_window</code></li><li><code>mousebutton</code></li><li><code>mouseposition</code></li></ul><p>Known issues:</p><ul><li>Changing tick labels don't trigger the scene to be re-layouted, causing them to be clipped if the labels change width. See <code>examples/makie_demo.jl</code> for an example workaround using <code>Makie.tight_ticklabel_spacing!()</code>.</li><li>The theming doesn't match the ImGui theme so plots look quite out of place by default.</li><li>Mouse events aren't delivered unless the mouse is hovered over the figure, so dragging the mouse from within the figure to somewhere outside the figure will keep the old mouse state. e.g. if you're RMB panning and the mouse goes outside the figure, when it enters the figure again panning will resume even the RMB was released.</li></ul><div class="admonition is-warning"><header class="admonition-header">Warning</header><div class="admonition-body"><p>This is very experimental, you will almost definitely encounter bugs (and if so please submit an issue/PR). We don't consider this covered under semver yet so there may be breaking changes in minor releases.</p></div></div></div><a class="docs-sourcelink" target="_blank" href="https://github.com/Gnimuc/CImGui.jl/blob/38eadb54028c1246f4caa858072f12c1e0ceac4d/src/CImGui.jl#L70-L107">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../backends/">« Backends</a><a class="docs-footer-nextpage" href="../changelog/">Changelog »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.5.0 on <span class="colophon-date" title="Monday 29 July 2024 11:52">Monday 29 July 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>