Module p

Source

Expand description

A module that re-exports the entire bevy::prelude as well as TestApp.

Re-exports§

pub use crate::TestApp;

Macros§

debug: Constructs an event at the debug level.
debug_once: Call debug! once per call site.
debug_span: Constructs a span at the debug level.
error: Constructs an event at the error level.
error_once: Call error! once per call site.
error_span: Constructs a span at the error level.
info: Constructs an event at the info level.
info_once: Call info! once per call site.
info_span: Constructs a span at the info level.
once: Call some expression only once per call site.
trace: Constructs an event at the trace level.
trace_once: Call trace! once per call site.
trace_span: Constructs a span at the trace level.
warn: Constructs an event at the warn level.
warn_once: Call warn! once per call site.
warn_span: Constructs a span at the warn level.

Structs§

Added: A filter on a component that only retains results the first time after they have been added.
AncestorIter: An Iterator of Entitys over the ancestors of an Entity.
Annulus: A primitive shape formed by the region between two circles, also known as a ring.
AnyOf: The AnyOf query parameter fetches entities with any of the component types included in T.
App: App is the primary API for writing user applications. It automates the setup of a standard lifecycle and provides interface glue for plugins.
AppTypeRegistry: A Resource storing TypeRegistry for type registrations relevant to a whole app.
Arc2d: A primitive representing an arc between two points on a circle.
Axis: Stores the position data of the input devices of type T.
BVec2: A 2-dimensional bool vector mask.
BVec3: A 3-dimensional bool vector mask.
BVec4: A 4-dimensional bool vector mask.
BoxedPolygon: A polygon with a variable number of vertices, allocated on the heap in a Box<[Vec2]>.
BoxedPolyline2d: A series of connected line segments in 2D space, allocated on the heap in a Box<[Vec2]>.
BoxedPolyline3d: A series of connected line segments in 3D space, allocated on the heap in a Box<[Vec3]>.
ButtonInput: A “press-able” input of type T.
Capsule2d: A 2D capsule primitive, also known as a stadium or pill shape.
Capsule3d: A 3D capsule primitive. A three-dimensional capsule is defined as a surface at a distance (radius) from a line
Changed: A filter on a component that only retains results the first time after they have been added or mutably dereferenced.
ChildBuilder: Struct for building children entities and adding them to a parent entity.
Children: Contains references to the child entities of this entity.
Circle: A circle primitive
CircularSector: A primitive representing a circular sector: a pie slice of a circle.
CircularSegment: A primitive representing a circular segment: the area enclosed by the arc of a circle and its chord (the line between its endpoints).
ClearChildren: Command that clears all children from an entity and removes Parent component from those children.
Commands: A Command queue to perform structural changes to the World.
Cone: A cone primitive centered on the midpoint between the tip of the cone and the center of its base.
ConicalFrustum: A conical frustum primitive. A conical frustum can be created by slicing off a section of a cone.
CubicBSpline: A spline interpolated continuously across the nearest four control points. The curve does not pass through any of the control points.
CubicBezier: A spline composed of a single cubic Bezier curve.
CubicCardinalSpline: A spline interpolated continuously across the nearest four control points, with the position of the curve specified at every control point and the tangents computed automatically. The associated CubicCurve has one segment between each pair of adjacent control points.
CubicCurve: A collection of CubicSegments chained into a single parametric curve. Has domain [0, N) where N is the number of attached segments.
CubicHermite: A spline interpolated continuously between the nearest two control points, with the position and velocity of the curve specified at both control points. This curve passes through all control points, with the specified velocity which includes direction and parametric speed.
CubicNurbs: Non-uniform Rational B-Splines (NURBS) are a powerful generalization of the CubicBSpline which can represent a much more diverse class of curves (like perfect circles and ellipses).
CubicSegment: A segment of a cubic curve, used to hold precomputed coefficients for fast interpolation. Can be evaluated as a parametric curve over the domain [0, 1).
Cuboid: A cuboid primitive, more commonly known as a box.
CursorEntered: An event that is sent whenever the user’s cursor enters a window.
CursorLeft: An event that is sent whenever the user’s cursor leaves a window.
CursorMoved: An event reporting that the mouse cursor has moved inside a window.
Cylinder: A cylinder primitive
DebugName: Convenient query for giving a human friendly name to an entity.
DefaultPlugins: This plugin group will add all the default plugins for a Bevy application:
Deferred: A SystemParam that stores a buffer which gets applied to the World during apply_deferred. This is used internally by Commands to defer World mutations.
DescendantIter: An Iterator of Entitys over the descendants of an Entity.
DespawnChildrenRecursive: Despawns the given entity’s children recursively
DespawnRecursive: Despawns the given entity and all its children recursively
Dir2: A normalized vector pointing in a direction in 2D space
Dir3: A normalized vector pointing in a direction in 3D space
Dir3A: A normalized SIMD vector pointing in a direction in 3D space.
Ellipse: An ellipse primitive
Entity: Lightweight identifier of an entity.
EntityMut: Provides mutable access to a single entity and all of its components.
EntityRef: A read-only reference to a particular Entity and all of its components.
EntityWorldMut: A mutable reference to a particular Entity, and the entire world. This is essentially a performance-optimized (Entity, &mut World) tuple, which caches the EntityLocation to reduce duplicate lookups.
EventReader: Reads events of type T in order and tracks which events have already been read.
EventWriter: Sends events of type T.
Events: An event collection that represents the events that occurred within the last two Events::update calls. Events can be written to using an EventWriter and are typically cheaply read using an EventReader.
Extrusion: A 3D shape representing an extruded 2D base_shape.
First: Runs first in the schedule.
Fixed: The fixed timestep game clock following virtual time.
FixedFirst: Runs first in the FixedMain schedule.
FixedLast: The schedule that runs last in FixedMain
FixedPostUpdate: The schedule that runs after the FixedUpdate schedule, for reacting to changes made in the main update logic.
FixedPreUpdate: The schedule that contains logic that must run before FixedUpdate.
FixedUpdate: The schedule that contains most gameplay logic.
FrameCountPlugin: Adds frame counting functionality to Apps.
Gamepad: A gamepad with an associated ID.
GamepadAxis: An axis of a Gamepad.
GamepadButton: A button of a Gamepad.
Gamepads: A collection of connected Gamepads.
GlobalTransform: Describe the position of an entity relative to the reference frame.
Has: Returns a bool that describes if an entity has the component T.
HierarchyPlugin: Provides hierarchy functionality to a Bevy app.
IRect: A rectangle defined by two opposite corners.
IVec2: A 2-dimensional vector.
IVec3: A 3-dimensional vector.
IVec4: A 4-dimensional vector.
In: Wrapper type to mark a SystemParam as an input.
InfinitePlane3d: An unbounded plane in 3D space. It forms a separating surface through the origin, stretching infinitely far
InsertChildren: Command that inserts a child at a given index of a parent’s children, shifting following children back.
Last: Runs last in the schedule.
Line2d: An infinite line along a direction in 2D space.
Line3d: An infinite line along a direction in 3D space.
Local: A system local SystemParam.
Main: The schedule that contains the app logic that is evaluated each tick of App::update().
Mat2: A 2x2 column major matrix.
Mat3: A 3x3 column major matrix.
Mat4: A 4x4 column major matrix.
MinimalPlugins: This plugin group will add the minimal plugins for a Bevy application:
Mut: Unique mutable borrow of an entity’s component or of a resource.
Name: Component used to identify an entity. Stores a hash for faster comparisons.
NonSend: Shared borrow of a non-Send resource.
NonSendMut: Unique borrow of a non-Send resource.
Observer: An Observer system. Add this Component to an Entity to turn it into an “observer”.
OnAdd: Trigger emitted when a component is added to an entity.
OnInsert: Trigger emitted when a component is inserted on to to an entity.
OnRemove: Trigger emitted when a component is removed from an entity.
Or: A filter that tests if any of the given filters apply.
ParallelCommands: An alternative to Commands that can be used in parallel contexts, such as those in Query::par_iter
ParamSet: A collection of potentially conflicting SystemParams allowed by disjoint access.
Parent: Holds a reference to the parent entity of this entity. This component should only be present on entities that actually have a parent entity.
Plane2d: An unbounded plane in 2D space. It forms a separating surface through the origin, stretching infinitely far
Plane3d: A bounded plane in 3D space. It forms a surface starting from the origin with a defined height and width.
Polygon: A polygon with N vertices.
Polyline2d: A series of connected line segments in 2D space.
Polyline3d: A series of connected line segments in 3D space.
PostStartup: The schedule that runs once after Startup.
PostUpdate: The schedule that contains logic that must run after Update. For example, synchronizing “local transforms” in a hierarchy to “global” absolute transforms. This enables the PostUpdate transform-sync system to react to “local transform” changes in Update without the Update systems needing to know about (or add scheduler dependencies for) the “global transform sync system”.
PreStartup: The schedule that runs before Startup.
PreUpdate: The schedule that contains logic that must run before Update. For example, a system that reads raw keyboard input OS events into an Events resource. This enables systems in Update to consume the events from the Events resource without actually knowing about (or taking a direct scheduler dependency on) the “os-level keyboard event system”.
PushChild: Command that adds a child to an entity.
PushChildren: Command that pushes children to the end of the entity’s Children.
Quat: A quaternion representing an orientation.
Query: System parameter that provides selective access to the Component data stored in a World.
QueryBuilder: Builder struct to create QueryState instances at runtime.
QueryState: Provides scoped access to a World state according to a given QueryData and QueryFilter.
RationalCurve: A collection of RationalSegments chained into a single parametric curve.
RationalSegment: A segment of a rational cubic curve, used to hold precomputed coefficients for fast interpolation. Can be evaluated as a parametric curve over the domain [0, knot_span).
Ray2d: An infinite half-line starting at origin and going in direction in 2D space.
Ray3d: An infinite half-line starting at origin and going in direction in 3D space.
Real: Real time clock representing elapsed wall clock time.
ReceivedCharacterDeprecated: An event that is sent whenever a window receives a character from the OS or underlying system.
Rect: A rectangle defined by two opposite corners.
Rectangle: A rectangle primitive
Ref: Shared borrow of an entity’s component with access to change detection. Similar to Mut but is immutable and so doesn’t require unique access.
ReflectComponent: A struct used to operate on reflected Component trait of a type.
ReflectDefault: A struct used to provide the default value of a type.
ReflectDeserialize: A struct used to deserialize reflected instances of a type.
ReflectFromReflect: Type data that represents the FromReflect trait and allows it to be used dynamically.
ReflectFromWorld: A struct used to operate on the reflected FromWorld trait of a type.
ReflectResource: A struct used to operate on reflected Resource of a type.
ReflectSerialize: A struct used to serialize reflected instances of a type.
RegularPolygon: A polygon where all vertices lie on a circle, equally far apart.
RemoveChildren: Command that removes children from an entity, and removes these children’s parent.
RemoveParent: Command that removes the parent of an entity, and removes that entity from the parent’s Children.
RemovedComponents: A SystemParam that yields entities that had their T Component removed or have been despawned with it.
ReplaceChildren: Command that clear all children from an entity, replacing them with the given children.
Res: Shared borrow of a Resource.
ResMut: Unique mutable borrow of a Resource.
Rhombus: A rhombus primitive, also known as a diamond shape.
Rot2: A counterclockwise 2D rotation.
Schedule: A collection of systems, and the metadata and executor needed to run them in a certain order under certain conditions.
Schedules: Resource that stores Schedules mapped to ScheduleLabels excluding the current running Schedule.
Segment2d: A segment of a line along a direction in 2D space.
Segment3d: A segment of a line along a direction in 3D space.
SpawnScene: The schedule that contains scene spawning.
Sphere: A sphere primitive
Startup: The schedule that runs once when the app starts.
SubApp: A secondary application with its own World. These can run independently of each other.
SystemBuilder: Builder struct used to construct state for SystemParam passed to a system.
TaskPoolOptions: Helper for configuring and creating the default task pools. For end-users who want full control, set up TaskPoolPlugin
TaskPoolPlugin: Setup of default task pools: AsyncComputeTaskPool, ComputeTaskPool, IoTaskPool.
Tetrahedron: A tetrahedron primitive.
Time: A generic clock resource that tracks how much it has advanced since its previous update and since its creation.
Timer: Tracks elapsed time. Enters the finished state once duration is reached.
Torus: A torus primitive, often representing a ring or donut shape
TouchInput: A touch input event.
Touches: A collection of Touches.
Transform: Describe the position of an entity. If the entity has a parent, the position is relative to its parent position.
TransformBundle: A Bundle of the Transform and GlobalTransform [Component]s, which describe the position of an entity.
TransformHelper: System parameter for computing up-to-date GlobalTransforms.
TransformPlugin: The base plugin for handling Transform components
Triangle2d: A triangle in 2D space
Triangle3d: A 3D triangle primitive.
Trigger: Type containing triggered Event information for a given run of an Observer. This contains the Event data itself. If it was triggered for a specific Entity, it includes that as well.
TypeRegistrationPlugin: Registration of default types to the TypeRegistry resource.
URect: A rectangle defined by two opposite corners.
UVec2: A 2-dimensional vector.
UVec3: A 3-dimensional vector.
UVec4: A 4-dimensional vector.
Update: The schedule that contains app logic. Ideally containing anything that must run once per render frame, such as UI.
ValidParentCheckPlugin: Print a warning for each Entity with a T component whose parent doesn’t have a T component.
Vec2: A 2-dimensional vector.
Vec3: A 3-dimensional vector.
Vec4: A 4-dimensional vector.
Virtual: The virtual game clock representing game time.
Window: The defining Component for window entities, storing information about how it should appear and behave.
WindowMoved: An event that is sent when a window is repositioned in physical pixels.
WindowPlugin: A Plugin that defines an interface for windowing support in Bevy.
WindowResizeConstraints: The size limits on a Window.
With: Filter that selects entities with a component T.
Without: Filter that selects entities without a component T.
World: Stores and exposes operations on entities, components, resources, and their associated metadata.
WorldChildBuilder: Struct for adding children to an entity directly through the World for use in exclusive systems.

Enums§

AppExit: An event that indicates the App should exit. If one or more of these are present at the end of an update, the runner will end and (maybe) return control to the caller.
CubicNurbsError: Error during construction of CubicNurbs
CursorIcon: The icon to display for a Window’s Cursor.
EulerRot: Euler rotation sequences.
FileDragAndDrop: Events related to files being dragged and dropped on a window.
GamepadAxisType: A type of a GamepadAxis.
GamepadButtonType: A type of a GamepadButton.
Ime: A Input Method Editor event.
KeyCode: The key code of a KeyboardInput.
MonitorSelection: References a screen monitor.
MouseButton: A button on a mouse device.
ShouldUpdateEvents: Controls whether or not the events in an EventRegistry should be updated.
TimerMode: Specifies Timer behavior.
TorusKind: The type of torus determined by the minor and major radii
TransformSystem: Set enum for the systems relating to transform propagation
WindingOrder: The winding order for a set of points
WindowPosition: Defines where a Window should be placed on the screen.

Traits§

BuildChildren: Trait for removing, adding and replacing children and parents of an entity.
BuildChildrenTransformExt: Collection of methods similar to BuildChildren, but preserving each entity’s GlobalTransform.
BuildWorldChildren: Trait that defines adding, changing and children and parents of an entity directly through the World.
Bundle: The Bundle trait enables insertion and removal of Components from an entity.
Component: A data type that can be used to store data for an entity.
Condition: A system that determines if one or more scheduled systems should run.
CubicGenerator: Implement this on cubic splines that can generate a cubic curve from their spline parameters.
DespawnRecursiveExt: Trait that holds functions for despawning recursively down the transform hierarchy
DetectChanges: Types that can read change detection information. This change detection is controlled by DetectChangesMut types such as ResMut.
DetectChangesMut: Types that implement reliable change detection.
EntityMapper: An implementor of this trait knows how to map an Entity into another Entity.
Event: Something that “happens” and might be read / observed by app logic.
FloatExt: A trait for extending f32 and f64 with extra methods.
FromReflect: A trait that enables types to be dynamically constructed from reflected data.
FromRng: Ergonomics trait for a type with a Standard distribution, allowing values to be generated uniformly from an Rng by a method in its own namespace.
FromWorld: Creates an instance of the type this trait is implemented for using data from the supplied World.
GetField: A convenience trait which combines fetching and downcasting of struct fields.
GetPath: A trait which allows nested Reflect values to be retrieved with path strings.
GetTupleStructField: A convenience trait which combines fetching and downcasting of tuple struct fields.
HierarchyQueryExt: An extension trait for Query that adds hierarchy related methods.
IntoSystem: Conversion trait to turn something into a System.
IntoSystemConfigs: Types that can convert into a SystemConfigs.
IntoSystemSet: Types that can be converted into a SystemSet.
IntoSystemSetConfigs: Types that can convert into a SystemSetConfigs.
Measured2d: A trait for getting measurements of 2D shapes
Measured3d: A trait for getting measurements of 3D shapes
Plugin: A collection of Bevy app logic and configuration.
PluginGroup: Combines multiple Plugins into a single unit.
Primitive2d: A marker trait for 2D primitives
Primitive3d: A marker trait for 3D primitives
RationalGenerator: Implement this on cubic splines that can generate a rational cubic curve from their spline parameters.
ReadOnlySystem: System types that do not modify the World when run. This is implemented for any systems whose parameters all implement ReadOnlySystemParam.
Reflect: The core trait of bevy_reflect, used for accessing and modifying data dynamically.
ReflectPath: Something that can be interpreted as a reflection path in GetPath.
Resource: A type that can be inserted into a World as a singleton.
ShapeSample: Exposes methods to uniformly sample a variety of primitive shapes.
Struct: A trait used to power struct-like operations via reflection.
System: An ECS system that can be added to a Schedule
SystemParamFunction: A trait implemented for all functions that can be used as Systems.
SystemSet: Types that identify logical groups of systems.
TransformPoint: A trait for point transformation methods.
TupleStruct: A trait used to power tuple struct-like operations via reflection.
TypePath: A static accessor to type paths and names.
Vec2Swizzles
Vec3Swizzles
Vec4Swizzles

Functions§

any_component_removed: Generates a Condition-satisfying closure that returns true if there are any entity with a component of the given type removed.
any_with_component: A Condition-satisfying system that returns true if there are any entities with the given component type.
apply_deferred: Instructs the executor to call System::apply_deferred on the systems that have run but not applied their Deferred system parameters (like Commands) or other system buffers.
default: An ergonomic abbreviation for Default::default() to make initializing structs easier. This is especially helpful when combined with “struct update syntax”.
despawn_with_children_recursive: Function for despawning an entity and all its children
not: Generates a Condition that inverses the result of passed one.
on_event: Generates a Condition-satisfying closure that returns true if there are any new events of the given type since it was last called.
resource_added: A Condition-satisfying system that returns true if the resource of the given type has been added since the condition was last checked.
resource_changed: A Condition-satisfying system that returns true if the resource of the given type has had its value changed since the condition was last checked.
resource_changed_or_removed: Generates a Condition-satisfying closure that returns true if the resource of the given type has had its value changed since the condition was last checked.
resource_equals: Generates a Condition-satisfying closure that returns true if the resource is equal to value.
resource_exists: A Condition-satisfying system that returns true if the resource exists.
resource_exists_and_changed: A Condition-satisfying system that returns true if the resource of the given type has had its value changed since the condition was last checked.
resource_exists_and_equals: Generates a Condition-satisfying closure that returns true if the resource exists and is equal to value.
resource_removed: Generates a Condition-satisfying closure that returns true if the resource of the given type has been removed since the condition was last checked.
run_once: Generates a Condition-satisfying closure that returns true if the first time the condition is run and false every time after

Attribute Macros§

bevy_main
reflect_trait: A macro that automatically generates type data for traits, which their implementors can then register.

Derive Macros§

Bundle
Component
Deref: Implements Deref for structs. This is especially useful when utilizing the newtype pattern.
DerefMut: Implements DerefMut for structs. This is especially useful when utilizing the newtype pattern.
DynamicPlugin: Generates a dynamic plugin entry point function for the given Plugin type.
Event
FromReflect: Derives the FromReflect trait.
Reflect: The main derive macro used by bevy_reflect for deriving its Reflect trait.
Resource
SystemSet: Derive macro generating an impl of the trait SystemSet.
TypePath: Derives the TypePath trait, providing a stable alternative to [std::any::type_name].

Module pCopy item path

Re-exports§

Macros§

Structs§

Enums§

Traits§

Functions§

Attribute Macros§

Derive Macros§

Module p