0.1.0 release | basic usage

Author: ArrowMaxGithub

BasicUsage.md

@@ -0,0 +1,37 @@
+## Basic Usage
+1. Enable any required virtual devices via vJoy.
+2. Start rust-vjoy-manager.exe and prepare your config. Any changes are auto-live and may be visualized by the input viewer.
+3. Save config via System -> Save config.
+4. The most recently saved config will be auto-loaded on next start.
+
+## Rebind types
+- Logical rebinds: don't modify or pipe any input, but prepare information/state which is used by reroute and virtual rebinds.
+- Reroute rebinds: pipe input from physical devices to virtual devices and may transform input (e.g. combine two buttons to one axis or apply axis offsets).
+- Virtual rebinds: act on the state of virtual devices exclusively.
+
+## Execution order
+Rebinds are processed in the order of logical -> reroute -> virtual. Within one rebind type the order is top-to-bottom.
+
+## Shift modes
+Shift modes can enable/disable rebinds and act as a bitmask.
+
+`0b00000001` enables any rebind that requires the first bit to be set.
+
+`0b00000000` disables any rebind that requires the first bit to be set.
+
+`Active mode` is the required bitmask for a rebind to be considered active.
+
+The current shift mode is found just below the `Virtual devices` label. Default mode: `0b00000001`.
+
+## Adding/Removing rebinds
+Rebinds can be added via `Add logical/reroute/virtual` buttons at the top of the rebind list.
+
+To remove/reorder a rebind, use the buttons next to the rebind.
+
+## Input viewer
+Any rebinds in the loaded configuration are live. You can visualize the input for mutliple devices at the time by clicking the physical/virtual device in the devices list.
+
+Tesselation/rendering of the input plots is quite CPU-intensive. You can minimize RVM to save resources and only process your rebinds without any rendering.
+
+## Logs/Errors
+The terminal alongside the application will log information and errors - proper file logs are in the works.

src/graphics_backend/mod.rs

@@ -41,7 +41,11 @@ impl Graphics {
         };
 
         vk_init_create_info.request_img_count = MAX_FRAMES_IN_FLIGHT as u32;
-        vk_init_create_info.present_mode = PresentModeKHR::IMMEDIATE;
+        vk_init_create_info.present_mode = if cfg!(feature = "profile") {
+            PresentModeKHR::IMMEDIATE
+        } else {
+            PresentModeKHR::FIFO
+        };
 
         let vk_init = VkInit::new(
             Some(&window.raw_display_handle()),

src/manager.rs

@@ -62,7 +62,7 @@ impl Manager {
     #[profiling::function]
     pub fn run(mut self, window: Window, event_loop: EventLoop<()>) -> ! {
         event_loop.run(move |new_event, _target, control_flow| {
-            if window.inner_size().height == 0 || window.inner_size().height == 0 {
+            if window.inner_size().width == 0 || window.inner_size().height == 0 {
                 *control_flow = ControlFlow::WaitUntil(
                     Instant::now().add(Duration::from_secs_f64(crate::input::INPUT_POLL_INTERVAL)),
                 )

src/rebind/rebind_viewer.rs

@@ -208,7 +208,7 @@ pub(crate) fn build_ui(input: &mut Input, ui: &mut Ui, _ui_data: &mut UIData) {
                             }
                         });
                         row.col(|ui| {
-                            if ui.button("Add logical").clicked() {
+                            if ui.button("Add reroute").clicked() {
                                 input.add_rebind(Rebind {
                                     name: "New reroute rebind".to_string(),
                                     mode_mask: ShiftModeMask::default(),
@@ -263,32 +263,36 @@ pub(crate) fn build_ui(input: &mut Input, ui: &mut Ui, _ui_data: &mut UIData) {
                         ui.add_space(ui.available_height());
                     });
 
-                let keep: Vec<bool> = active_rebinds_ui_wrapped.iter().map(|r| r.keep).collect();
-                let copy: Vec<Rebind> = active_rebinds_ui_wrapped
-                    .iter()
-                    .filter_map(|r| match r.copy {
-                        false => None,
-                        true => Some(r.inner.clone()),
-                    })
-                    .collect();
-                let index_mov: Vec<(usize, isize)> = active_rebinds_ui_wrapped
-                    .iter()
-                    .enumerate()
-                    .filter_map(|(index, r)| {
-                        if r.mov == 0 {
-                            None
-                        } else {
-                            Some((index, r.mov))
-                        }
-                    })
-                    .collect();
+                {
+                    profiling::scope!("RebindViewer::build_ui::PostProcess");
+                    let keep: Vec<bool> =
+                        active_rebinds_ui_wrapped.iter().map(|r| r.keep).collect();
+                    let copy: Vec<Rebind> = active_rebinds_ui_wrapped
+                        .iter()
+                        .filter_map(|r| match r.copy {
+                            false => None,
+                            true => Some(r.inner.clone()),
+                        })
+                        .collect();
+                    let index_mov: Vec<(usize, isize)> = active_rebinds_ui_wrapped
+                        .iter()
+                        .enumerate()
+                        .filter_map(|(index, r)| {
+                            if r.mov == 0 {
+                                None
+                            } else {
+                                Some((index, r.mov))
+                            }
+                        })
+                        .collect();
 
-                input.remove_rebinds_from_keep(&keep);
-                for (index, mov) in index_mov {
-                    input.move_rebind(index, mov);
-                }
+                    input.remove_rebinds_from_keep(&keep);
+                    for (index, mov) in index_mov {
+                        input.move_rebind(index, mov);
+                    }
 
-                input.duplicate_rebinds_from_copy(copy);
+                    input.duplicate_rebinds_from_copy(copy);
+                }
             });
         });
     });