Struct chess::ChessGui

pub struct ChessGui { /* private fields */ }

A wrapper of Chess for GUI.

Implementations

impl ChessGui

pub fn new(chess: Chess, theme: Theme, buttons: Vec<Button>) -> Self

Create a new instance of ChessGui.

pub fn set_theme(&mut self, theme: Theme)

Set the theme for the GUI.

Examples

use chess::{ChessGui, THEME_SANDCASTLE};

let mut game = ChessGui::default();
game.set_theme(THEME_SANDCASTLE);

pub unsafe fn next_theme(&mut self)

Set the theme to the next one for the GUI.

Safety

This function use/set a static variable.

pub fn add_button(&mut self, button: Button)

Add a button in the GUI.

Trait Implementations

impl Debug for ChessGui

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ChessGui

fn default() -> Self

Returns the “default value” for a type.

impl EventHandler<GameError> for ChessGui

fn update(&mut self, _ctx: &mut Context) -> GameResult

Update will happen on every frame before it is drawn.

fn draw(&mut self, ctx: &mut Context) -> GameResult

Render the game’s current state.

fn mouse_button_down_event(
    &mut self,
    _ctx: &mut Context,
    button: MouseButton,
    x: f32,
    y: f32
)

Called every time a mouse button gets pressed

fn key_down_event(
    &mut self,
    ctx: &mut Context,
    keycode: KeyCode,
    keymod: KeyMods,
    _repeat: bool
)

Called every time a key gets pressed.

Keys

Keys	Actions
Escape	Quit the game
R	Reset the game
CTRL+Z	Undo

fn mouse_button_up_event(
    &mut self,
    _ctx: &mut Context,
    _button: MouseButton,
    _x: f32,
    _y: f32
)

A mouse button was released

fn mouse_motion_event(
    &mut self,
    _ctx: &mut Context,
    _x: f32,
    _y: f32,
    _dx: f32,
    _dy: f32
)

The mouse was moved; it provides both absolute x and y coordinates in the window, and relative x and y coordinates compared to its last position.

fn mouse_enter_or_leave(&mut self, _ctx: &mut Context, _entered: bool)

mouse entered or left window area

fn mouse_wheel_event(&mut self, _ctx: &mut Context, _x: f32, _y: f32)

The mousewheel was scrolled, vertically (y, positive away from and negative toward the user) or horizontally (x, positive to the right and negative to the left).

fn key_up_event(
    &mut self,
    _ctx: &mut Context,
    _keycode: VirtualKeyCode,
    _keymods: KeyMods
)

A keyboard button was released.

fn text_input_event(&mut self, _ctx: &mut Context, _character: char)

A unicode character was received, usually from keyboard input. This is the intended way of facilitating text input.

fn gamepad_button_down_event(
    &mut self,
    _ctx: &mut Context,
    _btn: Button,
    _id: GamepadId
)

A gamepad button was pressed; id identifies which gamepad. Use input::gamepad() to get more info about the gamepad.

fn gamepad_button_up_event(
    &mut self,
    _ctx: &mut Context,
    _btn: Button,
    _id: GamepadId
)

A gamepad button was released; id identifies which gamepad. Use input::gamepad() to get more info about the gamepad.

fn gamepad_axis_event(
    &mut self,
    _ctx: &mut Context,
    _axis: Axis,
    _value: f32,
    _id: GamepadId
)

A gamepad axis moved; id identifies which gamepad. Use input::gamepad() to get more info about the gamepad.

fn focus_event(&mut self, _ctx: &mut Context, _gained: bool)

Called when the window is shown or hidden.

fn quit_event(&mut self, _ctx: &mut Context) -> bool

Called upon a quit event. If it returns true, the game does not exit (the quit event is cancelled).

fn resize_event(&mut self, _ctx: &mut Context, _width: f32, _height: f32)

Called when the user resizes the window, or when it is resized via graphics::set_mode().

fn on_error(&mut self, _ctx: &mut Context, _origin: ErrorOrigin, _e: E) -> bool

Something went wrong, causing a GameError. If this returns true, the error was fatal, so the event loop ends, aborting the game.