Struct speedy2d::WebCanvas

pub struct WebCanvas<UserEventType = ()>where
    UserEventType: 'static,
{ /* private fields */ }

Expand description

Struct representing an HTML canvas.

Implementations§

impl WebCanvas<()>

pub fn new_for_id<S, H>( element_id: S, handler: H ) -> Result<WebCanvas<()>, BacktraceError<ErrorMessage>>
where S: AsRef<str>, H: WindowHandler<()> + 'static,

Creates (and starts running) a new WebCanvas instance, attached to the HTML canvas with the specified ID. Event handlers will be registered for keyboard, mouse, and other events.

The event loop/handlers will continue to exist after the WebCanvas is dropped. This behaviour can be avoided using WebCanvas::unregister_when_dropped.

The provided WindowHandler will start to receive callbacks as soon as this function returns. Note that the main thread must not be blocked.

impl<UserEventType: 'static> WebCanvas<UserEventType>

pub fn new_for_id_with_user_events<S, H>( element_id: S, handler: H ) -> Result<Self, BacktraceError<ErrorMessage>>
where S: AsRef<str>, H: WindowHandler<UserEventType> + 'static,

Creates (and starts running) a new WebCanvas instance, attached to the HTML canvas with the specified ID. Event handlers will be registered for keyboard, mouse, and other events.

This variant has support for user-generated events. See window::UserEventSender for more details.

The event loop/handlers will continue to exist after the WebCanvas is dropped. This behaviour can be avoided using WebCanvas::unregister_when_dropped.

The provided WindowHandler will start to receive callbacks as soon as this function returns. Note that the main thread must not be blocked.

pub fn unregister_when_dropped(&mut self)

Causes the WebCanvas event loop to terminate when the WebCanvas is dropped. If this function is not called, then the event loop (and associated event handlers) will continue to run after the WebCanvas struct is dropped.

Trait Implementations§

impl<UserEventType: 'static> Drop for WebCanvas<UserEventType>

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

impl<UserEventType> Freeze for WebCanvas<UserEventType>

impl<UserEventType> RefUnwindSafe for WebCanvas<UserEventType>
where UserEventType: RefUnwindSafe,

impl<UserEventType> Send for WebCanvas<UserEventType>
where UserEventType: Send,

impl<UserEventType> Sync for WebCanvas<UserEventType>
where UserEventType: Sync,

impl<UserEventType> Unpin for WebCanvas<UserEventType>
where UserEventType: Unpin,

impl<UserEventType> UnwindSafe for WebCanvas<UserEventType>
where UserEventType: UnwindSafe,

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> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> 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> Pointable for T

const ALIGN: usize = _

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.