Skip to content

Commit

Permalink
build based on 65e82eb
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Sep 11, 2024
1 parent d3be53a commit 95e20e1
Show file tree
Hide file tree
Showing 24 changed files with 7,166 additions and 2 deletions.
2 changes: 1 addition & 1 deletion stable
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
v2.3.0
v3.0.0
1 change: 1 addition & 0 deletions v3
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
v3.0.0
1 change: 1 addition & 0 deletions v3.0
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
v3.0.0
1 change: 1 addition & 0 deletions v3.0.0/.documenter-siteinfo.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-09-11T20:27:10","documenter_version":"1.7.0"}}
2 changes: 2 additions & 0 deletions v3.0.0/_changelog/index.html
View file
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>Changelog · CImGui.jl</title><meta name="title" content="Changelog · CImGui.jl"/><meta property="og:title" content="Changelog · CImGui.jl"/><meta property="twitter:title" content="Changelog · 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/_changelog/"/><meta property="twitter:url" content="https://Gnimuc.github.io/CImGui.jl/_changelog/"/><link rel="canonical" href="https://Gnimuc.github.io/CImGui.jl/_changelog/"/><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><a class="tocitem" href="../makie/">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>Changelog</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Changelog</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/_changelog.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="Changelog"><a class="docs-heading-anchor" href="#Changelog">Changelog</a><a id="Changelog-1"></a><a class="docs-heading-anchor-permalink" href="#Changelog" title="Permalink"></a></h1><p>This documents notable changes in CImGui.jl. The format is based on <a href="https://keepachangelog.com">Keep a Changelog</a>.</p><h2 id="[v3.0.0]-2024-09-11"><a class="docs-heading-anchor" href="#[v3.0.0]-2024-09-11">[v3.0.0] - 2024-09-11</a><a id="[v3.0.0]-2024-09-11-1"></a><a class="docs-heading-anchor-permalink" href="#[v3.0.0]-2024-09-11" title="Permalink"></a></h2><h3 id="Added"><a class="docs-heading-anchor" href="#Added">Added</a><a id="Added-1"></a><a class="docs-heading-anchor-permalink" href="#Added" title="Permalink"></a></h3><ul><li><a href="../api/#CImGui.HelpMarker-Tuple{AbstractString}"><code>HelpMarker()</code></a>, a port of the same function from the Dear ImGui demo ([#139]).</li></ul><h3 id="Changed"><a class="docs-heading-anchor" href="#Changed">Changed</a><a id="Changed-1"></a><a class="docs-heading-anchor-permalink" href="#Changed" title="Permalink"></a></h3><ul><li><p>Simplified the <a href="../makie/#Makie-integration">Makie integration</a> by requiring the latest GLMakie version ([#142]).</p></li><li><p><strong>Breaking</strong>: We upgraded to <a href="https://github.com/ocornut/imgui/releases/tag/v1.91.1">Dear ImGui 1.91.1</a>. All the breaking changes listed there and for <a href="https://github.com/ocornut/imgui/releases/tag/v1.91.0">Dear ImGui 1.91.0</a> apply to this release.</p></li><li><p><strong>Breaking</strong>: We now generate the high-level Julia wrappers automatically ([#141]), which is far easier to maintain but it&#39;s possible that some functions will have changed signatures or been renamed. Here&#39;s a (non-exhaustive) list of known changes:</p><ul><li><a href="../api/#CImGui.Combo"><code>Combo()</code></a> no longer requires passing the length of <code>items</code>.</li><li>The old <code>Value*()</code> functions are now just named <a href="../api/#CImGui.Value"><code>Value()</code></a> and use dispatch to select the right ImGui function to call.</li><li>The <code>Combo()</code> and <code>ListBox()</code> methods that allowed passing a function to generate the items are not wrapped. They may be wrapped in the future.</li></ul><p>If you encounter any other breakages please open an issue, it could be a bug in the wrappers.</p></li><li><p><strong>Possibly breaking</strong>: <a href="../backends/#CImGui.render"><code>render()</code></a> would previously run on whatever task and thread it was called on, but with multiple threads that could cause issues if the task migrated. It now defaults to being pinned to thread 1 and there&#39;s a couple new keyword arguments, <code>spawn</code> and <code>wait</code>, to control the task pinning and wait behaviour ([#138]). This is technically breaking because any old code that set up <a href="../backends/#CImGui.render"><code>render()</code></a> to run on a specific thread by task pinning won&#39;t work, to get back the old behaviour pass <code>spawn=false</code>.</p></li></ul><h2 id="[v2.3.0]-2024-08-06"><a class="docs-heading-anchor" href="#[v2.3.0]-2024-08-06">[v2.3.0] - 2024-08-06</a><a id="[v2.3.0]-2024-08-06-1"></a><a class="docs-heading-anchor-permalink" href="#[v2.3.0]-2024-08-06" title="Permalink"></a></h2><h3 id="Added-2"><a class="docs-heading-anchor" href="#Added-2">Added</a><a class="docs-heading-anchor-permalink" href="#Added-2" title="Permalink"></a></h3><ul><li>The <a href="../makie/#Makie-integration">Makie integration</a> now supports displaying rendering statistics, and has a context menu to change simple plot settings ([#137]). This will be made more customizeable in the future.</li></ul><h3 id="Fixed"><a class="docs-heading-anchor" href="#Fixed">Fixed</a><a id="Fixed-1"></a><a class="docs-heading-anchor-permalink" href="#Fixed" title="Permalink"></a></h3><ul><li>Fixed a number of bugs in the Makie integration ([#137]).</li></ul><h3 id="Changed-2"><a class="docs-heading-anchor" href="#Changed-2">Changed</a><a class="docs-heading-anchor-permalink" href="#Changed-2" title="Permalink"></a></h3><ul><li><p>Upon loading the Makie extension, the default Makie theme will be set to one that matches ImGui&#39;s default dark theme ([#137]).</p></li><li><p>The GLFW/OpenGL renderloop will now <code>yield()</code> after every drawing iteration ([#137]). This makes it play a little nicer with Julia&#39;s event loop.</p></li><li><p><strong>Breaking</strong>: Previously <a href="../makie/#CImGui.MakieFigure"><code>MakieFigure()</code></a> would return a <code>Bool</code> to indicate if the figure was rendered or not, now it returns <code>nothing</code> ([#137]).</p><p><em>Reminder that the <a href="../makie/#Makie-integration">Makie integration</a> is not yet covered by semver.</em></p></li></ul><h2 id="[v2.2.0]-2024-08-02"><a class="docs-heading-anchor" href="#[v2.2.0]-2024-08-02">[v2.2.0] - 2024-08-02</a><a id="[v2.2.0]-2024-08-02-1"></a><a class="docs-heading-anchor-permalink" href="#[v2.2.0]-2024-08-02" title="Permalink"></a></h2><h3 id="Added-3"><a class="docs-heading-anchor" href="#Added-3">Added</a><a class="docs-heading-anchor-permalink" href="#Added-3" title="Permalink"></a></h3><ul><li>Support for more GLMakie controls, and a tooltip for each figure by default ([#134]).</li></ul><h2 id="[v2.1.0]-2024-07-29"><a class="docs-heading-anchor" href="#[v2.1.0]-2024-07-29">[v2.1.0] - 2024-07-29</a><a id="[v2.1.0]-2024-07-29-1"></a><a class="docs-heading-anchor-permalink" href="#[v2.1.0]-2024-07-29" title="Permalink"></a></h2><h3 id="Added-4"><a class="docs-heading-anchor" href="#Added-4">Added</a><a class="docs-heading-anchor-permalink" href="#Added-4" title="Permalink"></a></h3><ul><li>The OpenGL version can now be set with <a href="../backends/#CImGui.render"><code>render()</code></a>.</li><li>Experimental <a href="../makie/#Makie-integration">Makie integration</a> ([#133]).</li></ul><h2 id="[v2.0.0]-2024-06-27"><a class="docs-heading-anchor" href="#[v2.0.0]-2024-06-27">[v2.0.0] - 2024-06-27</a><a id="[v2.0.0]-2024-06-27-1"></a><a class="docs-heading-anchor-permalink" href="#[v2.0.0]-2024-06-27" title="Permalink"></a></h2><p>Note: this release has particularly many breaking changes, please file an issue or submit a pull request if something isn&#39;t working.</p><h3 id="Added-5"><a class="docs-heading-anchor" href="#Added-5">Added</a><a class="docs-heading-anchor-permalink" href="#Added-5" title="Permalink"></a></h3><ul><li>A renderloop for the OpenGL/GLFW backend has been added to CImGui, so it&#39;s no longer necessary to copy and paste the examples around.</li><li>The renderloop also integrates with the new <a href="https://github.com/JuliaImGui/ImGuiTestEngine.jl">ImGuiTestEngine.jl</a> to make it possible to write automated tests.</li></ul><h3 id="Changed-3"><a class="docs-heading-anchor" href="#Changed-3">Changed</a><a class="docs-heading-anchor-permalink" href="#Changed-3" title="Permalink"></a></h3><ul><li>CImGui.jl now uses semantic versioning to make development easier. This release is based on <a href="https://github.com/ocornut/imgui/releases/tag/v1.90.8">Dear ImGui 1.90.8</a>.</li><li><strong>Breaking</strong>: LibCImGui.jl has been merged into <code>CImGui.lib</code>, again for the sake of ease of development.</li><li><strong>Breaking</strong>: The custom backends that we developed, <a href="https://github.com/JuliaImGui/ImGuiOpenGLBackend.jl">ImGuiOpenGLBackend.jl</a> and <a href="https://github.com/JuliaImGui/ImGuiGLFWBackend.jl">ImGuiGLFWBackend.jl</a>, have been deprecated in favour of using ImGui&#39;s official backends. With this change we also dropped support for OpenGL 2, but purely out of laziness. If you need OpenGL 2 let us know and we can build and ship the official OpenGL 2 backend.</li><li><strong>Breaking</strong>: The built-in renderloop is implemented using package extensions, which are only available on Julia 1.9+. Hence the new minimum required Julia version is 1.9.</li></ul><h3 id="Deprecated"><a class="docs-heading-anchor" href="#Deprecated">Deprecated</a><a id="Deprecated-1"></a><a class="docs-heading-anchor-permalink" href="#Deprecated" title="Permalink"></a></h3><ul><li><code>GetKeyIndex()</code> has been <a href="https://github.com/ocornut/imgui/blob/6d948ab47ecf984239af01434f3ed03808dbf188/imgui.h#L3532">deprecated upstream</a>. It will be removed in a future release.</li></ul><h2 id="[v1.89.1]-2024-05-19"><a class="docs-heading-anchor" href="#[v1.89.1]-2024-05-19">[v1.89.1] - 2024-05-19</a><a id="[v1.89.1]-2024-05-19-1"></a><a class="docs-heading-anchor-permalink" href="#[v1.89.1]-2024-05-19" title="Permalink"></a></h2><h3 id="Fixed-2"><a class="docs-heading-anchor" href="#Fixed-2">Fixed</a><a class="docs-heading-anchor-permalink" href="#Fixed-2" title="Permalink"></a></h3><ul><li>Fixed the implementations of <a href="../api/#CImGui.SetScrollX-Tuple{Real}">SetScrollX()</a> and <a href="../api/#CImGui.SetScrollY-Tuple{Real}">SetScrollY()</a> ([#115]).</li></ul></article><nav class="docs-footer"><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.7.0 on <span class="colophon-date" title="Wednesday 11 September 2024 20:27">Wednesday 11 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 95e20e1

Please sign in to comment.