Struct MiniquadWindow Copy item path

impl MiniquadWindow

pub fn new_rendering_backend() -> Box<dyn RenderingBackend>

Returns a new rendering backend.

It’s normally GlContext, or maybe MetalContext in macos.

pub fn blocking_event_loop() -> bool

Returns true if the event loop blocks until schedule_update is called.

See also: MiniquadService::blocking_event_loop(), and ::miniquad::blocking_event_loop.

pub fn schedule_update()

Requests an immediate update, ensuring update() and draw() are called without waiting.

This must be called from an implementor of MiniquadEventHandler and requires conf.platform.blocking_event_loop to be enabled.

This can significantly reduce CPU usage while waiting for events.

It is recommended to call this at the end of resize_event or after relevant mouse/keyboard input.

pub fn clipboard_get() -> Option<String> ⓘ

Get current OS clipboard value.

pub fn clipboard_set(data: &str)

Save value to OS clipboard

pub fn dropped_file_bytes(index: usize) -> Option<Vec<u8>> ⓘ

Returns the contents of a dropped file as a byte vector, if available.

The index parameter specifies which dropped file to retrieve, starting from 0.

pub fn dropped_file_count() -> usize

Returns the number of files that have been dropped.

pub fn dropped_file_path(index: usize) -> Option<PathBuf> ⓘ

Available on crate feature std only.

Returns the file path of a dropped file, if available.

The index parameter specifies which dropped file to retrieve, starting from 0.

pub fn dpi_scale() -> f32

The dpi scaling factor (window pixels to framebuffer pixels).

See: High DPI Rendering.

pub fn high_dpi() -> bool

Returns true if high_dpi was requested and it’s running in a high-dpi scenario.

pub fn quit()

This function simply quits the application without giving the user a chance to intervene.

Usually this might be called when the user clicks the ‘Ok’ button in a ‘Really Quit?’ dialog box Window might not be actually closed right away (exit(0) might not happen in the order_quit implmentation) and execution might continue for some time after But the window is going to be inevitably closed at some point.

pub fn request_quit()

Triggers the “quit_requested_event” event.

If the event handler callback does nothing, the application will be quit as usual. To prevent this, call cancel_quit from inside the event handler.

pub fn cancel_quit()

Cancels a pending quit request, no matter who it was requested.

The only place where calling this function makes sense is from inside the event handler callback when the “quit_requested_event” event has been received.

pub fn get_size() -> (f32, f32) ⓘ

The current framebuffer size in pixels.

See High DPI Rendering and ::miniquad::screen_size.

pub fn set_size(width: u32, height: u32)

Set the application’s window size.

See ::miniquad::set_window_size.

pub fn get_position() -> (u32, u32) ⓘ

Available on Windows or Linux only.

Get the position of the window.

See ::miniquad::get_window_position.

pub fn set_position(x: u32, y: u32)

Set the window position.

See ::miniquad::set_window_position.

pub fn set_fullscreen(fullscreen: bool)

Sets the full screen mode.

pub fn show_keyboard(shown: bool)

Show/hide onscreen keyboard. Only works on Android right now.

pub fn show_mouse(shown: bool)

Show or hide the mouse cursor

pub fn set_mouse_cursor(icon: CursorIcon)

Set the mouse cursor icon.

pub fn set_cursor_grab(grab: bool)

Capture mouse cursor to the current window On WASM this will automatically hide cursor.

On desktop this will bound cursor to windows border.

NOTICE: on desktop cursor will not be automatically released after window lost focus so set_cursor_grab(false) on window’s focus lost is recommended.

Auto Trait Implementations§

impl UnwindSafe for MiniquadWindow

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> ByteSized for T

const BYTE_ALIGN: usize = _

The alignment of this type in bytes.

const BYTE_SIZE: usize = _

The size of this type in bytes.

fn byte_align(&self) -> usize

Returns the alignment of this type in bytes.

fn byte_size(&self) -> usize

Returns the size of this type in bytes. Read more

fn ptr_size_ratio(&self) -> [usize; 2]

Returns the size ratio between Ptr::BYTES and BYTE_SIZE. Read more

impl<T, R> Chain<R> for T
where T: ?Sized,

fn chain<F>(self, f: F) -> R
where F: FnOnce(Self) -> R, Self: Sized,

Chain a function which takes the parameter by value.

fn chain_ref<F>(&self, f: F) -> R
where F: FnOnce(&Self) -> R,

Chain a function which takes the parameter by shared reference.

fn chain_mut<F>(&mut self, f: F) -> R
where F: FnOnce(&mut Self) -> R,

Chain a function which takes the parameter by exclusive reference.

impl<T> ExtAny for T
where T: Any + ?Sized,

fn type_id() -> TypeId

Returns the TypeId of Self. Read more

fn type_of(&self) -> TypeId

Returns the TypeId of self. Read more

fn type_name(&self) -> &'static str ⓘ

Returns the type name of self. Read more

fn type_is<T: 'static>(&self) -> bool

Returns true if Self is of type T. Read more

fn type_hash(&self) -> u64

Returns a deterministic hash of the TypeId of Self.

fn type_hash_with<H: Hasher>(&self, hasher: H) -> u64

Returns a deterministic hash of the TypeId of Self using a custom hasher.

fn as_any_ref(&self) -> &dyn Any
where Self: Sized,

Upcasts &self as &dyn Any. Read more

fn as_any_mut(&mut self) -> &mut dyn Any
where Self: Sized,

Upcasts &mut self as &mut dyn Any. Read more

fn as_any_box(self: Box<Self>) -> Box<dyn Any>
where Self: Sized,

Upcasts Box<self> as Box<dyn Any>. Read more

fn downcast_ref<T: 'static>(&self) -> Option<&T> ⓘ

Available on crate feature unsafe_layout only.

Returns some shared reference to the inner value if it is of type T. Read more

fn downcast_mut<T: 'static>(&mut self) -> Option<&mut T> ⓘ

Available on crate feature unsafe_layout only.

Returns some exclusive reference to the inner value if it is of type T. Read more

impl<T> ExtMem for T
where T: ?Sized,

const NEEDS_DROP: bool = _

Know whether dropping values of this type matters, in compile-time.

fn mem_align_of<T>() -> usize

Returns the minimum alignment of the type in bytes. Read more

fn mem_align_of_val(&self) -> usize

Returns the alignment of the pointed-to value in bytes. Read more

fn mem_size_of<T>() -> usize

Returns the size of a type in bytes. Read more

fn mem_size_of_val(&self) -> usize

Returns the size of the pointed-to value in bytes. Read more

fn mem_copy(&self) -> Self
where Self: Copy,

Bitwise-copies a value. Read more

fn mem_needs_drop(&self) -> bool

Returns true if dropping values of this type matters. Read more

fn mem_drop(self)
where Self: Sized,

Drops self by running its destructor. Read more

fn mem_forget(self)
where Self: Sized,

Forgets about self without running its destructor. Read more

fn mem_replace(&mut self, other: Self) -> Self
where Self: Sized,

Replaces self with other, returning the previous value of self. Read more

fn mem_take(&mut self) -> Self
where Self: Default,

Replaces self with its default value, returning the previous value of self. Read more

fn mem_swap(&mut self, other: &mut Self)
where Self: Sized,

Swaps the value of self and other without deinitializing either one. Read more

unsafe fn mem_zeroed<T>() -> T

Available on crate feature unsafe_layout only.

Returns the value of type T represented by the all-zero byte-pattern. Read more

unsafe fn mem_transmute_copy<Src, Dst>(src: &Src) -> Dst

Available on crate feature unsafe_layout only.

Returns the value of type T represented by the all-zero byte-pattern. Read more

fn mem_as_bytes(&self) -> &[u8] ⓘ
where Self: Sync + Unpin,

Available on crate feature unsafe_slice only.

View a Sync + Unpin self as &[u8]. Read more

fn mem_as_bytes_mut(&mut self) -> &mut [u8] ⓘ
where Self: Sync + Unpin,

Available on crate feature unsafe_slice only.

View a Sync + Unpin self as &mut [u8]. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<S> FromSample<S> for S

fn from_sample_(s: S) -> S

impl<T> Hook for T

fn hook_ref<F>(self, f: F) -> Self
where F: FnOnce(&Self),

Applies a function which takes the parameter by shared reference, and then returns the (possibly) modified owned value. Read more

fn hook_mut<F>(self, f: F) -> Self
where F: FnOnce(&mut Self),

Applies a function which takes the parameter by exclusive reference, and then returns the (possibly) modified owned value. Read more

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more