dgews 0.1.4

Easy multithreaded toy windowing system for learning purposes only
Documentation

DGEWS

DGEWS DGEWS

DGEWS is a simple multithreaded toy windowing system for only learning purposes.

[dependencies]
dgews="0.1.4"

DGEWS is an ordinary window manager for only Windows users. It is pretty simple and straightforward so that anyone can understand and sometimes learn something from it. Indead, my goal is actually to learn the cycle of programming a practical crates and the developement of them.


Usage

DGEWS usues the c++ win32 api library wrapper winapi to build its windows. Therefore, anyone else except for Windows OS users cannot use this crate. Currently, this crate is not stable and crashes sometimes, that is why it is better not to use it in production (though I think nobody will use it while winit crate is ready to use). But, if someone wants to use some of its features in their own projects, just take it as I have stated that it is only for educational purposes.


Example

Manager is a central point of this crate: it processes everything and users retrieve the event messages from it. Moreover, window or windows are created with that. The run() method accepts a closure that must be called in each event and users will be given events, the manager itself as well as the control flow of that main events loop

extern crate dgews;
use dgews::prelude::*; // prelude module contains everything

fn main() {
    let mut manager = Manager::new(WindowBuilder::default()
            .with_title("DGEWS Window")
            .with_dimensions(800, 640)
            .with_theme(Theme::Dark)
            .with_resizable(true))
        .add_window("Hooray", WindowBuilder::new()
            .with_title("Finally")
            .with_dimensions(400, 300)
            .with_theme(Theme::Dark)
            .with_pos(700, 700));

    let _hwnd = manager.window().unwrap();

    manager.run(|events, control_flow, manager| {
        match events {
            Events::WindowEvents { id, event } => match event {
                WindowEvents::Create => println!("[INFO]: a new window with id: {} has been created", id),

                WindowEvents::Close => {
                    println!("[INFO]: a window with id: {} has been closed", id);
                    *control_flow = ControlFlow::Exit; // to exit with panicing, use ControlFlow::ExitWithCode(<your number>) instead.
                },

                WindowEvents::SetFocus => println!("[INFO]: window with id: {} gained the focus", id),

                WindowEvents::LostFocus => println!("[INFO]: window with id: {} Lost the focus", id),

                _=> {}
            },

            Events::MouseEvents { id: _, event } => match event {
                MouseEvents::MouseMove { x, y, last_x, last_y, dx, dy } => {
                    println!("[INFO]: mouse moved in the window with id {}: x={}, y={}, last_x={}, last_y={} dx={} dy={};", manager.window().unwrap().get_id(), x, y, last_x, last_y, dx, dy);
                },
                
                _=> {}
            }

            _=> *control_flow = ControlFlow::Continue,
        }

        if manager.get_key(Key::ESCAPE) == Action::Release {
            println!("[INFO]: program is exiting");
            *control_flow = ControlFlow::Exit;
        }
    });
}

Features

current features

  • Multithreaded: windows have their own threads and they send messages from there so that when the user is interacting, windows will be still refreshing without waiting for the user to finish their event;
  • Winit stylish style: when I saw the winit crate first time, I really liked it for its structure. Thus, I decided to make something that resembles it;
  • Icons: users can use their own icons;
  • Themes: there is now only light and dark themes;
  • Ready events processing: it actually needs some work there 🤷‍♂️;
  • Easy: a glance of attention to the documentation is enough to utilize the crate;
  • HasRawWindowHandle and HasRawDisplayHandle traits are implemeneted so that you can use them with other crates such as wgpu-rs;

and its glitches and shortcomings

  • Not ready yet: it is only in alpha mode;
  • System keys error: I don't know why but some system keys such as Alt key are not working properly;
  • Crashes: actually the reason I like rust lang is because it is very fast and safe at the time. However, I think due to the lack of my experience in multithreaded programming, I have lost that feature of having something working 100% all the time;
  • Not cross-platform: I have used the Windows api crate, so no cross-platform support 😔;

plans

  • Better documentation: I think it has 'pretty nice' documentation. But still there is more to make it even better and more user-friendly.
  • Fix the bugs: I am working on the issues like with the system keys or the window not opening,

Contributions

Everyone is welcome who are willing to contribute even to the documentation. Thanks in advance. Contact me via:


I am a student of a lyceum that is why I think you won't get the response immediately, however, I will try my best to reply back as soon as possible.


Licenses

  1. The MIT License
  2. The APACHE 2.0 License