Merge pull request #136 from Gnimuc/makie

Document GLMakie requirements

.github/workflows/ci.yml

@@ -1,8 +1,11 @@
 name: CI
 
 on:
-  - push
   - pull_request
+  push:
+    branches:
+      - master
+    tags: "*"
 
 permissions:
   actions: write

docs/src/index.md

@@ -7,6 +7,12 @@ content creation tools and visualization / debug tools. You could browse
 [Gallery](https://github.com/ocornut/imgui/issues/2265) to get an idea of its
 use cases.
 
+These docs were generated against this upstream Dear ImGui version:
+```@repl
+import CImGui as ig
+ig.imgui_version()
+```
+
 ## Installation
 ```julia-repl
 pkg> add CImGui

examples/makie_demo.jl

@@ -11,17 +11,19 @@ ig.set_backend(:GlfwOpenGL3)
 function generate_data(type::Symbol=:random, N=1000)
     if type === :random
         [Point2f(i, rand()) for i in 1:N]
+    elseif type === :sine
+        [Point2f(i, sin(i * 0.1) + 0.5) for i in 1:N]
     end
 end
 
 function HelpMarker(msg)
-    ig.TextDisabled("(?)");
+    ig.TextDisabled("(?)")
 
     if ig.IsItemHovered() && ig.BeginTooltip()
-        ig.PushTextWrapPos(ig.GetFontSize() * 35.0);
-        ig.TextUnformatted(msg);
-        ig.PopTextWrapPos();
-        ig.EndTooltip();
+        ig.PushTextWrapPos(ig.GetFontSize() * 35.0)
+        ig.TextUnformatted(msg)
+        ig.PopTextWrapPos()
+        ig.EndTooltip()
     end
 end
 
@@ -31,8 +33,11 @@ function makie_demo(; engine=nothing)
     scene = Makie.get_scene(f)
     ax1 = Axis(f[1, 1]; title="Random data")
     data = Observable(generate_data())
-    lines!(ax1, data)
+    lines!(ax1, data, label="Random data")
+    lines!(ax1, generate_data(:sine), label="Sin")
     data2 = Observable(generate_data())
+    axislegend(ax1)
+
     ax2 = Axis(f[2, 1])
     lines!(ax2, data2)
 
@@ -44,9 +49,10 @@ function makie_demo(; engine=nothing)
     ax1_tight_spacing = true
     auto_resize_x = true
     auto_resize_y = false
+    tooltip = true
 
     # Start the GUI
-    ig.render(ctx; engine, window_size=(1280, 760), window_title="ImGui Window") do
+    ig.render(ctx; engine, window_size=(1280, 760), window_title="ImGui Window", opengl_version=v"3.3") do
         ig.Begin("Makie demo")
 
         if ig.Button("Random data")
@@ -63,8 +69,10 @@ function makie_demo(; engine=nothing)
         @c ig.Checkbox("Auto resize X", &auto_resize_x)
         ig.SameLine()
         @c ig.Checkbox("Auto resize Y", &auto_resize_y)
+        ig.SameLine()
+        @c ig.Checkbox("Draw tooltip", &tooltip)
 
-        if ig.MakieFigure("plot", f; auto_resize_x, auto_resize_y)
+        if ig.MakieFigure("plot", f; auto_resize_x, auto_resize_y, tooltip)
             if ax1_tight_spacing
                 Makie.tight_ticklabel_spacing!(ax1)
             end

src/CImGui.jl

@@ -68,7 +68,9 @@ const IMGUI_VERSION = unsafe_string(GetVersion())
 # This is implemented by the MakieIntegration extension but we document it here
 # so that we don't have to install GLMakie to build the docs.
 """
-    MakieFigure(id::String, f::GLMakie.Figure; auto_resize_x=true, auto_resize_y=false, tooltip=true)
+    MakieFigure(id::String, f::GLMakie.Figure;
+                auto_resize_x=true, auto_resize_y=false,
+                tooltip=true)
 
 Display a Makie figure in ImGui. See `examples/makie_demo.jl` for an example of
 how to use it. This supports all the interaction features in GLMakie:
@@ -104,6 +106,11 @@ Known issues:
 - Drawing can be a bit janky, occasionally the image will not be drawn for a
   frame or two and you'll see an empty black square instead.
 
+!!! note
+    GLMakie requires OpenGL 3.3, on some systems you will need to explicitly
+    pass `opengl_version=v"3.3"` (or higher) to [`render()`](@ref) to fix OpenGL
+    shader errors.
+
 !!! warning
     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