Skip to main content

flake/
prelude.rs

1#![allow(unused)]
2
3//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
4
5pub use crate::camera::camera2d::Camera2D;
6pub use crate::camera::render_target::RenderTarget;
7use crate::draw_state::shapes::Shape;
8pub use crate::draw_state::shapes::color::*;
9pub use crate::end_frame;
10use crate::global::{PENDING_CONFIG, STATE, ctx};
11pub use crate::misc::flake_image::Image;
12use crate::misc::font::Font;
13pub use crate::misc::math::*;
14pub use crate::misc::rect::Rect;
15use crate::misc::span::RichtextSection;
16pub use crate::misc::span::Span;
17pub use crate::misc::timer::Timer;
18pub use crate::misc::*;
19use crate::model::instance::Instance;
20pub use crate::model::texture::DrawTextureParams;
21pub use crate::model::texture::FilterType;
22use crate::model::texture::{GpuTexture, Texture};
23pub use crate::runtime::next_frame::next_frame;
24pub use crate::{FlakeResult, flake};
25use image::{DynamicImage, GenericImageView, ImageBuffer, Rgb, Rgba};
26use std::borrow::Borrow;
27use std::sync::{Arc, Mutex};
28use wgpu::{CommandEncoder, Device, Queue, SurfaceConfiguration, TextureView};
29pub use winit::event::MouseButton;
30pub use winit::event::WindowEvent;
31pub use winit::keyboard::KeyCode;
32#[cfg(target_os = "windows")]
33use winit::platform::windows::WindowExtWindows;
34use winit::window::Window;
35pub use winit::window::{CursorIcon, WindowButtons, WindowLevel};
36// -- Out-facing API --------------------------------------------------------------------------------------------------------------
37
38/// Exits the running application, must be called while running.
39///
40/// # Examples
41///
42/// ```
43/// flake_quit();
44/// ```
45pub fn flake_quit() {
46    ctx(|s| s.exit())
47}
48
49/// Sleeps (waits) for a set amount of seconds.
50/// (Will pause the window thread as well)
51/// App may become "not responding" if time is too high.
52/// Good for games like tetris/snake.
53///
54/// # Examples
55///
56/// ```
57/// flake_sleep(0.1);
58/// ```
59pub fn flake_sleep(seconds: f32) {
60    std::thread::sleep(std::time::Duration::from_secs_f32(seconds));
61}
62
63/// Creates a `Timer` whose time goes down each frame. Can be paused. Check `Timer` docs for more info.
64///
65/// # Examples
66///
67/// ```
68/// let mut my_timer = add_timer(Timer::new(5.0));
69///
70/// my_timer.on_completed(|| {
71///     println!("Timer got completed");
72/// });
73/// ```
74pub fn add_timer(timer: Timer) -> Timer {
75    if STATE.get().is_some() {
76        return ctx(|s| {
77            if !s.timers.contains(&timer) {
78                s.add_timer(timer.clone());
79            }
80            timer
81        });
82    }
83
84    PENDING_CONFIG.with_borrow_mut(|s| {
85        if !s.timers.contains(&timer) {
86            s.timers.push(timer.clone())
87        }
88    });
89
90    timer
91}
92
93/// Gets the winit window used by the application
94///
95/// # Examples
96///
97/// ```
98/// let win = get_window();
99/// win.set_transparent(true);
100/// ```
101pub fn get_window() -> Arc<Window> {
102    ctx(|s| s.get_window())
103}
104
105/// Gets the wgpu device used by the application
106///
107/// # Examples
108///
109/// ```
110/// let device = get_device();
111/// ```
112pub fn get_device() -> Arc<Device> {
113    ctx(|s| s.device.clone())
114}
115
116/// Gets the wgpu queue used by the application
117///
118/// # Examples
119///
120/// ```
121/// let queue = get_queue();
122/// ```
123pub fn get_queue() -> Queue {
124    ctx(|s| s.queue.clone())
125}
126
127/// Adds a post render hook to the application.
128/// Binds a closure which will run before submitting the queue.
129///
130/// # Examples
131///
132/// ```
133/// let queue = get_queue();
134/// ```
135pub fn add_post_render_hook(
136    hook: impl FnMut(&Device, &Queue, &mut CommandEncoder, &TextureView, (u32, u32)) + 'static,
137) {
138    ctx(|s| s.post_render_hooks.push(Box::new(hook)));
139}
140
141/// Gets the wgpu surface config used by the application
142///
143/// # Examples
144///
145/// ```
146/// let config = get_surface_config();
147/// ```
148pub fn get_surface_config() -> Arc<Mutex<SurfaceConfiguration>> {
149    ctx(|s| s.config.clone())
150}
151
152/// Gets the window events that happened this frame
153///
154/// # Examples
155///
156/// ```
157/// let events = get_window_events();
158/// ```
159pub fn get_window_events() -> Vec<WindowEvent> {
160    ctx(|s| s.event_list.clone())
161}
162
163/// Sets whether window catches mouse events.
164pub fn set_window_passthrough(passthrough: bool) {
165    if STATE.get().is_some() {
166        return ctx(|s| s.set_window_passthrough(passthrough));
167    }
168
169    PENDING_CONFIG.with_borrow_mut(|s| s.window_passthrough = Some(passthrough));
170}
171
172/// Sets whether the window is AlwaysOnTop, AlwaysOnBottom, or Normal
173pub fn set_window_level(level: WindowLevel) {
174    if STATE.get().is_some() {
175        return ctx(|s| s.set_window_level(level));
176    }
177
178    PENDING_CONFIG.with_borrow_mut(|s| s.window_level = Some(level));
179}
180
181/// Sets which window buttons are enabled. Any button not included is disabled
182/// (e.g. `WindowButtons::CLOSE` leaves only the close button).
183pub fn set_window_enabled_buttons(window_buttons: WindowButtons) {
184    ctx(|s| s.get_window().set_enabled_buttons(window_buttons));
185}
186
187/// Sets whether the app is shown or not shown (skipped) in the taskbar
188pub fn set_skip_taskbar(skip: bool) {
189    if STATE.get().is_some() {
190        #[cfg(target_os = "windows")]
191        return ctx(|s| s.window.set_skip_taskbar(skip));
192    }
193
194    PENDING_CONFIG.with_borrow_mut(|s| s.skip_taskbar = Some(skip));
195}
196
197/// Sets whether the window is transparent.
198/// **Run this before `flake::run()`** as it might not work after the window has been created.
199pub fn set_window_transparent(transparent: bool) {
200    if STATE.get().is_some() {
201        return get_window().set_transparent(transparent);
202    }
203
204    PENDING_CONFIG.with_borrow_mut(|s| s.window_transparent = Some(transparent));
205}
206
207/// Sets whether the window decorations (titlebar, border, etc.) are enabled
208pub fn set_window_decorations(enabled: bool) {
209    if STATE.get().is_some() {
210        return get_window().set_decorations(enabled);
211    }
212
213    PENDING_CONFIG.with_borrow_mut(|s| s.window_decorations = Some(enabled));
214}
215
216// -- Window --------------------------------------------------------------------------------------------------------------
217
218/// Sets the title of the window.
219///
220/// # Examples
221///
222/// ```
223/// set_window_title("Hello");
224/// ```
225pub fn set_window_title(title: &str) {
226    if STATE.get().is_some() {
227        return ctx(|s| s.set_window_title(title));
228    }
229
230    PENDING_CONFIG.with_borrow_mut(|s| s.window_title = Some(title.into()));
231}
232
233/// Sets whether the window is visible or not.
234///
235/// # Examples
236///
237/// ```
238/// set_window_visible(false); // hides the window
239/// set_window_visible(true); // shows the window
240/// ```
241pub fn set_window_visible(visible: bool) {
242    if STATE.get().is_some() {
243        return ctx(|s| s.set_window_visible(visible));
244    }
245
246    PENDING_CONFIG.with_borrow_mut(|s| s.window_visible = Some(visible));
247}
248
249/// Sets the icon of the window.
250///
251/// # Examples
252///
253/// ```
254/// set_window_icon("path_to_icon");
255/// ```
256pub fn set_window_icon(path: &str) {
257    let img = image::open(path)
258        .expect("image icon does not exist at path")
259        .into_rgba8();
260    let (width, height) = img.dimensions();
261    let rgba = img.into_raw();
262
263    if STATE.get().is_some() {
264        return ctx(|s| s.set_window_icon(rgba, width, height));
265    }
266
267    PENDING_CONFIG.with_borrow_mut(|s| s.window_icon = Some((rgba, width, height)));
268}
269
270/// Sets the window icon from encoded image bytes (PNG, etc.). Panics if the bytes aren't a valid image.
271pub fn set_window_icon_bytes(bytes: &[u8]) {
272    let img = image::load_from_memory(bytes)
273        .expect("image icon does not exist at path")
274        .into_rgba8();
275    let (width, height) = img.dimensions();
276    let rgba = img.into_raw();
277
278    if STATE.get().is_some() {
279        return ctx(|s| s.set_window_icon(rgba, width, height));
280    }
281
282    PENDING_CONFIG.with_borrow_mut(|s| s.window_icon = Some((rgba, width, height)));
283}
284
285/// Sets position X of the window.
286///
287/// # Examples
288///
289/// ```
290/// set_window_x(500);
291/// ```
292pub fn set_window_x(x: i32) {
293    if STATE.get().is_some() {
294        return ctx(|s| s.set_window_x(x));
295    }
296
297    PENDING_CONFIG.with_borrow_mut(|s| s.window_x = Some(x));
298}
299
300/// Sets position Y of the window.
301///
302/// # Examples
303///
304/// ```
305/// set_window_y(500);
306/// ```
307pub fn set_window_y(y: i32) {
308    if STATE.get().is_some() {
309        return ctx(|s| s.set_window_y(y));
310    }
311
312    PENDING_CONFIG.with_borrow_mut(|s| s.window_y = Some(y));
313}
314
315/// Sets position of the window.
316///
317/// # Examples
318///
319/// ```
320/// set_window_position(500, 500);
321/// ```
322pub fn set_window_position(x: i32, y: i32) {
323    set_window_x(x);
324    set_window_y(y);
325}
326
327/// Gets width of the window
328pub fn window_width() -> f32 {
329    ctx(|s| s.window_width())
330}
331
332/// Gets height of the window
333pub fn window_height() -> f32 {
334    ctx(|s| s.window_height())
335}
336
337/// Gets size of the window
338pub fn window_size() -> Vector2 {
339    ctx(|s| Vector2::new(s.window_width(), s.window_height()))
340}
341
342/// Gets position of the window
343pub fn window_position() -> (f32, f32) {
344    ctx(|s| s.window_position())
345}
346
347/// Gets position of the window as Vector2<f32>
348pub fn window_position_vec2() -> Vector2 {
349    ctx(|s| s.window_position().into())
350}
351
352/// Gets X position of the window
353pub fn window_x() -> f32 {
354    ctx(|s| s.window_x())
355}
356
357/// Gets Y position of the window
358pub fn window_y() -> f32 {
359    ctx(|s| s.window_y())
360}
361
362/// Sets width of the window.
363///
364/// # Examples
365///
366/// ```
367/// set_window_width(500);
368/// ```
369pub fn set_window_width(w: u32) {
370    if STATE.get().is_some() {
371        return ctx(|s| s.set_window_w(w));
372    }
373
374    PENDING_CONFIG.with_borrow_mut(|s| s.window_width = Some(w));
375}
376
377/// Sets height of the window.
378///
379/// # Examples
380///
381/// ```
382/// set_window_height(500);
383/// ```
384pub fn set_window_height(h: u32) {
385    if STATE.get().is_some() {
386        return ctx(|s| s.set_window_h(h));
387    }
388
389    PENDING_CONFIG.with_borrow_mut(|s| s.window_height = Some(h));
390}
391
392/// Sets size of the window.
393///
394/// # Examples
395///
396/// ```
397/// set_window_size(500, 500);
398/// ```
399pub fn set_window_size(w: u32, h: u32) {
400    if STATE.get().is_some() {
401        return ctx(|s| s.set_window_size(w, h));
402    }
403
404    PENDING_CONFIG.with_borrow_mut(|s| {
405        s.window_width = Some(w);
406        s.window_height = Some(h);
407    });
408}
409
410/// Sets whether the window can be resized using the resize handles.
411pub fn set_window_resizable(resizeable: bool) {
412    ctx(|s| s.window.set_resizable(resizeable));
413}
414
415// -- TIME --------------------------------------------------------------------------------------------------------------
416
417/// Gets the frames per second of the application.
418/// (Limited by target framerate & fps cap). Uncap the FPS using `set_fps_capped(false)`.
419///
420/// # Examples
421///
422/// ```
423/// println!("{}", get_fps());
424/// ```
425pub fn get_fps() -> f32 {
426    ctx(|s| s.get_fps())
427}
428
429/// Sets target FPS of the application (Uses screen refresh rate by default).
430///
431/// # Examples
432///
433/// ```
434/// set_target_fps(60);
435/// ```
436pub fn set_target_fps(fps: usize) {
437    if STATE.get().is_some() {
438        return ctx(|s| s.set_target_fps(fps));
439    }
440
441    PENDING_CONFIG.with_borrow_mut(|s| s.target_fps = Some(fps));
442}
443
444/// Caps/unlocks the FPS of the application. (Capped by default)
445///
446/// # Examples
447///
448/// ```
449/// set_fps_capped(false); // uncaps the FPS
450/// set_fps_capped(true); // caps the FPS to target FPS
451/// ```
452pub fn set_fps_capped(capped: bool) {
453    if STATE.get().is_some() {
454        return ctx(|s| s.set_fps_capped(capped));
455    }
456
457    PENDING_CONFIG.with_borrow_mut(|s| s.fps_capped = Some(capped));
458}
459
460/// Gets the time taken since last frame in seconds.
461///
462/// # Examples
463///
464/// ```
465/// println!("{}", get_frame_time());
466/// ```
467
468pub fn get_frame_time() -> f32 {
469    ctx(|s| s.get_frame_time())
470}
471
472/// Gets the amount of frames that have gone by since the start of the application.
473///
474/// # Examples
475///
476/// ```
477/// println!("{}", get_frames());
478/// ```
479
480pub fn get_frames() -> usize {
481    ctx(|s| s.get_frames())
482}
483
484// -- INPUT --------------------------------------------------------------------------------------------------------------
485
486/// Returns the window-relative mouse x and y position in a tuple.
487///
488/// # Examples
489///
490/// ```
491/// let (mx, my) = mouse_position();
492/// ```
493pub fn mouse_position() -> (f32, f32) {
494    ctx(|s| s.mouse_state.get_position().into())
495}
496
497/// Returns the window-relative mouse x and y position in a `Vector2`.
498///
499/// # Examples
500///
501/// ```
502/// let pos = mouse_position_vec2();
503/// println!("{}, {}", pos.x, pos.y);
504/// ```
505pub fn mouse_position_vec2() -> Vector2 {
506    ctx(|s| s.mouse_state.get_position())
507}
508
509/// Returns the mouse x and y position on the screen instead of window-relative as Vector2.
510pub fn mouse_screen_position_vec2() -> Vector2 {
511    ctx(|s| s.mouse_state.get_screen_position())
512}
513
514/// Returns the mouse x and y position on the screen instead of window-relative.
515pub fn mouse_screen_position() -> (f32, f32) {
516    ctx(|s| s.mouse_state.get_screen_position().into())
517}
518
519/// Returns the mouse scroll direction this frame (line delta).
520/// (You might need to multiply this by something like 20).
521///
522/// # Examples
523///
524/// ```
525/// let scroll_y = mouse_wheel().y;
526/// ```
527pub fn mouse_wheel() -> Vector2 {
528    ctx(|s| s.mouse_state.get_mouse_wheel())
529}
530
531/// Set the mouse cursor icon.
532///
533/// ## Examples
534///
535/// ```
536/// set_mouse_icon(CursorIcon::Pointer)
537/// ```
538pub fn set_mouse_icon(cursor_icon: CursorIcon) {
539    ctx(|s| s.window.set_cursor(cursor_icon))
540}
541/// Requests keyboard focus for the window.
542pub fn focus_window() {
543    get_window().focus_window();
544}
545
546/// Checks if a `MouseButton` is being held.
547///
548/// # Examples
549///
550/// ```
551/// if is_mouse_button_down(MouseButton::Left) {
552///     println!("Left mouse button is being held");
553/// }
554/// ```
555
556pub fn is_mouse_button_down(btn: MouseButton) -> bool {
557    ctx(|s| s.mouse_state.is_button_down(btn))
558}
559
560/// Checks if a `MouseButton` was just clicked this frame.
561///
562/// # Examples
563///
564/// ```
565/// if is_mouse_button_pressed(MouseButton::Left) {
566///     println!("User clicked left mouse button once");
567/// }
568/// ```
569pub fn is_mouse_button_pressed(btn: MouseButton) -> bool {
570    ctx(|s| s.mouse_state.is_button_pressed(btn))
571}
572
573/// Checks if a `MouseButton` was just released this frame.
574///
575/// # Examples
576///
577/// ```
578/// if is_mouse_button_released(MouseButton::Left) {
579///     println!("User let go of left mouse button once");
580/// }
581/// ```
582
583pub fn is_mouse_button_released(btn: MouseButton) -> bool {
584    ctx(|s| s.mouse_state.is_button_released(btn))
585}
586
587/// Checks if a key on the keyboard is being held.
588///
589/// # Examples
590///
591/// ```
592/// println!("is Space being held: {}", is_key_down(KeyCode::Space));
593/// ```
594
595pub fn is_key_down(key: KeyCode) -> bool {
596    ctx(|s| s.keyboard_state.is_key_down(key))
597}
598
599/// Checks if a key on the keyboard was just clicked.
600///
601/// # Examples
602///
603/// ```
604/// if is_key_pressed(KeyCode::Space) {
605///     println!("User clicked Space once");
606/// }
607/// ```
608pub fn is_key_pressed(key: KeyCode) -> bool {
609    ctx(|s| s.keyboard_state.is_key_pressed(key))
610}
611
612/// Checks if a key on the keyboard was just released.
613///
614/// # Examples
615///
616/// ```
617/// if is_key_released(KeyCode::Space) {
618///     println!("User let go of Space");
619/// }
620/// ```
621pub fn is_key_released(key: KeyCode) -> bool {
622    ctx(|s| s.keyboard_state.is_key_released(key))
623}
624
625/// Returns -1.0 if only `left` is held, 1.0 if only `right` is held, otherwise 0.0.
626pub fn get_axis(left: KeyCode, right: KeyCode) -> f32 {
627    ctx(|s| match (is_key_down(left), is_key_down(right)) {
628        (true, false) => -1.0,
629        (false, true) => 1.0,
630        _ => 0.0,
631    })
632}
633
634/// Returns a direction from four keys. Up is -1.0 on Y (screen coordinates).
635/// The result is not normalized, so diagonals have length √2.
636pub fn get_vector(left: KeyCode, right: KeyCode, up: KeyCode, down: KeyCode) -> Vector2 {
637    ctx(|s| {
638        Vector2::new(
639            match (is_key_down(left), is_key_down(right)) {
640                (true, false) => -1.0,
641                (false, true) => 1.0,
642                _ => 0.0,
643            },
644            match (is_key_down(up), is_key_down(down)) {
645                (true, false) => -1.0,
646                (false, true) => 1.0,
647                _ => 0.0,
648            },
649        )
650    })
651}
652
653// -- DRAWING --------------------------------------------------------------------------------------------------------------
654
655/// Clears the background using a color.
656///
657/// # Examples
658///
659/// ```
660/// clear_background(RED);
661/// ```
662
663pub fn clear_background(color: Color) {
664    if STATE.get().is_some() {
665        return ctx(|s| {
666            s.clear_color = Some(color);
667            s.draw_state.clear();
668        });
669    }
670
671    PENDING_CONFIG.with_borrow_mut(|c| c.window_clear_color = Some(color));
672}
673
674/// Draws a filled rectangle with its top-left corner at `(x, y)`.
675///
676/// # Examples
677///
678/// ```
679/// draw_rectangle(100.0, 100.0, 50.0, 80.0, RED);
680/// ```
681
682pub fn draw_rectangle(x: f32, y: f32, w: f32, h: f32, color: Color) {
683    draw_rectangle_rounded(x, y, w, h, 0.0, color);
684}
685
686/// Draws a **rounded**, filled rectangle with its top-left corner at `(x, y)`.
687/// All corners have the same radius. Use `draw_rectangle_rounded_ex()` to set all the radii separately.
688///
689/// # Examples
690///
691/// ```
692/// draw_rectangle_rounded(100.0, 100.0, 50.0, 80.0, 20.0, RED); // 20.0 is the radius of each corner
693/// ```
694pub fn draw_rectangle_rounded(x: f32, y: f32, w: f32, h: f32, radius: f32, color: Color) {
695    draw_rectangle_rounded_ex(x, y, w, h, radius, radius, radius, radius, color)
696}
697
698/// Draws a **rounded**, filled rectangle with its top-left corner at `(x, y)`
699/// with the ability to set each corner's radius manually.
700///
701/// # Examples
702///
703/// ```
704/// draw_rectangle_rounded_ex(
705///     x, y,
706///     w, h,
707///     top_left, top_right,
708///     bottom_left, bottom_right,
709///     RED
710/// );
711/// ```
712pub fn draw_rectangle_rounded_ex(
713    x: f32,
714    y: f32,
715    w: f32,
716    h: f32,
717    top_left: f32,
718    top_right: f32,
719    bottom_left: f32,
720    bottom_right: f32,
721    color: Color,
722) {
723    ctx(|s| {
724        s.draw_state.draw_rectangle(
725            x,
726            y,
727            w,
728            h,
729            top_left,
730            top_right,
731            bottom_left,
732            bottom_right,
733            color,
734        )
735    });
736}
737
738/// Draws a filled rectangle using a `Rect`.
739///
740/// # Examples
741///
742/// ```
743/// draw_rectangle_from_rect(rect, RED);
744/// ```
745pub fn draw_rectangle_from_rect(rect: Rect, color: Color) {
746    draw_rectangle(rect.x, rect.y, rect.w, rect.h, color);
747}
748
749/// Draws a **rounded**, filled rectangle using a `Rect` where all corners have the same radius.
750/// Use `draw_rectangle_rounded_from_rect_ex()` to set all radii separately.
751///
752/// # Examples
753///
754/// ```
755/// draw_rectangle_rounded_from_rect(rect, 20.0, RED); // 20.0 is the radius
756/// ```
757pub fn draw_rectangle_rounded_from_rect(rect: Rect, radius: f32, color: Color) {
758    draw_rectangle_rounded(rect.x, rect.y, rect.w, rect.h, radius, color);
759}
760
761/// Draws **rounded**, outlines of a rectangle using a `Rect` where all corners have the same radius.
762/// Use `draw_rectangle_lines_rounded_from_rect_ex()` to set all radii separately.
763///
764/// # Examples
765///
766/// ```
767/// draw_rectangle_lines_rounded_from_rect(rect, 20.0, RED); // 20.0 is the radius
768/// ```
769pub fn draw_rectangle_lines_rounded_from_rect(
770    rect: Rect,
771    radius: f32,
772    thickness: f32,
773    color: Color,
774) {
775    draw_rectangle_lines_rounded(rect.x, rect.y, rect.w, rect.h, radius, thickness, color);
776}
777
778/// Draws **rounded**, outlines of a rectangle using a `Rect` where all corners have the same radius.
779/// Use `draw_rectangle_lines_rounded_from_rect_ex()` to set all radii separately.
780///
781/// # Examples
782///
783/// ```
784/// draw_rectangle_lines_rounded_from_rect(rect, 20.0, RED); // 20.0 is the radius
785/// ```
786pub fn draw_rectangle_lines_rounded_from_rect_ex(
787    rect: Rect,
788    top_left: f32,
789    top_right: f32,
790    bottom_left: f32,
791    bottom_right: f32,
792    thickness: f32,
793    color: Color,
794) {
795    draw_rectangle_lines_rounded_ex(
796        rect.x,
797        rect.y,
798        rect.w,
799        rect.h,
800        top_left,
801        top_right,
802        bottom_left,
803        bottom_right,
804        thickness,
805        color,
806    );
807}
808
809/// Draws a **rounded**, filled rectangle using a `Rect`,
810/// with the ability to set each corner's radius separately.
811///
812/// # Examples
813///
814/// ```
815/// draw_rectangle_rounded_from_rect_ex(
816///     rect,
817///     top_left, top_right,
818///     bottom_left, bottom_right,
819///     RED
820/// );
821/// ```
822pub fn draw_rectangle_rounded_from_rect_ex(
823    rect: Rect,
824    top_left: f32,
825    top_right: f32,
826    bottom_left: f32,
827    bottom_right: f32,
828    color: Color,
829) {
830    draw_rectangle_rounded_ex(
831        rect.x,
832        rect.y,
833        rect.w,
834        rect.h,
835        top_left,
836        top_right,
837        bottom_left,
838        bottom_right,
839        color,
840    );
841}
842
843/// Draws the outline of a rectangle with its top-left corner at `(x, y)`.
844///
845/// # Examples
846///
847/// ```
848/// draw_rectangle_lines(100.0, 100.0, 50.0, 80.0, 4.0, WHITE);
849/// ```
850pub fn draw_rectangle_lines(x: f32, y: f32, w: f32, h: f32, thickness: f32, color: Color) {
851    draw_rectangle_lines_rounded(x, y, w, h, 0.0, thickness, color)
852}
853
854/// Draws the outline of a rectangle using a `Rect`.
855///
856/// # Examples
857///
858/// ```
859/// draw_rectangle_lines_from_rect(rect, 4.0, WHITE);
860/// ```
861pub fn draw_rectangle_lines_from_rect(rect: Rect, thickness: f32, color: Color) {
862    draw_rectangle_lines(rect.x, rect.y, rect.w, rect.h, thickness, color);
863}
864
865/// Draws the outline of a **rounded** rectangle with its top-left corner at `(x, y)`.
866/// All corners have the same radius. The stroke is centered on the rectangle's edge.
867/// Use `draw_rectangle_lines_rounded_ex()` to set each corner's radius separately.
868///
869/// # Examples
870///
871/// ```
872/// draw_rectangle_lines_rounded(100.0, 100.0, 50.0, 80.0, 12.0, 3.0, WHITE);
873/// // radius = 12.0, thickness = 3.0
874/// ```
875pub fn draw_rectangle_lines_rounded(
876    x: f32,
877    y: f32,
878    w: f32,
879    h: f32,
880    radius: f32,
881    thickness: f32,
882    color: Color,
883) {
884    draw_rectangle_lines_rounded_ex(x, y, w, h, radius, radius, radius, radius, thickness, color);
885}
886
887/// Draws the outline of a **rounded** rectangle with its top-left corner at `(x, y)`,
888/// with the ability to set each corner's radius separately.
889/// Radii are clamped to half the shorter side.
890///
891/// # Examples
892///
893/// ```
894/// draw_rectangle_lines_rounded_ex(
895///     100.0, 100.0, 50.0, 80.0,
896///     20.0, 0.0,   // top_left, top_right
897///     0.0, 20.0,   // bottom_left, bottom_right
898///     3.0, WHITE,  // thickness, color
899/// );
900/// ```
901pub fn draw_rectangle_lines_rounded_ex(
902    x: f32,
903    y: f32,
904    w: f32,
905    h: f32,
906    top_left: f32,
907    top_right: f32,
908    bottom_left: f32,
909    bottom_right: f32,
910    thickness: f32,
911    color: Color,
912) {
913    ctx(|s| {
914        s.draw_state.draw_rectangle_lines(
915            x,
916            y,
917            w,
918            h,
919            top_left,
920            top_right,
921            bottom_left,
922            bottom_right,
923            thickness,
924            color,
925        )
926    });
927}
928
929/// Draws a filled rectangle of size `w` x `h` centered at `(x, y)`,
930/// rotated by `rotation` radians around that center.
931///
932/// # Examples
933///
934/// ```
935/// draw_rectangle_rotated(200.0, 200.0, 50.0, 80.0, std::f32::consts::FRAC_PI_4, GREEN);
936/// ```
937pub fn draw_rectangle_rotated(x: f32, y: f32, w: f32, h: f32, rotation: f32, color: Color) {
938    ctx(|s| {
939        s.draw_state
940            .draw_rectangle_rotated(x, y, w, h, rotation, 0.0, 0.0, 0.0, 0.0, color)
941    });
942}
943
944/// Draws the outline of a rectangle with its top-left corner at `(x, y)` (before rotation),
945/// rotated by `rotation` radians around its center.
946pub fn draw_rectangle_lines_rotated(
947    x: f32,
948    y: f32,
949    w: f32,
950    h: f32,
951    rotation: f32,
952    thickness: f32,
953    color: Color,
954) {
955    ctx(|s| {
956        s.draw_state.draw_rectangle_lines_rotated(
957            x, y, w, h, rotation, 0.0, 0.0, 0.0, 0.0, thickness, color,
958        )
959    });
960}
961
962/// Draws a rounded, filled rectangle centered at `(x, y)`,
963/// rotated by `rotation` radians around that center.
964/// All corners have the same radius.
965pub fn draw_rectangle_rounded_rotated(
966    x: f32,
967    y: f32,
968    w: f32,
969    h: f32,
970    rotation: f32,
971    radius: f32,
972    color: Color,
973) {
974    draw_rectangle_rounded_rotated_ex(x, y, w, h, rotation, radius, radius, radius, radius, color);
975}
976
977pub fn draw_rectangle_rounded_rotated_ex(
978    x: f32,
979    y: f32,
980    w: f32,
981    h: f32,
982    rotation: f32,
983    top_left: f32,
984    top_right: f32,
985    bottom_left: f32,
986    bottom_right: f32,
987    color: Color,
988) {
989    ctx(|s| {
990        s.draw_state.draw_rectangle_rotated(
991            x,
992            y,
993            w,
994            h,
995            rotation,
996            top_left,
997            top_right,
998            bottom_left,
999            bottom_right,
1000            color,
1001        )
1002    });
1003}
1004
1005/// Draws the outline of a rounded rectangle centered at `(x, y)`,
1006/// rotated by `rotation` radians around that center.
1007/// All corners have the same radius.
1008pub fn draw_rectangle_lines_rounded_rotated(
1009    x: f32,
1010    y: f32,
1011    w: f32,
1012    h: f32,
1013    rotation: f32,
1014    radius: f32,
1015    thickness: f32,
1016    color: Color,
1017) {
1018    draw_rectangle_lines_rounded_rotated_ex(
1019        x, y, w, h, rotation, radius, radius, radius, radius, thickness, color,
1020    );
1021}
1022
1023/// Draws the outline of a rounded rectangle centered at `(x, y)`,
1024/// rotated by `rotation` radians around that center.
1025/// Can set each corner's radius separately.
1026pub fn draw_rectangle_lines_rounded_rotated_ex(
1027    x: f32,
1028    y: f32,
1029    w: f32,
1030    h: f32,
1031    rotation: f32,
1032    top_left: f32,
1033    top_right: f32,
1034    bottom_left: f32,
1035    bottom_right: f32,
1036    thickness: f32,
1037    color: Color,
1038) {
1039    ctx(|s| {
1040        s.draw_state.draw_rectangle_lines_rotated(
1041            x,
1042            y,
1043            w,
1044            h,
1045            rotation,
1046            top_left,
1047            top_right,
1048            bottom_left,
1049            bottom_right,
1050            thickness,
1051            color,
1052        )
1053    });
1054}
1055
1056/// Draws a filled circle centered at `(x, y)` with radius `r`.
1057///
1058/// # Examples
1059///
1060/// ```
1061/// draw_circle(300.0, 300.0, 40.0, BLUE);
1062/// ```
1063pub fn draw_circle(x: f32, y: f32, r: f32, color: Color) {
1064    ctx(|s| s.draw_state.draw_circle(x, y, r, color));
1065}
1066
1067/// Draws the outline of a circle centered at `(x, y)` with radius `r`.
1068///
1069/// # Examples
1070///
1071/// ```
1072/// draw_circle_lines(300.0, 300.0, 40.0, 3.0, WHITE);
1073/// ```
1074
1075pub fn draw_circle_lines(x: f32, y: f32, r: f32, thickness: f32, color: Color) {
1076    ctx(|s| s.draw_state.draw_circle_lines(x, y, r, thickness, color));
1077}
1078
1079/// Draws a filled triangle from three points.
1080///
1081/// # Examples
1082///
1083/// ```
1084/// draw_triangle(100.0, 200.0, 200.0, 200.0, 150.0, 100.0, YELLOW);
1085/// ```
1086
1087pub fn draw_triangle(x1: f32, y1: f32, x2: f32, y2: f32, x3: f32, y3: f32, color: Color) {
1088    ctx(|s| s.draw_state.draw_triangle(x1, y1, x2, y2, x3, y3, color));
1089}
1090
1091/// Draws the outline of a triangle from three points.
1092///
1093/// # Examples
1094///
1095/// ```
1096/// draw_triangle_lines(100.0, 200.0, 200.0, 200.0, 150.0, 100.0, 3.0, WHITE);
1097/// ```
1098
1099pub fn draw_triangle_lines(
1100    x1: f32,
1101    y1: f32,
1102    x2: f32,
1103    y2: f32,
1104    x3: f32,
1105    y3: f32,
1106    thickness: f32,
1107    color: Color,
1108) {
1109    ctx(|s| {
1110        s.draw_state
1111            .draw_triangle_lines(x1, y1, x2, y2, x3, y3, thickness, color)
1112    });
1113}
1114
1115/// Draws a line segment from `(x1, y1)` to `(x2, y2)`.
1116///
1117/// # Examples
1118///
1119/// ```
1120/// draw_line(0.0, 0.0, 200.0, 150.0, 4.0, WHITE);
1121/// ```
1122
1123pub fn draw_line(x1: f32, y1: f32, x2: f32, y2: f32, thickness: f32, color: Color) {
1124    ctx(|s| s.draw_state.draw_line(x1, y1, x2, y2, thickness, color))
1125}
1126
1127/// Draws connected line segments through `points` with mitered joins.
1128/// If `closed` is true, the last point connects back to the first.
1129///
1130/// # Examples
1131///
1132/// ```
1133/// let pts = [Vector2::new(50.0, 50.0), Vector2::new(150.0, 80.0), Vector2::new(100.0, 160.0)];
1134/// draw_poly_line(&pts, 3.0, WHITE, true);
1135/// ```
1136
1137pub fn draw_poly_line(points: &[Vector2], thickness: f32, color: Color, closed: bool) {
1138    ctx(|s| {
1139        s.draw_state
1140            .draw_poly_line_miter(points, thickness, color, closed)
1141    })
1142}
1143
1144/// Draws connected line segments through `points` with rounded joints and caps.
1145/// If `closed` is true, the last point connects back to the first.
1146///
1147/// # Examples
1148///
1149/// ```
1150/// let pts = [Vector2::new(50.0, 50.0), Vector2::new(150.0, 80.0), Vector2::new(100.0, 160.0)];
1151/// draw_poly_line_rounded(&pts, 6.0, WHITE, false);
1152/// ```
1153
1154pub fn draw_poly_line_rounded(points: &[Vector2], thickness: f32, color: Color, closed: bool) {
1155    ctx(|s| {
1156        s.draw_state
1157            .draw_poly_line(points, thickness, color, closed, true)
1158    })
1159}
1160
1161/// Draws a filled convex polygon from `points` as a triangle fan.
1162/// Fewer than 3 points draws nothing. Use `draw_polygon_concave` for concave shapes.
1163///
1164/// # Examples
1165///
1166/// ```
1167/// let pts = [
1168///     Vector2::new(100.0, 100.0), Vector2::new(200.0, 100.0),
1169///     Vector2::new(220.0, 180.0), Vector2::new(80.0, 180.0),
1170/// ];
1171/// draw_polygon(&pts, GREEN);
1172/// ```
1173pub fn draw_polygon(points: &[Vector2], color: Color) {
1174    ctx(|s| s.draw_state.draw_polygon(points, color))
1175}
1176
1177/// Draws a filled polygon that may be concave, using ear clipping.
1178/// Self-intersecting polygons may not render correctly.
1179///
1180/// # Examples
1181///
1182/// ```
1183/// let pts = [
1184///     Vector2::new(100.0, 100.0), Vector2::new(200.0, 100.0),
1185///     Vector2::new(150.0, 150.0), Vector2::new(200.0, 200.0),
1186///     Vector2::new(100.0, 200.0),
1187/// ];
1188/// draw_polygon_concave(&pts, RED);
1189/// ```
1190pub fn draw_polygon_concave(points: &[Vector2], color: Color) {
1191    ctx(|s| s.draw_state.draw_polygon_concave(points, color))
1192}
1193
1194/// Draws text with its top-left corner at `(x, y)` with the given font, size, and color.
1195///
1196/// # Examples
1197///
1198/// ```
1199/// draw_text("Hello", 10.0, 10.0, 32.0, None, WHITE);           // default font
1200/// draw_text("Hello", 10.0, 10.0, 32.0, Some(&font), WHITE);    // loaded font
1201/// ```
1202pub fn draw_text(t: &str, x: f32, y: f32, size: f32, font: Option<&Font>, color: Color) {
1203    ctx(|s| s.draw_state.draw_text(&s.fonts, t, x, y, size, font, color));
1204}
1205
1206/// Draws a collection of `Span`s in sequence where each Span can have different properties such as
1207/// - text
1208/// - color
1209/// - size
1210/// - font
1211/// The `spans` should implement IntoIterator. Which means you can just pass an iterator.
1212///
1213/// ## Examples
1214///
1215/// ```
1216/// draw_rich_text(vec2(10.0, 10.0), &[
1217///     span("Hello there\n", WHITE),
1218///     span("My name is ", WHITE),
1219///     span("John Doe", RED)
1220///         .with_color(RED)
1221///         .with_size(32.0)
1222/// ]);
1223/// ```
1224pub fn draw_rich_text<'a, I>(
1225    position: Vector2,
1226    size: f32,
1227    font: Option<&Font>,
1228    color: Color,
1229    spans: I,
1230) where
1231    I: IntoIterator,
1232    I::Item: Borrow<Span<'a>>,
1233{
1234    ctx(|s| {
1235        s.draw_state
1236            .draw_richtext(position, size, font, color, spans)
1237    })
1238}
1239
1240/// Loads a `.ttf`/`.otf` font from path and returns the `Font` object.
1241/// (Do not load the font every frame, it will lag)
1242///
1243/// # Examples
1244///
1245/// ```
1246/// // Put this before the `flake::run()` to avoid loading it each frame
1247/// let font = load_font_from_path("src/Arial.ttf");
1248///
1249/// flake::run(|| {
1250///     draw_text("Hello", 10.0, 10.0, 32.0, Some(&font), WHITE)
1251/// })
1252/// ```
1253pub fn load_font_from_path(path: &str) -> Font {
1254    if STATE.get().is_some() {
1255        return ctx(|s| {
1256            s.load_font_from_path(path);
1257            s.fonts[s.fonts.len() - 1].clone()
1258        });
1259    }
1260
1261    PENDING_CONFIG.with_borrow_mut(|s| {
1262        let font = Font::from_path(s.fonts.len() + 1, path);
1263        s.fonts.push(font.clone());
1264        font
1265    })
1266}
1267
1268/// Loads a `.ttf`/`.otf` font from bytes and returns the `Font` object.
1269/// (Do not load the font every frame, it will lag)
1270///
1271/// # Examples
1272///
1273/// ```
1274/// // Put this before the `flake::run()` to avoid loading it each frame
1275/// let font = load_font_from_bytes(include_bytes!("Arial.ttf"));
1276///
1277/// flake::run(|| {
1278///     draw_text("Hello", 10.0, 10.0, 32.0, Some(&font), WHITE)
1279/// })
1280/// ```
1281pub fn load_font_from_bytes(bytes: &[u8]) -> Font {
1282    if STATE.get().is_some() {
1283        return ctx(|s| {
1284            s.load_font_from_bytes(bytes);
1285            s.fonts[s.fonts.len() - 1].clone()
1286        });
1287    }
1288
1289    PENDING_CONFIG.with_borrow_mut(|s| {
1290        let font = Font::from_bytes(s.fonts.len() + 1, bytes);
1291        s.fonts.push(font.clone());
1292        font
1293    })
1294}
1295
1296/// Returns the (width, height) of `text` when drawn with `draw_text` at this size.
1297pub fn measure_text(t: &str, size: f32, font: Option<&Font>) -> Vector2 {
1298    let (w, h) = ctx(|s| s.measure_text(t, size, font));
1299    Vector2::new(w, h)
1300}
1301
1302/// Draws a line from `(x1, y1)` to `(x2, y2)` with a triangular head at the end.
1303/// The tip extends `head_size` past `(x2, y2)`.
1304pub fn draw_arrow(
1305    x1: f32,
1306    y1: f32,
1307    x2: f32,
1308    y2: f32,
1309    thickness: f32,
1310    head_size: f32,
1311    color: Color,
1312) {
1313    ctx(|s| {
1314        s.draw_state
1315            .draw_arrow(x1, y1, x2, y2, thickness, head_size, color)
1316    });
1317}
1318
1319/// Returns the size of the monitor the window is on, or the window size if it can't be determined.
1320pub fn screen_size() -> Vector2 {
1321    let win = get_window();
1322    match win.current_monitor() {
1323        Some(m) => {
1324            let s = m.size();
1325            Vector2::new(s.width as f32, s.height as f32)
1326        }
1327        None => window_size(),
1328    }
1329}
1330
1331pub fn screen_width() -> f32 {
1332    screen_size().x
1333}
1334pub fn screen_height() -> f32 {
1335    screen_size().y
1336}
1337
1338// -- TEXTURES --------------------------------------------------------------------------------------------------------------
1339
1340/// Creates an empty texture of the given size. Fill it with `update_texture`.
1341pub fn create_empty_texture(width: u32, height: u32, filter_type: FilterType) -> Texture {
1342    ctx(|s| {
1343        let gpu = GpuTexture::empty(
1344            &s.device,
1345            width,
1346            height,
1347            filter_type,
1348            wgpu::TextureFormat::Rgba8UnormSrgb,
1349        )
1350        .expect("Couldn't create empty GpuTexture");
1351
1352        Texture {
1353            id: s.add_gpu_texture(gpu, false),
1354            width,
1355            height,
1356        }
1357    })
1358}
1359
1360/// Loads a texture from an image file using linear filtering. Panics if the file can't be read or decoded.
1361pub fn load_texture(path: &str) -> Texture {
1362    ctx(|s| {
1363        let image = image::load_from_memory(&std::fs::read(path).unwrap()).unwrap();
1364        let width = image.width();
1365        let height = image.height();
1366
1367        Texture {
1368            id: s.add_texture(image, FilterType::Linear),
1369            width,
1370            height,
1371        }
1372    })
1373}
1374
1375/// Same as `load_texture`, with an explicit `FilterType` (e.g. nearest for pixel art).
1376pub fn load_texture_with_filter_type(path: &str, filter_type: FilterType) -> Texture {
1377    ctx(|s| {
1378        let image = image::load_from_memory(&std::fs::read(path).unwrap()).unwrap();
1379        let width = image.width();
1380        let height = image.height();
1381
1382        Texture {
1383            id: s.add_texture(image, filter_type),
1384            width,
1385            height,
1386        }
1387    })
1388}
1389
1390/// Loads a texture from encoded image bytes (e.g. `include_bytes!`) using linear filtering.
1391pub fn load_texture_from_bytes(bytes: &[u8]) -> Texture {
1392    ctx(|s| {
1393        let image = image::load_from_memory(bytes).unwrap();
1394        let (width, height) = image.dimensions();
1395
1396        Texture {
1397            id: s.add_texture(image, FilterType::Linear),
1398            width,
1399            height,
1400        }
1401    })
1402}
1403
1404/// Loads a texture from raw RGBA `f32` pixels. `data.len()` must equal `width * height * 4`, otherwise this panics.
1405pub fn load_texture_from_bytes_with_filter_type(bytes: &[u8], filter_type: FilterType) -> Texture {
1406    ctx(|s| {
1407        let image = image::load_from_memory(bytes).unwrap();
1408        let (width, height) = image.dimensions();
1409
1410        Texture {
1411            id: s.add_texture(image, filter_type),
1412            width,
1413            height,
1414        }
1415    })
1416}
1417
1418/// Loads a texture from raw RGBA `f32` pixels. `data.len()` must equal `width * height * 4`, otherwise this panics.
1419pub fn load_texture_from_data(width: u32, height: u32, data: &[f32]) -> Texture {
1420    ctx(|s| {
1421        let img_buf = ImageBuffer::<Rgba<f32>, Vec<f32>>::from_raw(width, height, data.to_vec())
1422            .expect("Buffer size mismatch");
1423
1424        let dynamic_img = DynamicImage::ImageRgba32F(img_buf);
1425
1426        Texture {
1427            id: s.add_texture(dynamic_img, FilterType::Linear),
1428            width,
1429            height,
1430        }
1431    })
1432}
1433
1434/// Loads a texture from raw RGBA `f32` pixels.
1435/// `data.len()` must equal `width * height * 4`, otherwise this panics.
1436/// (Use nearest for pixel art)
1437pub fn load_texture_from_data_with_filter_type(
1438    width: u32,
1439    height: u32,
1440    data: &[f32],
1441    filter_type: FilterType,
1442) -> Texture {
1443    ctx(|s| {
1444        let img_buf = ImageBuffer::<Rgba<f32>, Vec<f32>>::from_raw(width, height, data.to_vec())
1445            .expect("Buffer size mismatch");
1446
1447        let dynamic_img = DynamicImage::ImageRgba32F(img_buf);
1448
1449        Texture {
1450            id: s.add_texture(dynamic_img, filter_type),
1451            width,
1452            height,
1453        }
1454    })
1455}
1456
1457/// Creates a texture from an `Image`.
1458pub fn load_texture_from_image(image: &Image) -> Texture {
1459    let tex = create_empty_texture(image.width, image.height, image.filter_type);
1460    update_texture(tex, image);
1461
1462    tex
1463}
1464
1465/// Draws a texture stretched to `w` x `h` with its top-left at `(x, y)`.
1466/// `tint` multiplies the texture color (use `WHITE` for none).
1467pub fn draw_texture(texture: Texture, x: f32, y: f32, w: f32, h: f32, tint: Color) {
1468    ctx(|s| s.draw_state.draw_texture(texture, x, y, w, h, tint))
1469}
1470
1471/// Draws a texture with extra options from `DrawTextureParams`: destination size,
1472/// source rect, horizontal/vertical flip, rotation (radians), pivot, and tint.
1473pub fn draw_texture_ex(texture: Texture, x: f32, y: f32, p: DrawTextureParams) {
1474    ctx(|s| s.draw_state.draw_texture_ex(texture, x, y, p))
1475}
1476
1477/// Replaces the pixels of an existing texture with those from `image`.
1478pub fn update_texture(texture: Texture, image: &Image) {
1479    ctx(|s| s.update_texture(texture.id, image))
1480}
1481
1482/// Creates a new RenderTarget.
1483pub fn render_target(width: u32, height: u32, filter_type: FilterType) -> RenderTarget {
1484    ctx(|s| s.create_render_target(width, height, filter_type))
1485}
1486
1487/// Sets the currently active camera being used to draw on.
1488pub fn set_camera(cam: &Camera2D) {
1489    ctx(|s| s.set_camera(cam))
1490}
1491
1492/// Resets the camera to the default screen one.
1493pub fn set_default_camera() {
1494    ctx(|s| s.set_default_camera())
1495}