Struct raylib::core::drawing::RaylibDrawHandle

pub struct RaylibDrawHandle<'a>(_);

Methods from Deref<Target = RaylibHandle>

pub fn update_camera(&self, camera: &mut Camera3D)

Updates camera position for selected mode.

pub fn is_file_dropped(&self) -> bool

Checks if a file has been dropped into the window.

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

Gets dropped filenames.

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

Detect if a key has been pressed once.

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

Detect if a key is being pressed.

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

Detect if a key has been released once.

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

Detect if a key is NOT being pressed.

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

Detect if a gamepad is available.

pub fn is_gamepad_name(&self, gamepad: i32, name: &str) -> bool

Checks gamepad name (if available).

pub fn get_gamepad_name(&self, gamepad: i32) -> Option<String>

Returns gamepad internal name id.

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

Detect if a gamepad button has been pressed once.

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

Detect if a gamepad button is being pressed.

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

Detect if a gamepad button has been released once.

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

Detect if a gamepad button is NOT being pressed.

pub fn get_gamepad_button_pressed(&self) -> Option<GamepadButton>

Gets the last gamepad button pressed.

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

Returns gamepad axis count for a gamepad.

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

Returns axis movement value for a gamepad axis.

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

Detect if a mouse button has been pressed once.

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

Detect if a mouse button is being pressed.

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

Detect if a mouse button has been released once.

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

Detect if a mouse button is NOT being pressed.

pub fn get_mouse_x(&self) -> i32

Returns mouse position X.

pub fn get_mouse_y(&self) -> i32

Returns mouse position Y.

pub fn get_mouse_position(&self) -> Vector2

Returns mouse position.

pub fn get_mouse_wheel_move(&self) -> f32

Returns mouse wheel movement Y.

pub fn get_touch_x(&self) -> i32

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

pub fn get_touch_y(&self) -> i32

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

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

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

pub fn set_gestures_enabled(&self, gesture_flags: u32)

Enables a set of gestures using flags.

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

Checks if a gesture have been detected.

pub fn get_gesture_detected(&self) -> Gestures

Gets latest detected gesture.

pub fn get_touch_points_count(&self) -> u32

Gets touch points count.

pub fn get_gesture_hold_duration(&self) -> f32

Gets gesture hold time in milliseconds.

pub fn get_gesture_drag_vector(&self) -> Vector2

Gets gesture drag vector.

pub fn get_gesture_drag_angle(&self) -> f32

Gets gesture drag angle.

pub fn get_gesture_pinch_vector(&self) -> Vector2

Gets gesture pinch delta.

pub fn get_gesture_pinch_angle(&self) -> f32

Gets gesture pinch angle.

pub fn load_material_default(&self, _: &RaylibThread) -> WeakMaterial

pub fn get_font_default(&self) -> WeakFont

Gets the default font.

pub fn get_clipboard_text(&self) -> Result<String, Utf8Error>

Get clipboard text content

pub fn get_mouse_ray(
    &self,
    mouse_position: impl Into<Vector2>,
    camera: impl Into<Camera>
) -> Ray

Returns a ray trace from mouse position

pub fn get_world_to_screen(
    &self,
    position: impl Into<Vector3>,
    camera: impl Into<Camera>
) -> Vector2

Returns the screen space position for a 3d world space position

pub fn get_world_to_screen2D(
    &self,
    position: impl Into<Vector2>,
    camera: impl Into<Camera2D>
) -> Vector2

Returns the screen space position for a 2d camera world space position

pub fn get_world_to_screen_ex(
    &self,
    position: impl Into<Vector3>,
    camera: impl Into<Camera>,
    width: i32,
    height: i32
) -> Vector2

Returns size position for a 3d world space position

pub fn get_screen_to_world2D(
    &self,
    position: impl Into<Vector2>,
    camera: impl Into<Camera2D>
) -> Vector2

Returns the world space position for a 2d camera screen space position

pub fn get_fps(&self) -> u32

Returns current FPS

pub fn get_frame_time(&self) -> f32

Returns time in seconds for last frame drawn

pub fn get_time(&self) -> f64

Returns elapsed time in seconds since InitWindow()

pub fn window_should_close(&self) -> bool

Checks if KEY_ESCAPE or Close icon was pressed.

pub fn is_window_ready(&self) -> bool

Checks if window has been initialized successfully.

pub fn is_window_minimized(&self) -> bool

Checks if window has been minimized (or lost focus).

pub fn is_window_resized(&self) -> bool

Checks if window has been resized.

pub fn is_window_hidden(&self) -> bool

Checks if window has been hidden.

pub fn is_window_fullscreen(&self) -> bool

Returns whether or not window is in fullscreen mode

pub fn is_window_focused(&self) -> bool

pub fn get_window_scale_dpi(&self) -> Vector2

Check if window is currently focused (only PLATFORM_DESKTOP)

pub fn is_cursor_on_screen(&self) -> bool

Check if cursor is on the current screen.

pub fn set_mouse_cursor(&self, cursor: MouseCursor)

Set mouse cursor

pub fn get_window_state(&self) -> WindowState

Get the window config state

pub fn set_window_title(&self, _: &RaylibThread, title: &str)

Sets title for window (only on desktop platforms).

pub fn get_screen_width(&self) -> i32

Gets current screen width.

pub fn get_screen_height(&self) -> i32

Gets current screen height.

pub fn get_window_position(&self) -> Vector2

Get window position

pub fn is_cursor_hidden(&self) -> bool

Checks if mouse cursor is not visible.

Trait Implementations

impl<'a> Deref for RaylibDrawHandle<'a>

type Target = RaylibHandle

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'a> Drop for RaylibDrawHandle<'a>

fn drop(&mut self)

Executes the destructor for this type.

impl<'a> RaylibDraw for RaylibDrawHandle<'a>

fn clear_background(&mut self, color: impl Into<Color>)

Sets background color (framebuffer clear color).

fn set_shapes_texture(
    &mut self,
    texture: impl AsRef<Texture2D>,
    source: impl Into<Rectangle>
)

Define default texture used to draw shapes

fn draw_pixel(&mut self, x: i32, y: i32, color: impl Into<Color>)

Draws a pixel.

fn draw_pixel_v(
    &mut self,
    position: impl Into<Vector2>,
    color: impl Into<Color>
)

Draws a pixel (Vector version).

fn draw_line(
    &mut self,
    start_pos_x: i32,
    start_pos_y: i32,
    end_pos_x: i32,
    end_pos_y: i32,
    color: impl Into<Color>
)

Draws a line.

fn draw_line_v(
    &mut self,
    start_pos: impl Into<Vector2>,
    end_pos: impl Into<Vector2>,
    color: impl Into<Color>
)

Draws a line (Vector version).

fn draw_line_ex(
    &mut self,
    start_pos: impl Into<Vector2>,
    end_pos: impl Into<Vector2>,
    thick: f32,
    color: impl Into<Color>
)

Draws a line with thickness.

fn draw_line_bezier(
    &mut self,
    start_pos: impl Into<Vector2>,
    end_pos: impl Into<Vector2>,
    thick: f32,
    color: impl Into<Color>
)

Draws a line using cubic-bezier curves in-out.

fn draw_line_bezier_quad(
    &mut self,
    start_pos: impl Into<Vector2>,
    end_pos: impl Into<Vector2>,
    control_pos: impl Into<Vector2>,
    thick: f32,
    color: impl Into<Color>
)

Draw line using quadratic bezier curves with a control point

fn draw_line_strip(&mut self, points: &[Vector2], color: impl Into<Color>)

Draw lines sequence

fn draw_circle(
    &mut self,
    center_x: i32,
    center_y: i32,
    radius: f32,
    color: impl Into<Color>
)

Draws a color-filled circle.

fn draw_circle_sector(
    &mut self,
    center: impl Into<Vector2>,
    radius: f32,
    start_angle: f32,
    end_angle: f32,
    segments: i32,
    color: impl Into<Color>
)

Draw a piece of a circle

fn draw_circle_sector_lines(
    &mut self,
    center: impl Into<Vector2>,
    radius: f32,
    start_angle: f32,
    end_angle: f32,
    segments: i32,
    color: impl Into<Color>
)

Draw circle sector outline

fn draw_circle_gradient(
    &mut self,
    center_x: i32,
    center_y: i32,
    radius: f32,
    color1: impl Into<Color>,
    color2: impl Into<Color>
)

Draws a gradient-filled circle.

fn draw_circle_v(
    &mut self,
    center: impl Into<Vector2>,
    radius: f32,
    color: impl Into<Color>
)

Draws a color-filled circle (Vector version).

fn draw_circle_lines(
    &mut self,
    center_x: i32,
    center_y: i32,
    radius: f32,
    color: impl Into<Color>
)

Draws circle outline.

fn draw_ellipse(
    &mut self,
    center_x: i32,
    center_y: i32,
    radius_h: f32,
    radius_v: f32,
    color: impl Into<Color>
)

Draws ellipse.

fn draw_ellipse_lines(
    &mut self,
    center_x: i32,
    center_y: i32,
    radius_h: f32,
    radius_v: f32,
    color: impl Into<Color>
)

Draws ellipse.

fn draw_ring(
    &mut self,
    center: impl Into<Vector2>,
    inner_radius: f32,
    outer_radius: f32,
    start_angle: f32,
    end_angle: f32,
    segments: i32,
    color: impl Into<Color>
)

Draw ring

fn draw_ring_lines(
    &mut self,
    center: impl Into<Vector2>,
    inner_radius: f32,
    outer_radius: f32,
    start_angle: f32,
    end_angle: f32,
    segments: i32,
    color: impl Into<Color>
)

Draw ring lines

fn draw_rectangle(
    &mut self,
    x: i32,
    y: i32,
    width: i32,
    height: i32,
    color: impl Into<Color>
)

Draws a color-filled rectangle.

fn draw_rectangle_v(
    &mut self,
    position: impl Into<Vector2>,
    size: impl Into<Vector2>,
    color: impl Into<Color>
)

Draws a color-filled rectangle (Vector version).

fn draw_rectangle_rec(
    &mut self,
    rec: impl Into<Rectangle>,
    color: impl Into<Color>
)

Draws a color-filled rectangle from rec.

fn draw_rectangle_pro(
    &mut self,
    rec: impl Into<Rectangle>,
    origin: impl Into<Vector2>,
    rotation: f32,
    color: impl Into<Color>
)

Draws a color-filled rectangle with pro parameters.

fn draw_rectangle_gradient_v(
    &mut self,
    x: i32,
    y: i32,
    width: i32,
    height: i32,
    color1: impl Into<Color>,
    color2: impl Into<Color>
)

Draws a vertical-gradient-filled rectangle.

fn draw_rectangle_gradient_h(
    &mut self,
    x: i32,
    y: i32,
    width: i32,
    height: i32,
    color1: impl Into<Color>,
    color2: impl Into<Color>
)

Draws a horizontal-gradient-filled rectangle.

fn draw_rectangle_gradient_ex(
    &mut self,
    rec: impl Into<Rectangle>,
    col1: impl Into<Color>,
    col2: impl Into<Color>,
    col3: impl Into<Color>,
    col4: impl Into<Color>
)

Draws a gradient-filled rectangle with custom vertex colors.

fn draw_rectangle_lines(
    &mut self,
    x: i32,
    y: i32,
    width: i32,
    height: i32,
    color: impl Into<Color>
)

Draws rectangle outline.

fn draw_rectangle_lines_ex(
    &mut self,
    rec: impl Into<Rectangle>,
    line_thick: i32,
    color: impl Into<Color>
)

Draws rectangle outline with extended parameters.

fn draw_rectangle_rounded(
    &mut self,
    rec: impl Into<Rectangle>,
    roundness: f32,
    segments: i32,
    color: impl Into<Color>
)

Draws rectangle outline with extended parameters.

fn draw_rectangle_rounded_lines(
    &mut self,
    rec: impl Into<Rectangle>,
    roundness: f32,
    segments: i32,
    line_thickness: i32,
    color: impl Into<Color>
)

Draws rectangle outline with extended parameters.

fn draw_triangle(
    &mut self,
    v1: impl Into<Vector2>,
    v2: impl Into<Vector2>,
    v3: impl Into<Vector2>,
    color: impl Into<Color>
)

Draws a triangle.

fn draw_triangle_lines(
    &mut self,
    v1: impl Into<Vector2>,
    v2: impl Into<Vector2>,
    v3: impl Into<Vector2>,
    color: impl Into<Color>
)

Draws a triangle using lines.

fn draw_triangle_fan(&mut self, points: &[Vector2], color: impl Into<Color>)

Draw a triangle fan defined by points.

fn draw_triangle_strip(&mut self, points: &[Vector2], color: impl Into<Color>)

Draw a triangle strip defined by points

fn draw_poly(
    &mut self,
    center: impl Into<Vector2>,
    sides: i32,
    radius: f32,
    rotation: f32,
    color: impl Into<Color>
)

Draws a regular polygon of n sides (Vector version).

fn draw_poly_lines(
    &mut self,
    center: impl Into<Vector2>,
    sides: i32,
    radius: f32,
    rotation: f32,
    color: impl Into<Color>
)

Draws a regular polygon of n sides (Vector version).

fn draw_texture(
    &mut self,
    texture: impl AsRef<Texture2D>,
    x: i32,
    y: i32,
    tint: impl Into<Color>
)

Draws a texture using specified position and tint color.

fn draw_texture_v(
    &mut self,
    texture: impl AsRef<Texture2D>,
    position: impl Into<Vector2>,
    tint: impl Into<Color>
)

Draws a texture using specified position vector and tint color.

fn draw_texture_ex(
    &mut self,
    texture: impl AsRef<Texture2D>,
    position: impl Into<Vector2>,
    rotation: f32,
    scale: f32,
    tint: impl Into<Color>
)

Draws a texture with extended parameters.

fn draw_texture_rec(
    &mut self,
    texture: impl AsRef<Texture2D>,
    source_rec: impl Into<Rectangle>,
    position: impl Into<Vector2>,
    tint: impl Into<Color>
)

Draws from a region of texture defined by the source_rec rectangle.

fn draw_texture_quad(
    &mut self,
    texture: impl AsRef<Texture2D>,
    tiling: impl Into<Vector2>,
    offset: impl Into<Vector2>,
    quad: impl Into<Rectangle>,
    tint: impl Into<Color>
)

Draw texture quad with tiling and offset parameters

fn draw_texture_pro(
    &mut self,
    texture: impl AsRef<Texture2D>,
    source_rec: impl Into<Rectangle>,
    dest_rec: impl Into<Rectangle>,
    origin: impl Into<Vector2>,
    rotation: f32,
    tint: impl Into<Color>
)

Draw from a region of texture defined by the source_rec rectangle with pro parameters.

fn draw_texture_tiled(
    &mut self,
    texture: impl AsRef<Texture2D>,
    source_rec: impl Into<Rectangle>,
    dest_rec: impl Into<Rectangle>,
    origin: impl Into<Vector2>,
    rotation: f32,
    scale: f32,
    tint: impl Into<Color>
)

Draw part of a texture (defined by a rectangle) with rotation and scale tiled into dest.

fn draw_texture_n_patch(
    &mut self,
    texture: impl AsRef<Texture2D>,
    n_patch_info: impl Into<NPatchInfo>,
    dest_rec: impl Into<Rectangle>,
    origin: impl Into<Vector2>,
    rotation: f32,
    tint: impl Into<Color>
)

Draws a texture (or part of it) that stretches or shrinks nicely

fn draw_texture_poly(
    &mut self,
    texture: impl AsRef<Texture2D>,
    center: impl Into<Vector2>,
    points: &[Vector2],
    texcoords: &[Vector2],
    tint: impl Into<Color>
)

Draws a texture (or part of it) that stretches or shrinks nicely

fn draw_fps(&mut self, x: i32, y: i32)

Shows current FPS.

fn draw_text(
    &mut self,
    text: &str,
    x: i32,
    y: i32,
    font_size: i32,
    color: impl Into<Color>
)

Draws text (using default font).

fn draw_text_ex(
    &mut self,
    font: impl AsRef<Font>,
    text: &str,
    position: impl Into<Vector2>,
    font_size: f32,
    spacing: f32,
    tint: impl Into<Color>
)

Draws text using font and additional parameters.

fn draw_text_rec(
    &mut self,
    font: impl AsRef<Font>,
    text: &str,
    rec: impl Into<Rectangle>,
    font_size: f32,
    spacing: f32,
    word_wrap: bool,
    tint: impl Into<Color>
)

Draws text using font and additional parameters.

fn draw_text_rec_ex(
    &mut self,
    font: impl AsRef<Font>,
    text: &str,
    rec: impl Into<Rectangle>,
    font_size: f32,
    spacing: f32,
    word_wrap: bool,
    tint: impl Into<Color>,
    select_start: i32,
    select_length: i32,
    select_text: impl Into<Color>,
    select_back: impl Into<Color>
)

Draws text using font and additional parameters.

fn draw_text_codepoint(
    &mut self,
    font: impl AsRef<Font>,
    codepoint: i32,
    position: impl Into<Vector2>,
    scale: f32,
    tint: impl Into<Color>
)

Draw one character (codepoint)

impl<'a> RaylibTextureModeExt for RaylibDrawHandle<'a>

fn begin_texture_mode<'a>(
    &'a mut self,
    _: &RaylibThread,
    framebuffer: &'a mut RenderTexture2D
) -> RaylibTextureMode<'_, Self>