Skip to main content

Game

Struct Game 

Source
pub struct Game { /* private fields */ }
Expand description

A running guest. gasm_frame guests are called once per frame; gasm_run guests run in one suspended call (stack switching) that each Game::frame resumes until its next yield_frame.

Implementations§

Source§

impl Game

Source

pub fn load(wasm: &[u8], host: Host, opts: LoadOptions) -> Result<Game, Stop>

Source

pub fn compile(wasm: &[u8], allow_precompiled: bool) -> Result<Module, Stop>

Compile a module (or load a .cwasm) for Game::load_module: the slow part of loading, and possible on another thread.

Source

pub fn load_module( module: Module, host: Host, opts: LoadOptions, ) -> Result<Game, Stop>

Instantiate a compiled module and run its init.

Source

pub fn set_asset(&mut self, name: &str, bytes: Vec<u8>) -> u32

Add or replace an asset between frames: the guest sees it from the next frame on, with a new gasm.asset_version. Returns that version.

Source

pub fn remove_asset(&mut self, name: &str) -> bool

Remove an asset between frames. False if there was none.

Source

pub fn watch_asset(&mut self, name: &str, path: &Path)

Re-read path as asset name whenever the file changes (in place or by a rename), checked before each frame.

Source

pub fn add_watch(&mut self, watch: AssetWatch)

Game::watch_asset with a watch made earlier (when the asset was first opened).

Source

pub fn uses_gl(&self) -> bool

Whether the guest imports gasm:gl.

Source

pub fn switching(&self) -> bool

Whether the guest runs through gasm_run (the runner switches stacks).

Source

pub fn frame(&mut self) -> Result<(), Stop>

One frame: call gasm_frame, or resume gasm_run until its next yield_frame.

Source

pub fn exit(&mut self)

Best-effort “the player is quitting” notification (optional gasm_exit export). A suspended gasm_run guest gets it on top of its run, which then ends.

Source

pub fn with_host<R>(&mut self, f: impl FnOnce(&mut Host) -> R) -> R

Run f on the host: directly, or (a suspended gasm_run guest) through the guest’s yield_frame, which owns the store meanwhile. Runners use this between frames for everything they read or set.

Source

pub fn host(&self) -> &Host

The host of a guest that isn’t suspended in gasm_run (every gasm_frame guest; a gasm_run guest before its first frame and after it ended). Otherwise use Game::with_host.

Source

pub fn host_mut(&mut self) -> &mut Host

Auto Trait Implementations§

§

impl !RefUnwindSafe for Game

§

impl !Send for Game

§

impl !Sync for Game

§

impl !UnwindSafe for Game

§

impl Freeze for Game

§

impl Unpin for Game

§

impl UnsafeUnpin for Game

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<S> FromSample<S> for S

Source§

fn from_sample_(s: S) -> S

Source§

impl<T> Instrument for T

Source§

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

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

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

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

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> IntoEither for T

Source§

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
Source§

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
Source§

impl<F, T> IntoSample<T> for F
where T: FromSample<F>,

Source§

fn into_sample(self) -> T

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

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

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> ToSample<U> for T
where U: FromSample<T>,

Source§

fn to_sample_(self) -> U

Source§

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more