Mirrors/bevy
2
0
Fork 0
mirror of https://github.com/bevyengine/bevy synced 2025-01-12 21:29:03 +00:00
Code Issues Projects Releases Packages Wiki Activity
bevy/crates/bevy_internal/src/lib.rs

68 lines
2 KiB
Rust
Raw Normal View History

Make `feature(doc_auto_cfg)` work (#12642) # Objective - In #12366 `![cfg_attr(docsrs, feature(doc_auto_cfg))] `was added. But to apply it it needs `--cfg=docsrs` in rustdoc-args. ## Solution - Apply `--cfg=docsrs` to all crates and CI. I also added `[package.metadata.docs.rs]` to all crates to avoid adding code behind a feature and forget adding the metadata. Before: ![Screenshot 2024-03-22 at 00 51 57](https://github.com/bevyengine/bevy/assets/104745335/6a9dfdaa-8710-4784-852b-5f9b74e3522c) After: ![Screenshot 2024-03-22 at 00 51 32](https://github.com/bevyengine/bevy/assets/104745335/c5bd6d8e-8ddb-45b3-b844-5ecf9f88961c)
2024-03-23 02:22:52 +00:00
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
Forbid unsafe in most crates in the engine (#12684) # Objective Resolves #3824. `unsafe` code should be the exception, not the norm in Rust. It's obviously needed for various use cases as it's interfacing with platforms and essentially running the borrow checker at runtime in the ECS, but the touted benefits of Bevy is that we are able to heavily leverage Rust's safety, and we should be holding ourselves accountable to that by minimizing our unsafe footprint. ## Solution Deny `unsafe_code` workspace wide. Add explicit exceptions for the following crates, and forbid it in almost all of the others. * bevy_ecs - Obvious given how much unsafe is needed to achieve performant results * bevy_ptr - Works with raw pointers, even more low level than bevy_ecs. * bevy_render - due to needing to integrate with wgpu * bevy_window - due to needing to integrate with raw_window_handle * bevy_utils - Several unsafe utilities used by bevy_ecs. Ideally moved into bevy_ecs instead of made publicly usable. * bevy_reflect - Required for the unsafe type casting it's doing. * bevy_transform - for the parallel transform propagation * bevy_gizmos - For the SystemParam impls it has. * bevy_assets - To support reflection. Might not be required, not 100% sure yet. * bevy_mikktspace - due to being a conversion from a C library. Pending safe rewrite. * bevy_dynamic_plugin - Inherently unsafe due to the dynamic loading nature. Several uses of unsafe were rewritten, as they did not need to be using them: * bevy_text - a case of `Option::unchecked` could be rewritten as a normal for loop and match instead of an iterator. * bevy_color - the Pod/Zeroable implementations were replaceable with bytemuck's derive macros.
2024-03-27 03:30:08 +00:00
#![forbid(unsafe_code)]
Set the logo and favicon for all of Bevy's published crates (#12696) # Objective Currently the built docs only shows the logo and favicon for the top level `bevy` crate. This makes views like https://docs.rs/bevy_ecs/latest/bevy_ecs/ look potentially unrelated to the project at first glance. ## Solution Reproduce the docs attributes for every crate that Bevy publishes. Ideally this would be done with some workspace level Cargo.toml control, but AFAICT, such support does not exist.
2024-03-25 18:52:50 +00:00
#![doc(
html_logo_url = "https://bevyengine.org/assets/icon.png",
html_favicon_url = "https://bevyengine.org/assets/icon.png"
)]
Make `feature(doc_auto_cfg)` work (#12642) # Objective - In #12366 `![cfg_attr(docsrs, feature(doc_auto_cfg))] `was added. But to apply it it needs `--cfg=docsrs` in rustdoc-args. ## Solution - Apply `--cfg=docsrs` to all crates and CI. I also added `[package.metadata.docs.rs]` to all crates to avoid adding code behind a feature and forget adding the metadata. Before: ![Screenshot 2024-03-22 at 00 51 57](https://github.com/bevyengine/bevy/assets/104745335/6a9dfdaa-8710-4784-852b-5f9b74e3522c) After: ![Screenshot 2024-03-22 at 00 51 32](https://github.com/bevyengine/bevy/assets/104745335/c5bd6d8e-8ddb-45b3-b844-5ecf9f88961c)
2024-03-23 02:22:52 +00:00
Added missing docs to bevy_internal and added warn on missing docs (#3514) # Objective This contributes documentation that should cover the entirety of bevy_internal as requested in #3492 ## Solution warn(missing_docs) has been activated and documentation has been added to missing parts so that no warnings appear from this setting
2022-01-01 21:22:04 +00:00
//! This module is separated into its own crate to enable simple dynamic linking for Bevy, and should not be used directly
Add bevy_dylib to force dynamic linking of bevy (#808) This easily improve compilation time by 2x
2020-11-10 03:26:08 +00:00
/// `use bevy::prelude::*;` to import common components, bundles, and plugins.
pub mod prelude;
mod default_plugins;
pub use default_plugins::*;
Switch monolithic lib to module re-exports (#13059) # Objective Makes crate module docs render correctly in the docs for the monolithic library. Fixes https://github.com/bevyengine/bevy/issues/13055. ## Solution Swap from ```rust pub mod foo { pub use bevy_foo::*; } ``` to ```rust pub use bevy_foo as foo; ```
2024-04-22 01:32:51 +00:00
pub use bevy_a11y as a11y;
animation player (#4375) # Objective - Add a basic animation player - Single track - Not generic, can only animate `Transform`s - With plenty of possible optimisations available - Close-ish to https://github.com/bevyengine/rfcs/pull/49 - https://discord.com/channels/691052431525675048/774027865020039209/958820063148929064 ## Solution - Can play animations - looping or not - Can pause animations - Can seek in animation - Can alter speed of animation - I also removed the previous gltf animation example https://user-images.githubusercontent.com/8672791/161051887-e79283f0-9803-448a-93d0-5f7a62acb02d.mp4
2022-04-02 22:36:02 +00:00
#[cfg(feature = "bevy_animation")]
Switch monolithic lib to module re-exports (#13059) # Objective Makes crate module docs render correctly in the docs for the monolithic library. Fixes https://github.com/bevyengine/bevy/issues/13055. ## Solution Swap from ```rust pub mod foo { pub use bevy_foo::*; } ``` to ```rust pub use bevy_foo as foo; ```
2024-04-22 01:32:51 +00:00
pub use bevy_animation as animation;
pub use bevy_app as app;
#[cfg(feature = "bevy_asset")]
pub use bevy_asset as asset;
Add bevy_dylib to force dynamic linking of bevy (#808) This easily improve compilation time by 2x
2020-11-10 03:26:08 +00:00
#[cfg(feature = "bevy_audio")]
Switch monolithic lib to module re-exports (#13059) # Objective Makes crate module docs render correctly in the docs for the monolithic library. Fixes https://github.com/bevyengine/bevy/issues/13055. ## Solution Swap from ```rust pub mod foo { pub use bevy_foo::*; } ``` to ```rust pub use bevy_foo as foo; ```
2024-04-22 01:32:51 +00:00
pub use bevy_audio as audio;
#[cfg(feature = "bevy_color")]
pub use bevy_color as color;
pub use bevy_core as core;
move bevy_core_pipeline to its own plugin (#2552) This decouples the opinionated "core pipeline" from the new (less opinionated) bevy_render crate. The "core pipeline" is intended to be used by crates like bevy_sprites, bevy_pbr, bevy_ui, and 3rd party crates that extends core rendering functionality.
2021-07-28 21:29:32 +00:00
#[cfg(feature = "bevy_core_pipeline")]
Switch monolithic lib to module re-exports (#13059) # Objective Makes crate module docs render correctly in the docs for the monolithic library. Fixes https://github.com/bevyengine/bevy/issues/13055. ## Solution Swap from ```rust pub mod foo { pub use bevy_foo::*; } ``` to ```rust pub use bevy_foo as foo; ```
2024-04-22 01:32:51 +00:00
pub use bevy_core_pipeline as core_pipeline;
#[cfg(feature = "bevy_dev_tools")]
pub use bevy_dev_tools as dev_tools;
pub use bevy_diagnostic as diagnostic;
#[cfg(feature = "bevy_dynamic_plugin")]
pub use bevy_dynamic_plugin as dynamic_plugin;
pub use bevy_ecs as ecs;
Made gilrs crate public within bevy so we can reference the plugin outside of DefaultPlugins. (#1195)
2021-01-03 19:36:42 +00:00
#[cfg(feature = "bevy_gilrs")]
Switch monolithic lib to module re-exports (#13059) # Objective Makes crate module docs render correctly in the docs for the monolithic library. Fixes https://github.com/bevyengine/bevy/issues/13055. ## Solution Swap from ```rust pub mod foo { pub use bevy_foo::*; } ``` to ```rust pub use bevy_foo as foo; ```
2024-04-22 01:32:51 +00:00
pub use bevy_gilrs as gilrs;
#[cfg(feature = "bevy_gizmos")]
pub use bevy_gizmos as gizmos;
Add bevy_dylib to force dynamic linking of bevy (#808) This easily improve compilation time by 2x
2020-11-10 03:26:08 +00:00
#[cfg(feature = "bevy_gltf")]
Switch monolithic lib to module re-exports (#13059) # Objective Makes crate module docs render correctly in the docs for the monolithic library. Fixes https://github.com/bevyengine/bevy/issues/13055. ## Solution Swap from ```rust pub mod foo { pub use bevy_foo::*; } ``` to ```rust pub use bevy_foo as foo; ```
2024-04-22 01:32:51 +00:00
pub use bevy_gltf as gltf;
pub use bevy_hierarchy as hierarchy;
pub use bevy_input as input;
pub use bevy_log as log;
pub use bevy_math as math;
Add bevy_dylib to force dynamic linking of bevy (#808) This easily improve compilation time by 2x
2020-11-10 03:26:08 +00:00
#[cfg(feature = "bevy_pbr")]
Switch monolithic lib to module re-exports (#13059) # Objective Makes crate module docs render correctly in the docs for the monolithic library. Fixes https://github.com/bevyengine/bevy/issues/13055. ## Solution Swap from ```rust pub mod foo { pub use bevy_foo::*; } ``` to ```rust pub use bevy_foo as foo; ```
2024-04-22 01:32:51 +00:00
pub use bevy_pbr as pbr;
pub use bevy_ptr as ptr;
pub use bevy_reflect as reflect;
Add bevy_dylib to force dynamic linking of bevy (#808) This easily improve compilation time by 2x
2020-11-10 03:26:08 +00:00
#[cfg(feature = "bevy_render")]
Switch monolithic lib to module re-exports (#13059) # Objective Makes crate module docs render correctly in the docs for the monolithic library. Fixes https://github.com/bevyengine/bevy/issues/13055. ## Solution Swap from ```rust pub mod foo { pub use bevy_foo::*; } ``` to ```rust pub use bevy_foo as foo; ```
2024-04-22 01:32:51 +00:00
pub use bevy_render as render;
#[cfg(feature = "bevy_scene")]
pub use bevy_scene as scene;
Add bevy_dylib to force dynamic linking of bevy (#808) This easily improve compilation time by 2x
2020-11-10 03:26:08 +00:00
#[cfg(feature = "bevy_sprite")]
Switch monolithic lib to module re-exports (#13059) # Objective Makes crate module docs render correctly in the docs for the monolithic library. Fixes https://github.com/bevyengine/bevy/issues/13055. ## Solution Swap from ```rust pub mod foo { pub use bevy_foo::*; } ``` to ```rust pub use bevy_foo as foo; ```
2024-04-22 01:32:51 +00:00
pub use bevy_sprite as sprite;
Separate state crate (#13216) # Objective Extracts the state mechanisms into a new crate called "bevy_state". This comes with a few goals: - state wasn't really an inherent machinery of the ecs system, and so keeping it within bevy_ecs felt forced - by mixing it in with bevy_ecs, the maintainability of our more robust state system was significantly compromised moving state into a new crate makes it easier to encapsulate as it's own feature, and easier to read and understand since it's no longer a single, massive file. ## Solution move the state-related elements from bevy_ecs to a new crate ## Testing - Did you test these changes? If so, how? all the automated tests migrated and passed, ran the pre-existing examples without changes to validate. --- ## Migration Guide Since bevy_state is now gated behind the `bevy_state` feature, projects that use state but don't use the `default-features` will need to add that feature flag. Since it is no longer part of bevy_ecs, projects that use bevy_ecs directly will need to manually pull in `bevy_state`, trigger the StateTransition schedule, and handle any of the elements that bevy_app currently sets up. --------- Co-authored-by: Kristoffer Søholm <k.soeholm@gmail.com>
2024-05-09 18:06:05 +00:00
#[cfg(feature = "bevy_state")]
pub use bevy_state as state;
Switch monolithic lib to module re-exports (#13059) # Objective Makes crate module docs render correctly in the docs for the monolithic library. Fixes https://github.com/bevyengine/bevy/issues/13055. ## Solution Swap from ```rust pub mod foo { pub use bevy_foo::*; } ``` to ```rust pub use bevy_foo as foo; ```
2024-04-22 01:32:51 +00:00
pub use bevy_tasks as tasks;
Add bevy_dylib to force dynamic linking of bevy (#808) This easily improve compilation time by 2x
2020-11-10 03:26:08 +00:00
#[cfg(feature = "bevy_text")]
Switch monolithic lib to module re-exports (#13059) # Objective Makes crate module docs render correctly in the docs for the monolithic library. Fixes https://github.com/bevyengine/bevy/issues/13055. ## Solution Swap from ```rust pub mod foo { pub use bevy_foo::*; } ``` to ```rust pub use bevy_foo as foo; ```
2024-04-22 01:32:51 +00:00
pub use bevy_text as text;
pub use bevy_time as time;
pub use bevy_transform as transform;
Add bevy_dylib to force dynamic linking of bevy (#808) This easily improve compilation time by 2x
2020-11-10 03:26:08 +00:00
#[cfg(feature = "bevy_ui")]
Switch monolithic lib to module re-exports (#13059) # Objective Makes crate module docs render correctly in the docs for the monolithic library. Fixes https://github.com/bevyengine/bevy/issues/13055. ## Solution Swap from ```rust pub mod foo { pub use bevy_foo::*; } ``` to ```rust pub use bevy_foo as foo; ```
2024-04-22 01:32:51 +00:00
pub use bevy_ui as ui;
pub use bevy_utils as utils;
pub use bevy_window as window;
Add bevy_dylib to force dynamic linking of bevy (#808) This easily improve compilation time by 2x
2020-11-10 03:26:08 +00:00
#[cfg(feature = "bevy_winit")]
Switch monolithic lib to module re-exports (#13059) # Objective Makes crate module docs render correctly in the docs for the monolithic library. Fixes https://github.com/bevyengine/bevy/issues/13055. ## Solution Swap from ```rust pub mod foo { pub use bevy_foo::*; } ``` to ```rust pub use bevy_foo as foo; ```
2024-04-22 01:32:51 +00:00
pub use bevy_winit as winit;
Reference in a new issue Copy permalink