Struct MiniquadService

pub struct MiniquadService<T: MiniquadEventHandlerExt + 'static> { /* private fields */ }

Available on crate feature dep_miniquad only.

miniquad’s UI Service.

Implementations

impl<T: MiniquadEventHandlerExt + 'static> MiniquadService<T>

builder methods

pub fn with(handler: T) -> Self

Returns a default MiniquadService with the given handler,

pub fn init(self)

Initialize the miniquad rendering context, opening the window.

This must be the last method to call.

Panics

Panics if the handler is not set (e.g. by constructing with default())

pub fn handler(self, handler: T) -> Self

Sets the given handler.

pub fn conf(self, conf: Conf) -> Self

Sets the given miniquad configuration.

pub fn blocking_event_loop(self, blocking: bool) -> Self

Whether the event loop should block until schedule_update is called.

pub fn title(self, title: impl ToString) -> Self

Sets the window title.

pub fn window_size(self, width: u32, height: u32) -> Self

Sets the window size.

NOTE: in X11 it needs to have window_resizable set to true for it to have any effect.

pub fn window_resizable(self, resizable: bool) -> Self

Whether the window should be resizable by the user.

pub fn fullscreen(self, fullscreen: bool) -> Self

Whether the window should be fullscreen.

pub fn buffer_size(self, width: u32, height: u32) -> Self

Sets the size of the pixel buffer.

pub fn interpolation(self, linear: bool) -> Self

If linear == true uses [FilterMode:Linear], otherwise FilterMode::Nearest.

If the handler has not been set, this does nothing.

pub fn maintain_aspect_ratio(self, maintain: bool) -> Self

Set whether to maintain the aspect ratio on window resize.

If the handler has not been set, this does nothing.

impl<T: MiniquadEventHandlerExt + 'static> MiniquadService<T>

getters and setters

pub fn get_interpolation(self) -> bool

Whether the aspect ratio is maintained on window resize.

pub fn set_interpolation(&mut self, interpolate: bool)

Set whether to maintain the aspect ratio on window resize.

pub fn get_maintain_aspect_ratio(self) -> bool

Whether the aspect ratio is maintained on window resize.

pub fn set_maintain_aspect_ratio(&mut self, maintain: bool)

Set whether to maintain the aspect ratio on window resize.

Trait Implementations

impl<T: MiniquadEventHandlerExt + 'static> Default for MiniquadService<T>

fn default() -> Self

Returns a default MiniquadService without a handler.

impl<T: MiniquadEventHandlerExt + 'static> UiService for MiniquadService<T>

fn capabilities(&self) -> UiCap

Returns the service capabilities.

fn version(&self) -> (u32, u32, u32)

Returns the service inner version numbers (major, minor, patch).

fn version_string(&self) -> String

Available on crate feature alloc only.

Returns the service version string.