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 1060299 commit d3be53a
Show file tree
Hide file tree
Showing 9 changed files with 1,345 additions and 1,345 deletions.
2 changes: 1 addition & 1 deletion dev/.documenter-siteinfo.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-09-09T09:22:16","documenter_version":"1.7.0"}}
{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-09-11T20:11:03","documenter_version":"1.7.0"}}
2 changes: 1 addition & 1 deletion dev/_changelog/index.html

Large diffs are not rendered by default.

2,676 changes: 1,338 additions & 1,338 deletions dev/api/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/backends/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/changelog/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@
@info "Triggered"
end
ig.End()
end</code></pre><p>Note that neither ImGui nor OpenGL are thread-safe, and because of this <a href="backends/#CImGui.render"><code>CImGui.render()</code></a> will pin the renderloop to thread 1 by default (see the docstring for more information).</p><h2 id="Usage"><a class="docs-heading-anchor" href="#Usage">Usage</a><a id="Usage-1"></a><a class="docs-heading-anchor-permalink" href="#Usage" title="Permalink"></a></h2><p>The API provided in this package is as close as possible to the original C++ API. When translating C++ code to Julia, please follow the tips below:</p><ul><li>Replace <code>ImGui::</code> to <code>CImGui.</code> (or <code>ig.</code> if you&#39;ve run <code>import CImGui as ig</code>).</li><li><code>using CImGui.lib</code> to import all of the <code>ImGuiXXX</code> types into the current namespace.</li><li>Member function calling should be translated in Julia style: <code>fonts.AddFont(cfg)</code> =&gt; <code>ig.AddFont(fonts, cfg)</code>.</li><li>[<code>using CImGui.CSyntax</code>] provides two useful macros: <code>@c</code> for translating C&#39;s <code>&amp;</code> operator on immutables and <code>@cstatic</code>-block for emulating C&#39;s <code>static</code> keyword.</li></ul><p>As mentioned before, this package aims to provide the same user experience as the original C++ API, so any high-level abstraction should go into a more high-level package. <a href="https://github.com/Gnimuc/Redux.jl"><code>Redux.jl</code></a> might be of interest to you if you&#39;re looking for state management frameworks.</p><p>For writing tests you can use <a href="https://juliaimgui.github.io/ImGuiTestEngine.jl">ImGuiTestEngine.jl</a>.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="api/">API Reference »</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.7.0 on <span class="colophon-date" title="Monday 9 September 2024 09:22">Monday 9 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
end</code></pre><p>Note that neither ImGui nor OpenGL are thread-safe, and because of this <a href="backends/#CImGui.render"><code>CImGui.render()</code></a> will pin the renderloop to thread 1 by default (see the docstring for more information).</p><h2 id="Usage"><a class="docs-heading-anchor" href="#Usage">Usage</a><a id="Usage-1"></a><a class="docs-heading-anchor-permalink" href="#Usage" title="Permalink"></a></h2><p>The API provided in this package is as close as possible to the original C++ API. When translating C++ code to Julia, please follow the tips below:</p><ul><li>Replace <code>ImGui::</code> to <code>CImGui.</code> (or <code>ig.</code> if you&#39;ve run <code>import CImGui as ig</code>).</li><li><code>using CImGui.lib</code> to import all of the <code>ImGuiXXX</code> types into the current namespace.</li><li>Member function calling should be translated in Julia style: <code>fonts.AddFont(cfg)</code> =&gt; <code>ig.AddFont(fonts, cfg)</code>.</li><li>[<code>using CImGui.CSyntax</code>] provides two useful macros: <code>@c</code> for translating C&#39;s <code>&amp;</code> operator on immutables and <code>@cstatic</code>-block for emulating C&#39;s <code>static</code> keyword.</li></ul><p>As mentioned before, this package aims to provide the same user experience as the original C++ API, so any high-level abstraction should go into a more high-level package. <a href="https://github.com/Gnimuc/Redux.jl"><code>Redux.jl</code></a> might be of interest to you if you&#39;re looking for state management frameworks.</p><p>For writing tests you can use <a href="https://juliaimgui.github.io/ImGuiTestEngine.jl">ImGuiTestEngine.jl</a>.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="api/">API Reference »</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.7.0 on <span class="colophon-date" title="Wednesday 11 September 2024 20:11">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 d3be53a

Please sign in to comment.