Struct Raylib

pub struct Raylib(/* private fields */);

Main raylib handle

Implementations

impl Raylib

pub fn init_window(width: u32, height: u32, title: &str) -> Option<Self>

Initialize window and OpenGL context

pub fn init_window_ex( width: u32, height: u32, title: &str, flags: ConfigFlags, ) -> Option<Self>

Initialize window and OpenGL context with config flags

pub fn window_should_close(&self) -> bool

Check if Escape key or Close icon is pressed

pub fn close_window(self)

Close window and unload OpenGL context

pub fn is_window_fullscreen(&self) -> bool

Check if window is currently fullscreen

pub fn is_window_hidden(&self) -> bool

Check if window is currently hidden (only PLATFORM_DESKTOP)

pub fn is_window_minimized(&self) -> bool

Check if window is currently minimized (only PLATFORM_DESKTOP)

pub fn is_window_maximized(&self) -> bool

Check if window is currently maximized (only PLATFORM_DESKTOP)

pub fn is_window_focused(&self) -> bool

Check if window is currently focused (only PLATFORM_DESKTOP)

pub fn is_window_resized(&self) -> bool

Check if window has been resized last frame

pub fn is_window_state(&self, flag: ConfigFlags) -> bool

Check if one specific window flag is enabled

pub fn set_window_state(&mut self, flags: ConfigFlags)

Set window configuration state using flags (only PLATFORM_DESKTOP)

pub fn clear_window_state(&mut self, flags: ConfigFlags)

Clear window configuration state flags

pub fn toggle_fullscreen(&mut self)

Toggle window state: fullscreen/windowed (only PLATFORM_DESKTOP)

pub fn maximize_window(&mut self)

Set window state: maximized, if resizable (only PLATFORM_DESKTOP)

pub fn minimize_window(&mut self)

Set window state: minimized, if resizable (only PLATFORM_DESKTOP)

pub fn restore_window(&mut self)

Set window state: not minimized/maximized (only PLATFORM_DESKTOP)

pub fn set_window_icon(&mut self, image: &Image)

Set icon for window (single image, RGBA 32bit, only PLATFORM_DESKTOP)

pub fn set_window_icons(&mut self, images: &[&Image])

Set icon for window (multiple images, RGBA 32bit, only PLATFORM_DESKTOP)

pub fn set_window_title(&mut self, title: &str)

Set title for window (only PLATFORM_DESKTOP)

pub fn set_window_position(&mut self, x: i32, y: i32)

Set window position on screen (only PLATFORM_DESKTOP)

pub fn set_window_monitor(&mut self, monitor: u32)

Set monitor for the current window (fullscreen mode)

pub fn set_window_min_size(&mut self, width: u32, height: u32)

Set window minimum dimensions (for FLAG_WINDOW_RESIZABLE)

pub fn set_window_size(&mut self, width: u32, height: u32)

Set window dimensions

pub fn set_window_opacity(&mut self, opacity: f32)

Set window opacity [0.0f..1.0f] (only PLATFORM_DESKTOP)

pub fn get_window_handle(&self) -> *mut c_void

Get native window handle

pub fn get_screen_width(&self) -> u32

Get current screen width

pub fn get_screen_height(&self) -> u32

Get current screen height

pub fn get_render_width(&self) -> u32

Get current render width (it considers HiDPI)

pub fn get_render_height(&self) -> u32

Get current render height (it considers HiDPI)

pub fn get_monitor_count(&self) -> u32

Get number of connected monitors

pub fn get_current_monitor(&self) -> u32

Get current connected monitor

pub fn get_monitor_position(&self, monitor: u32) -> Vector2

Get specified monitor position

pub fn get_monitor_width(&self, monitor: u32) -> u32

Get specified monitor width (current video mode used by monitor)

pub fn get_monitor_height(&self, monitor: u32) -> u32

Get specified monitor height (current video mode used by monitor)

pub fn get_monitor_physical_width(&self, monitor: u32) -> u32

Get specified monitor physical width in millimetres

pub fn get_monitor_physical_height(&self, monitor: u32) -> u32

Get specified monitor physical height in millimetres

pub fn get_monitor_refresh_rate(&self, monitor: u32) -> u32

Get specified monitor refresh rate

pub fn get_window_position(&self) -> Vector2

Get window position XY on monitor

pub fn get_window_scale_dpi(&self) -> Vector2

Get window scale DPI factor

pub fn get_monitor_name(&self, monitor: u32) -> String

Get the human-readable, UTF-8 encoded name of the primary monitor

pub fn set_clipboard_text(&mut self, text: &str)

Set clipboard text content

pub fn get_clipboard_text(&self) -> String

Get clipboard text content

pub fn enable_event_waiting(&mut self)

Enable waiting for events on EndDrawing(), no automatic event polling

pub fn disable_event_waiting(&mut self)

Disable waiting for events on EndDrawing(), automatic events polling

pub fn swap_screen_buffer(&mut self)

Swap back buffer with front buffer (screen drawing) NOTE: Those functions are intended for advance users that want full control over the frame processing

pub fn poll_input_events(&mut self)

Register all input events NOTE: Those functions are intended for advance users that want full control over the frame processing

pub fn wait_time(&mut self, duration: Duration)

Wait for some time (halt program execution) NOTE: Those functions are intended for advance users that want full control over the frame processing

pub fn show_cursor(&mut self)

Shows cursor

pub fn hide_cursor(&mut self)

Hides cursor

pub fn is_cursor_hidden(&self) -> bool

Check if cursor is not visible

pub fn enable_cursor(&mut self)

Enables cursor (unlock cursor)

pub fn disable_cursor(&mut self)

Disables cursor (lock cursor)

pub fn is_cursor_on_screen(&self) -> bool

Check if cursor is on the screen

pub fn set_target_fps(&mut self, fps: u32)

Set target FPS (maximum)

pub fn get_fps(&self) -> u32

Get current FPS

pub fn get_frame_time(&self) -> Duration

Get time for last frame drawn (delta time)

pub fn get_time(&self) -> Duration

Get elapsed time since InitWindow()

pub fn get_random_value(&self, min: i32, max: i32) -> i32

Get a random value between min and max (both included)

pub fn set_random_seed(&mut self, seed: u32)

Set the seed for the random number generator

pub fn take_screenshot(&mut self, file_name: &str)

Takes a screenshot of current screen (file_name extension defines format)

pub fn open_url(&self, url: &str)

Open URL with default system browser (if available)

pub fn is_file_dropped(&self) -> bool

Check if a file has been dropped into window

pub fn get_dropped_files(&self) -> Vec<String>

Load dropped filepaths

pub fn is_key_pressed(&self, key: KeyboardKey) -> bool

Check if a key has been pressed once

pub fn is_key_down(&self, key: KeyboardKey) -> bool

Check if a key is being pressed

pub fn is_key_released(&self, key: KeyboardKey) -> bool

Check if a key has been released once

pub fn is_key_up(&self, key: KeyboardKey) -> bool

Check if a key is NOT being pressed

pub fn set_exit_key(&mut self, key: KeyboardKey)

Set a custom key to exit program (default is ESC)

pub fn get_key_pressed(&self) -> KeyboardKey

Get key pressed (keycode), call it multiple times for keys queued, returns KeyboardKey::Null when the queue is empty

pub fn get_char_pressed(&self) -> Option<char>

Get char pressed (unicode), call it multiple times for chars queued, returns None when the queue is empty

pub fn is_gamepad_available(&self, gamepad: u32) -> bool

Check if a gamepad is available

pub fn get_gamepad_name(&self, gamepad: u32) -> String

Get gamepad internal name id

pub fn is_gamepad_button_pressed( &self, gamepad: u32, button: GamepadButton, ) -> bool

Check if a gamepad button has been pressed once

pub fn is_gamepad_button_down( &self, gamepad: u32, button: GamepadButton, ) -> bool

Check if a gamepad button is being pressed

pub fn is_gamepad_button_released( &self, gamepad: u32, button: GamepadButton, ) -> bool

Check if a gamepad button has been released once

pub fn is_gamepad_button_up(&self, gamepad: u32, button: GamepadButton) -> bool

Check if a gamepad button is NOT being pressed

pub fn get_gamepad_button_pressed(&self) -> GamepadButton

Get the last gamepad button pressed

pub fn get_gamepad_axis_count(&self, gamepad: u32) -> u32

Get gamepad axis count for a gamepad

pub fn get_gamepad_axis_movement(&self, gamepad: u32, axis: GamepadAxis) -> f32

Get axis movement value for a gamepad axis

pub fn set_gamepad_mappings(&mut self, mappings: &str) -> i32

Set internal gamepad mappings (SDL_GameControllerDB)

pub fn is_mouse_button_pressed(&self, button: MouseButton) -> bool

Check if a mouse button has been pressed once

pub fn is_mouse_button_down(&self, button: MouseButton) -> bool

Check if a mouse button is being pressed

pub fn is_mouse_button_released(&self, button: MouseButton) -> bool

Check if a mouse button has been released once

pub fn is_mouse_button_up(&self, button: MouseButton) -> bool

Check if a mouse button is NOT being pressed

pub fn get_mouse_x(&self) -> i32

Get mouse position X

pub fn get_mouse_y(&self) -> i32

Get mouse position Y

pub fn get_mouse_position(&self) -> Vector2

Get mouse position XY

pub fn get_mouse_delta(&self) -> Vector2

Get mouse delta between frames

pub fn set_mouse_position(&mut self, x: i32, y: i32)

Set mouse position XY

pub fn set_mouse_offset(&mut self, offset_x: i32, offset_y: i32)

Set mouse offset

pub fn set_mouse_scale(&mut self, scale_x: f32, scale_y: f32)

Set mouse scaling

pub fn get_mouse_wheel_move(&self) -> f32

Get mouse wheel movement for X or Y, whichever is larger

pub fn get_mouse_wheel_move_vec(&self) -> Vector2

Get mouse wheel movement for both X and Y

pub fn set_mouse_cursor(&mut self, cursor: MouseCursor)

Set mouse cursor

pub fn get_touch_x(&self) -> i32

Get touch position X for touch point 0 (relative to screen size)

pub fn get_touch_y(&self) -> i32

Get touch position Y for touch point 0 (relative to screen size)

pub fn get_touch_position(&self, index: u32) -> Vector2

Get touch position XY for a touch point index (relative to screen size)

pub fn get_touch_point_id(&self, index: u32) -> u32

Get touch point identifier for given index

pub fn get_touch_point_count(&self) -> u32

Get number of touch points

pub fn set_gestures_enabled(&mut self, flags: Gesture)

Enable a set of gestures using flags

pub fn is_gesture_detected(&self, gesture: Gesture) -> bool

Check if a gesture have been detected

pub fn get_gesture_detected(&self) -> Gesture

Get latest detected gesture

pub fn get_gesture_hold_duration(&self) -> Duration

Get gesture hold time

pub fn get_gesture_drag_vector(&self) -> Vector2

Get gesture drag vector

pub fn get_gesture_drag_angle(&self) -> f32

Get gesture drag angle

pub fn get_gesture_pinch_vector(&self) -> Vector2

Get gesture pinch delta

pub fn get_gesture_pinch_angle(&self) -> f32

Get gesture pinch angle

pub fn begin_drawing(&mut self) -> DrawHandle<'_>

Setup canvas (framebuffer) to start drawing

pub fn set_trace_log_level(&mut self, level: TraceLogLevel)

Set the current threshold (minimum) log level (for raylib’s own logging)

Trait Implementations

impl Debug for Raylib

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

Formats the value using the given formatter.

impl Drop for Raylib

fn drop(&mut self)

Executes the destructor for this type.