mirror of
https://github.com/bevyengine/bevy
synced 2025-01-08 03:08:55 +00:00
130953c717
# Objective CI should check for missing backticks in doc comments. Fixes #3435 ## Solution `clippy` has a lint for this: `doc_markdown`. This enables that lint in the CI script. Of course, enabling this lint in CI causes a bunch of lint errors, so I've gone through and fixed all of them. This was a huge edit that touched a ton of files, so I split the PR up by crate. When all of the following are merged, the CI should pass and this can be merged. + [x] #3467 + [x] #3468 + [x] #3470 + [x] #3469 + [x] #3471 + [x] #3472 + [x] #3473 + [x] #3474 + [x] #3475 + [x] #3476 + [x] #3477 + [x] #3478 + [x] #3479 + [x] #3480 + [x] #3481 + [x] #3482 + [x] #3483 + [x] #3484 + [x] #3485 + [x] #3486
150 lines
3.4 KiB
Rust
150 lines
3.4 KiB
Rust
#![warn(missing_docs)]
|
|
//! This module is separated into its own crate to enable simple dynamic linking for Bevy, and should not be used directly
|
|
|
|
/// `use bevy::prelude::*;` to import common components, bundles, and plugins.
|
|
pub mod prelude;
|
|
|
|
mod default_plugins;
|
|
pub use default_plugins::*;
|
|
|
|
pub mod app {
|
|
//! Build bevy apps, create plugins, and read events.
|
|
pub use bevy_app::*;
|
|
}
|
|
|
|
pub mod asset {
|
|
//! Load and store assets and resources for Apps.
|
|
pub use bevy_asset::*;
|
|
}
|
|
|
|
pub mod core {
|
|
//! Contains core plugins and utilities for time.
|
|
pub use bevy_core::*;
|
|
}
|
|
|
|
pub mod diagnostic {
|
|
//! Useful diagnostic plugins and types for bevy apps.
|
|
pub use bevy_diagnostic::*;
|
|
}
|
|
|
|
pub mod ecs {
|
|
//! Bevy's entity-component-system.
|
|
pub use bevy_ecs::*;
|
|
}
|
|
|
|
pub mod input {
|
|
//! Resources and events for inputs, e.g. mouse/keyboard, touch, gamepads, etc.
|
|
pub use bevy_input::*;
|
|
}
|
|
|
|
pub mod log {
|
|
//! Logging capabilities
|
|
pub use bevy_log::*;
|
|
}
|
|
|
|
pub mod math {
|
|
//! Math types (Vec3, Mat4, Quat, etc) and helpers.
|
|
pub use bevy_math::*;
|
|
}
|
|
|
|
pub mod reflect {
|
|
// TODO: remove these renames once TypeRegistryArc is no longer required
|
|
//! Type reflection used for dynamically interacting with rust types.
|
|
pub use bevy_reflect::{
|
|
TypeRegistry as TypeRegistryInternal, TypeRegistryArc as TypeRegistry, *,
|
|
};
|
|
}
|
|
|
|
pub mod scene {
|
|
//! Save/load collections of entities and components to/from file.
|
|
pub use bevy_scene::*;
|
|
}
|
|
|
|
pub mod tasks {
|
|
//! Pools for async, IO, and compute tasks.
|
|
pub use bevy_tasks::*;
|
|
}
|
|
|
|
pub mod transform {
|
|
//! Local and global transforms (e.g. translation, scale, rotation).
|
|
pub use bevy_transform::*;
|
|
}
|
|
|
|
pub mod utils {
|
|
//! Various miscellaneous utilities for easing development
|
|
pub use bevy_utils::*;
|
|
}
|
|
|
|
pub mod window {
|
|
//! Configuration, creation, and management of one or more windows.
|
|
pub use bevy_window::*;
|
|
}
|
|
|
|
#[cfg(feature = "bevy_audio")]
|
|
pub mod audio {
|
|
//! Provides types and plugins for audio playback.
|
|
pub use bevy_audio::*;
|
|
}
|
|
|
|
#[cfg(feature = "bevy_core_pipeline")]
|
|
pub mod core_pipeline {
|
|
//! Core render pipeline.
|
|
pub use bevy_core_pipeline::*;
|
|
}
|
|
|
|
#[cfg(feature = "bevy_gilrs")]
|
|
pub mod gilrs {
|
|
//! Bevy interface with `GilRs` - "Game Input Library for Rust" - to handle gamepad inputs.
|
|
pub use bevy_gilrs::*;
|
|
}
|
|
|
|
#[cfg(feature = "bevy_gltf")]
|
|
pub mod gltf {
|
|
//! Support for GLTF file loading.
|
|
pub use bevy_gltf::*;
|
|
}
|
|
|
|
#[cfg(feature = "bevy_pbr")]
|
|
pub mod pbr {
|
|
//! Physically based rendering.
|
|
pub use bevy_pbr::*;
|
|
}
|
|
|
|
#[cfg(feature = "bevy_render")]
|
|
pub mod render {
|
|
//! Cameras, meshes, textures, shaders, and pipelines.
|
|
pub use bevy_render::*;
|
|
}
|
|
|
|
#[cfg(feature = "bevy_sprite")]
|
|
pub mod sprite {
|
|
//! Items for sprites, rects, texture atlases, etc.
|
|
pub use bevy_sprite::*;
|
|
}
|
|
|
|
#[cfg(feature = "bevy_text")]
|
|
pub mod text {
|
|
//! Text drawing, styling, and font assets.
|
|
pub use bevy_text::*;
|
|
}
|
|
|
|
#[cfg(feature = "bevy_ui")]
|
|
pub mod ui {
|
|
//! User interface components and widgets.
|
|
pub use bevy_ui::*;
|
|
}
|
|
|
|
#[cfg(feature = "bevy_winit")]
|
|
pub mod winit {
|
|
//! Window creation, configuration, and handling
|
|
pub use bevy_winit::*;
|
|
}
|
|
|
|
#[cfg(feature = "bevy_dynamic_plugin")]
|
|
pub mod dynamic_plugin {
|
|
//! Dynamic linking of plugins
|
|
pub use bevy_dynamic_plugin::*;
|
|
}
|
|
|
|
#[cfg(target_os = "android")]
|
|
pub use ndk_glue;
|