mirror of https://github.com/bevyengine/bevy synced 2024-11-23 13:13:49 +00:00

History

mamekoro cb9789bc35 Remove unnecessary executable flags from Rust source files (#12707 ) # Objective I found that some .rs files are unnecessarily executable. Rust source files may start with a shebang-like statement `#!`, so let's make sure they are not executable just in case. Here is the result of the `find` commend that lists executable .rs files as of main branch `86bd648`. ```console $ find -name \.rs -type f -executable ./crates/bevy_gizmos/src/lib.rs ./crates/bevy_tasks/src/lib.rs ./crates/bevy_time/src/lib.rs ./crates/bevy_transform/src/lib.rs ./src/lib.rs ``` It appears that the permissions of those files were originally 644, but were unexpectedly changed to 755 by commit `52e3f2007b`. ## Solution Make them not executable by using this command; `find -name \.rs -type f -executable -exec chmod --verbose a-x -- {} \+`		2024-03-25 20:03:55 +00:00
..
examples	Inverse `missing_docs` logic (#11676 )	2024-02-03 21:40:55 +00:00
src	Remove unnecessary executable flags from Rust source files (#12707 )	2024-03-25 20:03:55 +00:00
Cargo.toml	Make `feature(doc_auto_cfg)` work (#12642 )	2024-03-23 02:22:52 +00:00
README.md	add and fix shields in Readmes (#9993 )	2023-10-15 00:52:31 +00:00

README.md

Bevy Tasks

A refreshingly simple task executor for bevy. :)

This is a simple threadpool with minimal dependencies. The main usecase is a scoped fork-join, i.e. spawning tasks from a single thread and having that thread await the completion of those tasks. This is intended specifically for bevy as a lighter alternative to rayon for this specific usecase. There are also utilities for generating the tasks from a slice of data. This library is intended for games and makes no attempt to ensure fairness or ordering of spawned tasks.

It is based on async-executor, a lightweight executor that allows the end user to manage their own threads. async-executor is based on async-task, a core piece of async-std.

Usage

In order to be able to optimize task execution in multi-threaded environments, bevy provides three different thread pools via which tasks of different kinds can be spawned. (The same API is used in single-threaded environments, even if execution is limited to a single thread. This currently applies to WASM targets.) The determining factor for what kind of work should go in each pool is latency requirements:

For CPU-intensive work (tasks that generally spin until completion) we have a standard [ComputeTaskPool] and an [AsyncComputeTaskPool]. Work that does not need to be completed to present the next frame should go to the [AsyncComputeTaskPool].
For IO-intensive work (tasks that spend very little time in a "woken" state) we have an [IoTaskPool] whose tasks are expected to complete very quickly. Generally speaking, they should just await receiving data from somewhere (i.e. disk) and signal other systems when the data is ready for consumption. (likely via channels)