Code Monkey home page Code Monkey logo

bevy-wasm-tasks's Introduction

bevy-wasm-tasks

A simple Bevy plugin which integrates the running of futures (including !Send futures) on WASM via wasm_bindgen_futures into a Bevy app.

This code is almost entirely based on the excellent bevy-tokio-tasks, just adapted for wasm_bindgen_futures.

crates.io docs.rs

How To

How to initialize this plugin

To initialize the plugin, simply install the WASMTasksPlugin when initializing your Bevy app.

How to spawn a background task

To spawn a background task from a Bevy system function, add a WASMTasksRuntime as a resource parameter and call the spawn_background_task function.

fn example_system(runtime: ResMut<WASMTasksRuntime>) {
    runtime.spawn_background_task(|_ctx| async move {
        log::info!("This task is running in a WASM future");
    });
}

How to synchronize with Bevy

Often times, background tasks will need to synchronize with the main Bevy app at certain points. You may do this by calling the run_on_main_thread function on the TaskContext that is passed to each background task.

fn example_system(runtime: ResMut<WASMTasksRuntime>) {
    runtime.spawn_background_task(|mut ctx| async move {
        log::info!("This print executes from a background WASM future");
        ctx.run_on_main_thread(move |ctx| {
            // The inner context gives access to a mutable Bevy World reference.
            let _world: &mut World = ctx.world;
        }).await;
    });
}

Version Compatibility

This crate's major and minor version numbers will match Bevy's. To allow this crate to publish updates between Bevy updates, the patch version is allowed to increment independent of Bevy's release cycle.

bevy-tokio-tasks version bevy version tokio version
0.11.0 0.11.0 1
0.10.2 0.10.1 1
0.10.1 0.10.0 1
0.10.0 0.10.0 1
0.9.5 0.9.1 1
0.9.4 0.9.1 1
0.9.3 0.9.1 1
0.9.2 0.9.1 1
0.9.1 0.9.1 1
0.9.0 0.9.1 1

bevy-wasm-tasks's People

Contributors

dependabot[bot] avatar ekardnt avatar joehowarth avatar keithsharp avatar stillonearth avatar tekacs avatar

Stargazers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.