imgui-bindings 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72d19d82cafd6b2a8d449e0d69a20e3b5265e06673d18abcec7ba7d8c13c9c89
-  data.tar.gz: d5c1c9f41f13b18206cd94c0ad61768b9c397f3c2f08cb5f22bf009b6d6d6cbb
+  metadata.gz: 953ebd938f07e22b04fd3b5b731b39af52cefc662756aef62e379911ec6b4069
+  data.tar.gz: d9c4141d0061ab02a812040f235fc2ba0f934aa52becba340c9d1556055b936e
 SHA512:
-  metadata.gz: e04d4b1540aa983aacc7c3bad99a92c340f5d038d67be264dfb7f42b76306ef6b3ed15698713cc0797552bae083f0bad37f5ef5f9bcbfd9565313581532a404b
-  data.tar.gz: 0e0c6e296594b472b11ca1fd332079300da68159baa4e6bec91404c53b855907ede56ad57ab13fe7f3f8c9d77cee4065e5a4a85c2e1eebb03904a4d80a03a112
+  metadata.gz: 33267f484dad0070ed7ccb5f3abe07c5f279d810847792e37efaac8222aae5b3fb99b722e4986645ed940c0283c520b55d62405c150c978098988d139a6ddc3c
+  data.tar.gz: a275549e370cac4bfe71ae0c28fd719193204c999663391b5b9c2e2df23ebc7acc80f22a002ef70734fc29aa38b6e28500d122a71c05c43a96ae38abbb4e4e7e

data/ChangeLog

@@ -1,3 +1,11 @@
+2023-04-15  vaiorabbit  <http://twitter.com/vaiorabbit>
+
+	* ImGui v1.89.5
+
+2023-03-19  vaiorabbit  <http://twitter.com/vaiorabbit>
+
+	* ImGui v1.89.4
+
 2023-02-23  vaiorabbit  <http://twitter.com/vaiorabbit>
 
 	* ImGui v1.89.3

data/README.md

@@ -3,7 +3,7 @@
 # Yet another ImGui wrapper for Ruby #
 
 *   Created : 2019-01-05
-*   Last modified : 2023-02-23
+*   Last modified : 2023-04-15
 
 <img src="https://raw.githubusercontent.com/vaiorabbit/ruby-imgui/master/doc/jpfont_test.png" width="250">
 
@@ -16,7 +16,7 @@
         *   [Windows] https://rubyinstaller.org/downloads/ Ruby+Devkit
             *   ruby 3.2.0 (2022-12-25 revision a528908271) [x64-mingw-ucrt]
         *   [macOS]
-            *   ruby 3.2.0 (2022-12-25 revision a528908271) [arm64-darwin21]
+            *   ruby 3.2.1 (2023-02-08 revision 31819e82c8) [arm64-darwin22]
         *   [Linux]
             *   ruby 3.2.0 (2022-12-25 revision a528908271) [aarch64-linux]
 *   Ruby Gems
@@ -42,6 +42,7 @@
             *   ruby 3.0.0p0 (2020-12-25 revision 95aff21468) [x64-mingw32]
             *   ruby 2.7.1p83 (2020-03-31 revision a0c7c23c9c) [x64-mingw32]
         *   [macOS]
+            *   ruby 3.2.0 (2022-12-25 revision a528908271) [arm64-darwin21]
             *   ruby 3.1.2p20 (2022-04-12 revision 4491bb740a) [arm64-darwin21]
             *   ruby 3.1.2p20 (2022-04-12 revision 4491bb740a) [arm64-darwin21]
             *   ruby 3.1.0p0 (2021-12-25 revision fb4df44d16) [arm64-darwin20]

data/lib/imgui.rb

@@ -57,6 +57,7 @@ FFI.typedef :ushort, :ImWchar
 FFI.typedef :ushort, :ImWchar16
 FFI.typedef :uint, :ImWchar32
 FFI.typedef :int, :ImGuiKey
+FFI.typedef :int, :ImGuiMouseSource
 
 # ImDrawFlags_
 # Flags for ImDrawList functions
@@ -223,7 +224,7 @@ ImGuiCond_Appearing = 8    # 1 << 3 # Set the variable if the object/window is a
 # ImGuiConfigFlags_
 # Configuration flags stored in io.ConfigFlags. Set by user/application.
 ImGuiConfigFlags_None = 0                 # 0
-ImGuiConfigFlags_NavEnableKeyboard = 1    # 1 << 0 # Master keyboard navigation enable flag.
+ImGuiConfigFlags_NavEnableKeyboard = 1    # 1 << 0 # Master keyboard navigation enable flag. Enable full Tabbing + directional arrows + space/enter to activate.
 ImGuiConfigFlags_NavEnableGamepad = 2     # 1 << 1 # Master gamepad navigation enable flag. Backend also needs to set ImGuiBackendFlags_HasGamepad.
 ImGuiConfigFlags_NavEnableSetMousePos = 4 # 1 << 2 # Instruct navigation to move the mouse cursor. May be useful on TV/console systems where moving a virtual mouse is awkward. Will update io.MousePos and set io.WantSetMousePos=true. If enabled you MUST honor io.WantSetMousePos requests in your backend, otherwise ImGui will react as if the mouse is jumping around back and forth.
 ImGuiConfigFlags_NavNoCaptureKeyboard = 8 # 1 << 3 # Instruct navigation to not set the io.WantCaptureKeyboard flag when io.NavActive is set.
@@ -329,6 +330,7 @@ ImGuiInputTextFlags_EscapeClearsAll = 1048576  # 1 << 20 # Escape key clears con
 # All our named keys are >= 512. Keys value 0 to 511 are left unused as legacy native/opaque key values (< 1.87).
 # Since >= 1.89 we increased typing (went from int to enum), some legacy code may need a cast to ImGuiKey.
 # Read details about the 1.87 and 1.89 transition : https://github.com/ocornut/imgui/issues/4921
+# Note that "Keys" related to physical keys and are not the same concept as input "Characters", the later are submitted via io.AddInputCharacter().
 ImGuiKey_None = 0                  # 0
 ImGuiKey_Tab = 512                 # 512 # == ImGuiKey_NamedKey_BEGIN
 ImGuiKey_LeftArrow = 513           # 513
@@ -482,7 +484,7 @@ ImGuiKey_NamedKey_BEGIN = 512      # 512
 ImGuiKey_NamedKey_END = 652        # ImGuiKey_COUNT
 ImGuiKey_NamedKey_COUNT = 140      # ImGuiKey_NamedKey_END - ImGuiKey_NamedKey_BEGIN
 ImGuiKey_KeysData_SIZE = 652       # ImGuiKey_COUNT # Size of KeysData[]: hold legacy 0..512 keycodes + named keys
-ImGuiKey_KeysData_OFFSET = 0       # 0 # First key stored in io.KeysData[0]. Accesses to io.KeysData[] must use (key - ImGuiKey_KeysData_OFFSET).
+ImGuiKey_KeysData_OFFSET = 0       # 0 # Accesses to io.KeysData[] must use (key - ImGuiKey_KeysData_OFFSET) index.
 
 # ImGuiMouseButton_
 # Identify a mouse button.
@@ -507,6 +509,16 @@ ImGuiMouseCursor_Hand = 7       # 7 # (Unused by Dear ImGui functions. Use for e
 ImGuiMouseCursor_NotAllowed = 8 # 8 # When hovering something with disallowed interaction. Usually a crossed circle.
 ImGuiMouseCursor_COUNT = 9      # 9
 
+# ImGuiMouseSource
+# Enumeration for AddMouseSourceEvent() actual source of Mouse Input data.
+# Historically we use "Mouse" terminology everywhere to indicate pointer data, e.g. MousePos, IsMousePressed(), io.AddMousePosEvent()
+# But that "Mouse" data can come from different source which occasionally may be useful for application to know about.
+# You can submit a change of pointer type using io.AddMouseSourceEvent().
+ImGuiMouseSource_Mouse = 0       # 0 # Input is coming from an actual mouse.
+ImGuiMouseSource_TouchScreen = 1 # 1 # Input is coming from a touch screen (no hovering prior to initial press, less precise initial press aiming, dual-axis wheeling possible).
+ImGuiMouseSource_Pen = 2         # 2 # Input is coming from a pressure/magnetic pen (often used in conjunction with high-sampling rates).
+ImGuiMouseSource_COUNT = 3       # 3
+
 # ImGuiNavInput
 # OBSOLETED in 1.88 (from July 2022): ImGuiNavInput and io.NavInputs[].
 # Official backends between 1.60 and 1.86: will keep working and feed gamepad inputs as long as IMGUI_DISABLE_OBSOLETE_KEYIO is not set.
@@ -1526,6 +1538,8 @@ class ImGuiIO < FFI::Struct
     :ConfigWindowsResizeFromEdges, :bool,         # = true           // Enable resizing of windows from their edges and from the lower-left corner. This requires (io.BackendFlags & ImGuiBackendFlags_HasMouseCursors) because it needs mouse cursor feedback. (This used to be a per-window ImGuiWindowFlags_ResizeFromAnySide flag)
     :ConfigWindowsMoveFromTitleBarOnly, :bool,    # = false       // Enable allowing to move windows only when clicking on their title bar. Does not apply to windows without a title bar.
     :ConfigMemoryCompactTimer, :float,            # = 60.0f          // Timer (in seconds) to free transient windows/tables memory buffers when unused. Set to -1.0f to disable.
+    :ConfigDebugBeginReturnValueOnce, :bool,      # = false         // First-time calls to Begin()/BeginChild() will return false. NEEDS TO BE SET AT APPLICATION BOOT TIME if you don't want to miss windows.
+    :ConfigDebugBeginReturnValueLoop, :bool,      # = false         // Some calls to Begin()/BeginChild() will return false. Will cycle through window depths then repeat. Suggested use: add "io.ConfigDebugBeginReturnValue = io.KeyShift" in your main loop then occasionally press SHIFT. Windows should be flickering while running.
     :BackendPlatformName, :pointer,               # = NULL
     :BackendRendererName, :pointer,               # = NULL
     :BackendPlatformUserData, :pointer,           # = NULL           // User data for platform backend
@@ -1553,10 +1567,12 @@ class ImGuiIO < FFI::Struct
     :KeyMap, [:int, 652],                         # [LEGACY] Input: map of indices into the KeysDown[512] entries array which represent your "native" keyboard state. The first 512 are now unused and should be kept zero. Legacy backend will write into KeyMap[] using ImGuiKey_ indices which are always >512.
     :KeysDown, [:bool, 652],                      # [LEGACY] Input: Keyboard keys that are pressed (ideally left in the "native" order your engine has access to keyboard keys, so you can use your own defines/enums for keys). This used to be [512] sized. It is now ImGuiKey_COUNT to allow legacy io.KeysDown[GetKeyIndex(...)] to work without an overflow.
     :NavInputs, [:float, 16],                     # [LEGACY] Since 1.88, NavInputs[] was removed. Backends from 1.60 to 1.86 won't build. Feed gamepad inputs via io.AddKeyEvent() and ImGuiKey_GamepadXXX enums.
+    :Ctx, :pointer,                               # Parent UI context (needs to be set explicitly by parent).
     :MousePos, ImVec2.by_value,                   # Mouse position, in pixels. Set to ImVec2(-FLT_MAX, -FLT_MAX) if mouse is unavailable (on another screen, etc.)
     :MouseDown, [:bool, 5],                       # Mouse buttons: 0=left, 1=right, 2=middle + extras (ImGuiMouseButton_COUNT == 5). Dear ImGui mostly uses left and right buttons. Other buttons allow us to track if the mouse is being used by your application + available to user as a convenience via IsMouse** API.
     :MouseWheel, :float,                          # Mouse wheel Vertical: 1 unit scrolls about 5 lines text. >0 scrolls Up, <0 scrolls Down. Hold SHIFT to turn vertical scroll into horizontal scroll.
     :MouseWheelH, :float,                         # Mouse wheel Horizontal. >0 scrolls Left, <0 scrolls Right. Most users don't have a mouse with a horizontal wheel, may not be filled by all backends.
+    :MouseSource, :int,                           # Mouse actual input peripheral (Mouse/TouchScreen/Pen).
     :KeyCtrl, :bool,                              # Keyboard modifier down: Control
     :KeyShift, :bool,                             # Keyboard modifier down: Shift
     :KeyAlt, :bool,                               # Keyboard modifier down: Alt
@@ -1574,6 +1590,7 @@ class ImGuiIO < FFI::Struct
     :MouseReleased, [:bool, 5],                   # Mouse button went from Down to !Down
     :MouseDownOwned, [:bool, 5],                  # Track if button was clicked inside a dear imgui window or over void blocked by a popup. We don't request mouse capture from the application if click started outside ImGui bounds.
     :MouseDownOwnedUnlessPopupClose, [:bool, 5],  # Track if button was clicked inside a dear imgui window.
+    :MouseWheelRequestAxisSwap, :bool,            # On a non-Mac system, holding SHIFT requests WheelY to perform the equivalent of a WheelX event. On a Mac system this is already enforced by the system.
     :MouseDownDuration, [:float, 5],              # Duration the mouse button has been down (0.0f == just clicked)
     :MouseDownDurationPrev, [:float, 5],          # Previous time the mouse button has been down
     :MouseDragMaxDistanceSqr, [:float, 5],        # Squared maximum distance of how much mouse has traveled from the clicking point (used for moving thresholds)
@@ -1618,6 +1635,10 @@ class ImGuiIO < FFI::Struct
     ImGui::ImGuiIO_AddMousePosEvent(self, x, y)
   end
 
+  def AddMouseSourceEvent(source)
+    ImGui::ImGuiIO_AddMouseSourceEvent(self, source)
+  end
+
   def AddMouseWheelEvent(wheel_x, wheel_y)
     ImGui::ImGuiIO_AddMouseWheelEvent(self, wheel_x, wheel_y)
   end
@@ -1659,6 +1680,7 @@ end
 # - ImGuiInputTextFlags_CallbackResize:      Callback on buffer capacity changes request (beyond 'buf_size' parameter value), allowing the string to grow.
 class ImGuiInputTextCallbackData < FFI::Struct
   layout(
+    :Ctx, :pointer,         # Parent UI context
     :EventFlag, :int,       # One ImGuiInputTextFlags_Callback*    // Read-only
     :Flags, :int,           # What user passed to InputText()      // Read-only
     :UserData, :pointer,    # What user passed to InputText()      // Read-only
@@ -2004,6 +2026,7 @@ module ImGui
       [:ImGuiIO_AddKeyEvent, [:pointer, :int, :bool], :void],
       [:ImGuiIO_AddMouseButtonEvent, [:pointer, :int, :bool], :void],
       [:ImGuiIO_AddMousePosEvent, [:pointer, :float, :float], :void],
+      [:ImGuiIO_AddMouseSourceEvent, [:pointer, :int], :void],
       [:ImGuiIO_AddMouseWheelEvent, [:pointer, :float, :float], :void],
       [:ImGuiIO_ClearInputCharacters, [:pointer], :void],
       [:ImGuiIO_ClearInputKeys, [:pointer], :void],
@@ -2050,7 +2073,7 @@ module ImGui
       [:igBeginTabBar, [:pointer, :int], :bool],
       [:igBeginTabItem, [:pointer, :pointer, :int], :bool],
       [:igBeginTable, [:pointer, :int, :int, ImVec2.by_value, :float], :bool],
-      [:igBeginTooltip, [], :void],
+      [:igBeginTooltip, [], :bool],
       [:igBullet, [], :void],
       [:igBulletText, [:pointer, :varargs], :void],
       [:igButton, [:pointer, ImVec2.by_value], :bool],
@@ -2249,7 +2272,6 @@ module ImGui
       [:igPlotHistogram_FnFloatPtr, [:pointer, :pointer, :pointer, :int, :int, :pointer, :float, :float, ImVec2.by_value], :void],
       [:igPlotLines_FloatPtr, [:pointer, :pointer, :int, :int, :pointer, :float, :float, ImVec2.by_value, :int], :void],
       [:igPlotLines_FnFloatPtr, [:pointer, :pointer, :pointer, :int, :int, :pointer, :float, :float, ImVec2.by_value], :void],
-      [:igPopAllowKeyboardFocus, [], :void],
       [:igPopButtonRepeat, [], :void],
       [:igPopClipRect, [], :void],
       [:igPopFont, [], :void],
@@ -2257,9 +2279,9 @@ module ImGui
       [:igPopItemWidth, [], :void],
       [:igPopStyleColor, [:int], :void],
       [:igPopStyleVar, [:int], :void],
+      [:igPopTabStop, [], :void],
       [:igPopTextWrapPos, [], :void],
       [:igProgressBar, [:float, ImVec2.by_value, :pointer], :void],
-      [:igPushAllowKeyboardFocus, [:bool], :void],
       [:igPushButtonRepeat, [:bool], :void],
       [:igPushClipRect, [ImVec2.by_value, ImVec2.by_value, :bool], :void],
       [:igPushFont, [:pointer], :void],
@@ -2272,6 +2294,7 @@ module ImGui
       [:igPushStyleColor_Vec4, [:int, ImVec4.by_value], :void],
       [:igPushStyleVar_Float, [:int, :float], :void],
       [:igPushStyleVar_Vec2, [:int, ImVec2.by_value], :void],
+      [:igPushTabStop, [:bool], :void],
       [:igPushTextWrapPos, [:float], :void],
       [:igRadioButton_Bool, [:pointer, :bool], :bool],
       [:igRadioButton_IntPtr, [:pointer, :pointer, :int], :bool],
@@ -2624,7 +2647,7 @@ module ImGui
     igBeginTable(str_id, column, flags, outer_size, inner_width)
   end
 
-  # ret: void
+  # ret: bool
   #
   # Tooltips
   # - Tooltip are windows following the mouse. They do not take focus away.
@@ -3000,7 +3023,7 @@ module ImGui
   end
 
   # ret: void
-  def self.EndTooltip()
+  def self.EndTooltip()  # only call EndTooltip() if BeginTooltip() returns true!
     igEndTooltip()
   end
 
@@ -3863,11 +3886,6 @@ module ImGui
     igPlotLines_FnFloatPtr(label, values_getter, data, values_count, values_offset, overlay_text, scale_min, scale_max, graph_size)
   end
 
-  # ret: void
-  def self.PopAllowKeyboardFocus()
-    igPopAllowKeyboardFocus()
-  end
-
   # ret: void
   def self.PopButtonRepeat()
     igPopButtonRepeat()
@@ -3905,6 +3923,11 @@ module ImGui
     igPopStyleVar(count)
   end
 
+  # ret: void
+  def self.PopTabStop()
+    igPopTabStop()
+  end
+
   # ret: void
   def self.PopTextWrapPos()
     igPopTextWrapPos()
@@ -3916,12 +3939,6 @@ module ImGui
     igProgressBar(fraction, size_arg, overlay)
   end
 
-  # arg: allow_keyboard_focus(bool)
-  # ret: void
-  def self.PushAllowKeyboardFocus(allow_keyboard_focus)  # == tab stop enable. Allow focusing using TAB/Shift-TAB, enabled by default but you can disable it for certain widgets
-    igPushAllowKeyboardFocus(allow_keyboard_focus)
-  end
-
   # arg: repeat(bool)
   # ret: void
   def self.PushButtonRepeat(repeat)  # in 'repeat' mode, Button*() functions return repeated true in a typematic manner (using io.KeyRepeatDelay/io.KeyRepeatRate setting). Note that you can call IsItemActive() after any Button() to tell if the button is held in the current frame.
@@ -4001,6 +4018,12 @@ module ImGui
     igPushStyleVar_Vec2(idx, val)
   end
 
+  # arg: tab_stop(bool)
+  # ret: void
+  def self.PushTabStop(tab_stop)  # == tab stop enable. Allow focusing using TAB/Shift-TAB, enabled by default but you can disable it for certain widgets
+    igPushTabStop(tab_stop)
+  end
+
   # arg: wrap_local_pos_x(float)
   # ret: void
   def self.PushTextWrapPos(wrap_local_pos_x = 0.0)  # push word-wrapping position for Text*() commands. < 0.0f: no wrapping; 0.0f: wrap to end of window (or column); > 0.0f: wrap at 'wrap_pos_x' position in window local space
@@ -4908,7 +4931,7 @@ module ImGui
 
   #
   # ID stack/scopes
-  # Read the FAQ (docs/FAQ.md or http://dearimgui.org/faq) for more details about how ID are handled in dear imgui.
+  # Read the FAQ (docs/FAQ.md or http://dearimgui.com/faq) for more details about how ID are handled in dear imgui.
   # - Those questions are answered and impacted by understanding of the ID stack system:
   #   - "Q: Why is my widget not reacting when I click on it?"
   #   - "Q: How can I have widgets with an empty label?"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: imgui-bindings
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors:
 - vaiorabbit
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-23 00:00:00.000000000 Z
+date: 2023-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -86,7 +86,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
+rubygems_version: 3.4.6
 signing_key:
 specification_version: 4
 summary: Bindings for Dear ImGui