diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..869df07 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +/target +Cargo.lock \ No newline at end of file diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 0000000..8c1e88f --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,20 @@ +[package] +name = "imgui-sdl2-support" +version = "0.12.0" +edition = "2021" +authors = ["The imgui-rs Developers"] +description = "sdl2 support code for the imgui crate" +homepage = "https://github.com/imgui-rs/imgui-rs" +repository = "https://github.com/imgui-rs/imgui-rs" +documentation = "https://docs.rs/imgui-sdl2-support" +license = "MIT OR Apache-2.0" +categories = ["gui"] + +[dependencies] +imgui = "0.12.0" +sdl2 = "0.36" + +[dev-dependencies] +glow = "0.13.1" +imgui-glow-renderer = "0.12.0" +sdl2 = { version = "0.36", features = ["bundled", "static-link"] } diff --git a/LICENSE-APACHE b/LICENSE-APACHE new file mode 100644 index 0000000..3b7a7f9 --- /dev/null +++ b/LICENSE-APACHE @@ -0,0 +1,202 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2021 the imgui-rs developers + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + diff --git a/LICENSE-MIT b/LICENSE-MIT new file mode 100644 index 0000000..230b8c4 --- /dev/null +++ b/LICENSE-MIT @@ -0,0 +1,19 @@ +Copyright (c) 2021 The imgui-rs Developers + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..6177d47 --- /dev/null +++ b/README.md @@ -0,0 +1,16 @@ +# imgui-sdl2-support + +This crate provides a SDL 2 based backend platform for imgui-rs. + +A backend platform handles window/input device events and manages their +state. + +## Using the library + +There are three things you need to do to use this library correctly: + +1. Initialize a `SdlPlatform` instance +2. Pass events to the platform (every frame) +3. Call frame preparation callback (every frame) + +For a complete example, take a look at the imgui-rs' GitHub repository. diff --git a/examples/sdl2_01_basic.rs b/examples/sdl2_01_basic.rs new file mode 100644 index 0000000..f89ea26 --- /dev/null +++ b/examples/sdl2_01_basic.rs @@ -0,0 +1,92 @@ +use glow::HasContext; +use imgui::Context; +use imgui_glow_renderer::AutoRenderer; +use imgui_sdl2_support::SdlPlatform; +use sdl2::{ + event::Event, + video::{GLProfile, Window}, +}; + +// Create a new glow context. +fn glow_context(window: &Window) -> glow::Context { + unsafe { + glow::Context::from_loader_function(|s| window.subsystem().gl_get_proc_address(s) as _) + } +} + +fn main() { + /* initialize SDL and its video subsystem */ + let sdl = sdl2::init().unwrap(); + let video_subsystem = sdl.video().unwrap(); + + /* hint SDL to initialize an OpenGL 3.3 core profile context */ + let gl_attr = video_subsystem.gl_attr(); + + gl_attr.set_context_version(3, 3); + gl_attr.set_context_profile(GLProfile::Core); + + /* create a new window, be sure to call opengl method on the builder when using glow! */ + let window = video_subsystem + .window("Hello imgui-rs!", 1280, 720) + .allow_highdpi() + .opengl() + .position_centered() + .resizable() + .build() + .unwrap(); + + /* create a new OpenGL context and make it current */ + let gl_context = window.gl_create_context().unwrap(); + window.gl_make_current(&gl_context).unwrap(); + + /* enable vsync to cap framerate */ + window.subsystem().gl_set_swap_interval(1).unwrap(); + + /* create new glow and imgui contexts */ + let gl = glow_context(&window); + + /* create context */ + let mut imgui = Context::create(); + + /* disable creation of files on disc */ + imgui.set_ini_filename(None); + imgui.set_log_filename(None); + + /* setup platform and renderer, and fonts to imgui */ + imgui + .fonts() + .add_font(&[imgui::FontSource::DefaultFontData { config: None }]); + + /* create platform and renderer */ + let mut platform = SdlPlatform::init(&mut imgui); + let mut renderer = AutoRenderer::initialize(gl, &mut imgui).unwrap(); + + /* start main loop */ + let mut event_pump = sdl.event_pump().unwrap(); + + 'main: loop { + for event in event_pump.poll_iter() { + /* pass all events to imgui platfrom */ + platform.handle_event(&mut imgui, &event); + + if let Event::Quit { .. } = event { + break 'main; + } + } + + /* call prepare_frame before calling imgui.new_frame() */ + platform.prepare_frame(&mut imgui, &window, &event_pump); + + let ui = imgui.new_frame(); + /* create imgui UI here */ + ui.show_demo_window(&mut true); + + /* render */ + let draw_data = imgui.render(); + + unsafe { renderer.gl_context().clear(glow::COLOR_BUFFER_BIT) }; + renderer.render(draw_data).unwrap(); + + window.gl_swap_window(); + } +} diff --git a/src/lib.rs b/src/lib.rs new file mode 100644 index 0000000..370beb6 --- /dev/null +++ b/src/lib.rs @@ -0,0 +1,375 @@ +#![doc = include_str!("../README.md")] + +use std::time::Instant; + +use imgui::{BackendFlags, ConfigFlags, Context, Io, MouseCursor}; +use sdl2::{ + event::Event, + keyboard::{Mod, Scancode}, + mouse::{Cursor, MouseState, SystemCursor}, + video::Window, + EventPump, +}; + +/// Handle changes in the key states. +fn handle_key(io: &mut Io, key: &Scancode, pressed: bool) { + let igkey = match key { + Scancode::A => imgui::Key::A, + Scancode::B => imgui::Key::B, + Scancode::C => imgui::Key::C, + Scancode::D => imgui::Key::D, + Scancode::E => imgui::Key::E, + Scancode::F => imgui::Key::F, + Scancode::G => imgui::Key::G, + Scancode::H => imgui::Key::H, + Scancode::I => imgui::Key::I, + Scancode::J => imgui::Key::J, + Scancode::K => imgui::Key::K, + Scancode::L => imgui::Key::L, + Scancode::M => imgui::Key::M, + Scancode::N => imgui::Key::N, + Scancode::O => imgui::Key::O, + Scancode::P => imgui::Key::P, + Scancode::Q => imgui::Key::Q, + Scancode::R => imgui::Key::R, + Scancode::S => imgui::Key::S, + Scancode::T => imgui::Key::T, + Scancode::U => imgui::Key::U, + Scancode::V => imgui::Key::V, + Scancode::W => imgui::Key::W, + Scancode::X => imgui::Key::X, + Scancode::Y => imgui::Key::Y, + Scancode::Z => imgui::Key::Z, + Scancode::Num1 => imgui::Key::Keypad1, + Scancode::Num2 => imgui::Key::Keypad2, + Scancode::Num3 => imgui::Key::Keypad3, + Scancode::Num4 => imgui::Key::Keypad4, + Scancode::Num5 => imgui::Key::Keypad5, + Scancode::Num6 => imgui::Key::Keypad6, + Scancode::Num7 => imgui::Key::Keypad7, + Scancode::Num8 => imgui::Key::Keypad8, + Scancode::Num9 => imgui::Key::Keypad9, + Scancode::Num0 => imgui::Key::Keypad0, + Scancode::Return => imgui::Key::Enter, // TODO: Should this be treated as alias? + Scancode::Escape => imgui::Key::Escape, + Scancode::Backspace => imgui::Key::Backspace, + Scancode::Tab => imgui::Key::Tab, + Scancode::Space => imgui::Key::Space, + Scancode::Minus => imgui::Key::Minus, + Scancode::Equals => imgui::Key::Equal, + Scancode::LeftBracket => imgui::Key::LeftBracket, + Scancode::RightBracket => imgui::Key::RightBracket, + Scancode::Backslash => imgui::Key::Backslash, + Scancode::Semicolon => imgui::Key::Semicolon, + Scancode::Apostrophe => imgui::Key::Apostrophe, + Scancode::Grave => imgui::Key::GraveAccent, + Scancode::Comma => imgui::Key::Comma, + Scancode::Period => imgui::Key::Period, + Scancode::Slash => imgui::Key::Slash, + Scancode::CapsLock => imgui::Key::CapsLock, + Scancode::F1 => imgui::Key::F1, + Scancode::F2 => imgui::Key::F2, + Scancode::F3 => imgui::Key::F3, + Scancode::F4 => imgui::Key::F4, + Scancode::F5 => imgui::Key::F5, + Scancode::F6 => imgui::Key::F6, + Scancode::F7 => imgui::Key::F7, + Scancode::F8 => imgui::Key::F8, + Scancode::F9 => imgui::Key::F9, + Scancode::F10 => imgui::Key::F10, + Scancode::F11 => imgui::Key::F11, + Scancode::F12 => imgui::Key::F12, + Scancode::PrintScreen => imgui::Key::PrintScreen, + Scancode::ScrollLock => imgui::Key::ScrollLock, + Scancode::Pause => imgui::Key::Pause, + Scancode::Insert => imgui::Key::Insert, + Scancode::Home => imgui::Key::Home, + Scancode::PageUp => imgui::Key::PageUp, + Scancode::Delete => imgui::Key::Delete, + Scancode::End => imgui::Key::End, + Scancode::PageDown => imgui::Key::PageDown, + Scancode::Right => imgui::Key::RightArrow, + Scancode::Left => imgui::Key::LeftArrow, + Scancode::Down => imgui::Key::DownArrow, + Scancode::Up => imgui::Key::UpArrow, + Scancode::KpDivide => imgui::Key::KeypadDivide, + Scancode::KpMultiply => imgui::Key::KeypadMultiply, + Scancode::KpMinus => imgui::Key::KeypadSubtract, + Scancode::KpPlus => imgui::Key::KeypadAdd, + Scancode::KpEnter => imgui::Key::KeypadEnter, + Scancode::Kp1 => imgui::Key::Keypad1, + Scancode::Kp2 => imgui::Key::Keypad2, + Scancode::Kp3 => imgui::Key::Keypad3, + Scancode::Kp4 => imgui::Key::Keypad4, + Scancode::Kp5 => imgui::Key::Keypad5, + Scancode::Kp6 => imgui::Key::Keypad6, + Scancode::Kp7 => imgui::Key::Keypad7, + Scancode::Kp8 => imgui::Key::Keypad8, + Scancode::Kp9 => imgui::Key::Keypad9, + Scancode::Kp0 => imgui::Key::Keypad0, + Scancode::KpPeriod => imgui::Key::KeypadDecimal, + Scancode::Application => imgui::Key::Menu, + Scancode::KpEquals => imgui::Key::KeypadEqual, + Scancode::Menu => imgui::Key::Menu, + Scancode::LCtrl => imgui::Key::LeftCtrl, + Scancode::LShift => imgui::Key::LeftShift, + Scancode::LAlt => imgui::Key::LeftAlt, + Scancode::LGui => imgui::Key::LeftSuper, + Scancode::RCtrl => imgui::Key::RightCtrl, + Scancode::RShift => imgui::Key::RightShift, + Scancode::RAlt => imgui::Key::RightAlt, + Scancode::RGui => imgui::Key::RightSuper, + _ => { + // Ignore unknown keys + return; + } + }; + + io.add_key_event(igkey, pressed); +} + +/// Handle changes in the key modifier states. +fn handle_key_modifier(io: &mut Io, keymod: &Mod) { + io.add_key_event( + imgui::Key::ModShift, + keymod.intersects(Mod::LSHIFTMOD | Mod::RSHIFTMOD), + ); + io.add_key_event( + imgui::Key::ModCtrl, + keymod.intersects(Mod::LCTRLMOD | Mod::RCTRLMOD), + ); + io.add_key_event( + imgui::Key::ModAlt, + keymod.intersects(Mod::LALTMOD | Mod::RALTMOD), + ); + io.add_key_event( + imgui::Key::ModSuper, + keymod.intersects(Mod::LGUIMOD | Mod::RGUIMOD), + ); +} + +/// Map an imgui::MouseCursor to an equivalent sdl2::mouse::SystemCursor. +fn to_sdl_cursor(cursor: MouseCursor) -> SystemCursor { + match cursor { + MouseCursor::Arrow => SystemCursor::Arrow, + MouseCursor::TextInput => SystemCursor::IBeam, + MouseCursor::ResizeAll => SystemCursor::SizeAll, + MouseCursor::ResizeNS => SystemCursor::SizeNS, + MouseCursor::ResizeEW => SystemCursor::SizeWE, + MouseCursor::ResizeNESW => SystemCursor::SizeNESW, + MouseCursor::ResizeNWSE => SystemCursor::SizeNWSE, + MouseCursor::Hand => SystemCursor::Hand, + MouseCursor::NotAllowed => SystemCursor::No, + } +} + +/// Returns `true` if the provided event is associated with the provided window. +/// +/// # Example +/// ```rust,no_run +/// # let mut event_pump: sdl2::EventPump = unimplemented!(); +/// # let window: sdl2::video::Window = unimplemented!(); +/// # let mut imgui = imgui::Context::create(); +/// # let mut platform = SdlPlatform::init(&mut imgui); +/// use imgui_sdl2_support::{SdlPlatform, filter_event}; +/// // Assuming there are multiple windows, we only want to provide the events +/// // of the window where we are rendering to imgui-rs +/// for event in event_pump.poll_iter().filter(|event| filter_event(&window, event)) { +/// platform.handle_event(&mut imgui, &event); +/// } +/// ``` +pub fn filter_event(window: &Window, event: &Event) -> bool { + Some(window.id()) == event.get_window_id() +} + +/// SDL 2 backend platform state. +/// +/// A backend platform handles window/input device events and manages their +/// state. +/// +/// There are three things you need to do to use this library correctly: +/// +/// 1. Initialize a `SdlPlatform` instance +/// 2. Pass events to the platform (every frame) +/// 3. Call frame preparation callback (every frame) +pub struct SdlPlatform { + cursor_instance: Option, /* to avoid dropping cursor instances */ + last_frame: Instant, +} + +impl SdlPlatform { + /// Initializes a SDL platform instance and configures imgui. + /// + /// This function configures imgui-rs in the following ways: + /// + /// * backend flags are updated + /// * keys are configured + /// * platform name is set + pub fn init(imgui: &mut Context) -> SdlPlatform { + let io = imgui.io_mut(); + + io.backend_flags.insert(BackendFlags::HAS_MOUSE_CURSORS); + io.backend_flags.insert(BackendFlags::HAS_SET_MOUSE_POS); + + imgui.set_platform_name(Some(format!( + "imgui-sdl2-support {}", + env!("CARGO_PKG_VERSION") + ))); + + SdlPlatform { + cursor_instance: None, + last_frame: Instant::now(), + } + } + + /// Handles a SDL event. + /// + /// This function performs the following actions (depends on the event): + /// + /// * keyboard state is updated + /// * mouse state is updated + pub fn handle_event(&mut self, context: &mut Context, event: &Event) -> bool { + let io = context.io_mut(); + + match *event { + Event::MouseWheel { x, y, .. } => { + io.add_mouse_wheel_event([x as f32, y as f32]); + true + } + + Event::MouseButtonDown { mouse_btn, .. } => { + self.handle_mouse_button(io, &mouse_btn, true); + true + } + + Event::MouseButtonUp { mouse_btn, .. } => { + self.handle_mouse_button(io, &mouse_btn, false); + true + } + + Event::TextInput { ref text, .. } => { + text.chars().for_each(|c| io.add_input_character(c)); + true + } + + Event::KeyDown { + scancode: Some(key), + keymod, + .. + } => { + handle_key_modifier(io, &keymod); + handle_key(io, &key, true); + true + } + + Event::KeyUp { + scancode: Some(key), + keymod, + .. + } => { + handle_key_modifier(io, &keymod); + handle_key(io, &key, false); + true + } + + _ => false, + } + } + + /// Frame preparation callback. + /// + /// Call this before calling the imgui-rs context `frame` function. + /// This function performs the following actions: + /// + /// * display size and the framebuffer scale is set + /// * mouse cursor is repositioned (if requested by imgui-rs) + /// * current mouse cursor position is passed to imgui-rs + /// * changes mouse cursor icon (if requested by imgui-rs) + pub fn prepare_frame( + &mut self, + context: &mut Context, + window: &Window, + event_pump: &EventPump, + ) { + let mouse_cursor = context.mouse_cursor(); + let io = context.io_mut(); + + // Update delta time + let now = Instant::now(); + io.update_delta_time(now.duration_since(self.last_frame)); + self.last_frame = now; + + let mouse_state = MouseState::new(event_pump); + let window_size = window.size(); + let window_drawable_size = window.drawable_size(); + + // Set display size and scale here, since SDL 2 doesn't have + // any easy way to get the scale factor, and changes in said + // scale factor + io.display_size = [window_size.0 as f32, window_size.1 as f32]; + io.display_framebuffer_scale = [ + (window_drawable_size.0 as f32) / (window_size.0 as f32), + (window_drawable_size.1 as f32) / (window_size.1 as f32), + ]; + + // Set mouse position if requested by imgui-rs + if io.want_set_mouse_pos { + let mouse_util = window.subsystem().sdl().mouse(); + mouse_util.warp_mouse_in_window(window, io.mouse_pos[0] as i32, io.mouse_pos[1] as i32); + } + + // Update mouse cursor position + io.mouse_pos = [mouse_state.x() as f32, mouse_state.y() as f32]; + + // Update mouse cursor icon if requested + if !io + .config_flags + .contains(ConfigFlags::NO_MOUSE_CURSOR_CHANGE) + { + let mouse_util = window.subsystem().sdl().mouse(); + + match mouse_cursor { + Some(mouse_cursor) if !io.mouse_draw_cursor => { + let cursor = Cursor::from_system(to_sdl_cursor(mouse_cursor)).unwrap(); + cursor.set(); + + mouse_util.show_cursor(true); + self.cursor_instance = Some(cursor); + } + + _ => { + mouse_util.show_cursor(false); + self.cursor_instance = None; + } + } + } + } +} + +impl SdlPlatform { + fn handle_mouse_button( + &mut self, + io: &mut Io, + button: &sdl2::mouse::MouseButton, + pressed: bool, + ) { + match button { + sdl2::mouse::MouseButton::Left => { + io.add_mouse_button_event(imgui::MouseButton::Left, pressed) + } + sdl2::mouse::MouseButton::Right => { + io.add_mouse_button_event(imgui::MouseButton::Right, pressed) + } + sdl2::mouse::MouseButton::Middle => { + io.add_mouse_button_event(imgui::MouseButton::Middle, pressed) + } + sdl2::mouse::MouseButton::X1 => { + io.add_mouse_button_event(imgui::MouseButton::Extra1, pressed) + } + sdl2::mouse::MouseButton::X2 => { + io.add_mouse_button_event(imgui::MouseButton::Extra2, pressed) + } + _ => {} + } + } +}