Expand description
use bevy::prelude::*;
to import common components, bundles, and plugins.
Modules§
- adaptors
- Adaptors used by the Curve API for transforming and combining curves together.
- cores
- Core data structures to be used internally in Curve implementations, encapsulating storage and access patterns for reuse.
- derivatives
- This module holds traits related to extracting derivatives from curves. In
applications, the derivatives of interest are chiefly the first and second;
in this module, these are provided by the traits
CurveWithDerivative
andCurveWithTwoDerivatives
. - easing
- Module containing different easing functions.
- interval
- The
Interval
type for nonempty intervals used by theCurve
trait. - iterable
- Iterable curves, which sample in the form of an iterator in order to support
Vec
-like output whose length cannot be known statically. - light_
consts - Constants for operating with the light units: lumens, and lux.
- ops
- This mod re-exports the correct versions of floating-point operations with
unspecified precision in the standard library depending on whether the
libm
crate feature is enabled. - sample_
curves - Sample-interpolated curves constructed using the
Curve
API. - vec
- A contiguous growable array type with heap-allocated contents, written
Vec<T>
.
Macros§
- children
- Returns a
SpawnRelatedBundle
that will insert theChildren
component, spawn aSpawnableList
of entities with given bundles that relate to theChildren
entity via theChildOf
component, and reserve space in theChildren
for each spawned entity. - 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.
- format
- Creates a
String
using interpolation of runtime expressions. - 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.
- related
- Returns a
SpawnRelatedBundle
that will insert the givenRelationshipTarget
, spawn aSpawnableList
of entities with given bundles that relate to theRelationshipTarget
entity via theRelationshipTarget::Relationship
component, and reserve space in theRelationshipTarget
for each spawned entity. - 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.
- vec
- Creates a
Vec
containing the arguments. - 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§
- Add
- Trigger emitted when a component is inserted onto an entity that does not already have that
component. Runs before
Insert
. SeeComponentHooks::on_add
for more information. - Added
- A filter on a component that only retains results the first time after they have been added.
- Allow
- Allows a query to contain entities with the component
T
, bypassingDefaultQueryFilters
. - Ambient
Light - An ambient light, which lights the entire scene equally.
- Angular
Color Stop - An angular color stop for a conic gradient
- 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.- AppType
Registry - A
Resource
storingTypeRegistry
for type registrations relevant to a whole app. - Apply
Deferred - A special
System
that instructs the executor to callSystem::apply_deferred
on the systems that have run but not applied theirDeferred
system parameters (likeCommands
) or other system buffers. - Arc2d
- A primitive representing an arc between two points on a circle.
- Asset
Changed - Filter that selects entities with an
A
for an asset that changed after the system last ran, whereA
is a component that implementsAsAssetId
. - Asset
Plugin - Provides “asset” loading and processing functionality. An
Asset
is a “runtime value” that is loaded from anAssetSource
, which can be something like a filesystem, a network, etc. - Asset
Server - Loads and tracks the state of
Asset
values from a configuredAssetReader
. This can be used to kick off new asset loads and retrieve their current load states. - Assets
- Stores
Asset
values identified by theirAssetId
. - 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. - BVec3A
- A 3-dimensional SIMD vector mask.
- BVec4A
- A 4-dimensional SIMD vector mask.
- Back
InCurve f(t) = 2.70158 * t³ - 1.70158 * t²
- Back
InOut Curve - Behaves as
BackIn
for t < 0.5 and asBackOut
for t >= 0.5 - Back
OutCurve f(t) = 1.0 + 2.70158 * (t - 1.0)³ - 1.70158 * (t - 1.0)²
- Background
Color - The background color of the node
- Background
Gradient - A UI node that displays a gradient
- Bevy
Error - The built in “universal” Bevy error type. This has a blanket
From
impl for any type that implements Rust’sError
, meaning it can be used as a “catch all” error. - Border
Color - The border color of the UI node.
- Border
Gradient - A UI node border that displays a gradient
- Border
Radius - Used to add rounded corners to a UI node. You can set a UI node to have uniformly rounded corners or specify different radii for each corner. If a given radius exceeds half the length of the smallest dimension between the node’s height or width, the radius will calculated as half the smallest dimension.
- Border
Rect - Defines the extents of the border of a rectangle.
- Bounce
InCurve - bouncy at the start!
- Bounce
InOut Curve - Behaves as
BounceIn
for t < 0.5 and asBounceOut
for t >= 0.5 - Bounce
OutCurve - bouncy at the end!
- Box
- A pointer type that uniquely owns a heap allocation of type
T
. - BoxShadow
- List of shadows to draw for a
Node
. - Button
- Marker struct for buttons
- Button
Input - A “press-able” input of type
T
. - Calculated
Clip - The calculated clip of the node
- Camera
- The defining
Component
for camera entities, storing information about how and what to render through this camera. - Camera2d
- A 2D camera component. Enables the 2D render graph for a
Camera
. - Camera3d
- A 3D camera component. Enables the main 3D render graph for a
Camera
. - Cancel
- Fires when a pointer is canceled, and its current interaction state is dropped.
- Capsule2d
- A 2D capsule primitive, also known as a stadium or pill shape.
- Capsule3d
- A 3D capsule primitive centered on the origin A three-dimensional capsule is defined as a surface at a distance (radius) from a line
- Chain
Curve - The curve that results from chaining one curve with another. The second curve is effectively reparametrized so that its start is at the end of the first.
- Changed
- A filter on a component that only retains results the first time after they have been added or mutably dereferenced.
- ChildOf
- Stores the parent entity of this child entity with this component.
- Children
- Tracks which entities are children of this parent entity.
- Circle
- A circle primitive, representing the set of points some distance from the origin
- Circular
InCurve f(t) = 1.0 - sqrt(1.0 - t²)
- Circular
InOut Curve - Behaves as
CircularIn
for t < 0.5 and asCircularOut
for t >= 0.5 - Circular
OutCurve f(t) = sqrt((2.0 - t) * t)
- Circular
Sector - A primitive representing a circular sector: a pie slice of a circle.
- Circular
Segment - A primitive representing a circular segment: the area enclosed by the arc of a circle and its chord (the line between its endpoints).
- Clear
Color - A
Resource
that stores the default color that cameras use to clear the screen between frames. - Click
- Fires when a pointer sends a pointer pressed event followed by a pointer released event, with the same target entity for both events.
- Color
Stop - A color stop for a gradient
- Commands
- A
Command
queue to perform structural changes to theWorld
. - Computed
Node - Provides the computed size and layout properties of the node.
- Computed
UiRender Target Info - Derived information about the render target for this UI node.
- Computed
UiTarget Camera - Derived information about the camera target for this UI node.
- Cone
- A cone primitive centered on the midpoint between the tip of the cone and the center of its base.
- Conic
Gradient - A conic gradient
- Conical
Frustum - A conical frustum primitive. A conical frustum can be created by slicing off a section of a cone.
- Constant
Curve - A curve with a constant value over its domain.
- Continuation
Curve - The curve that results from chaining two curves.
- Convex
Polygon - A convex polygon with
N
vertices. - CubicB
Spline - A spline interpolated continuously across the nearest four control points. The curve does not necessarily pass through any of the control points.
- Cubic
Bezier - A spline composed of a single cubic Bezier curve.
- Cubic
Cardinal Spline - 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. - Cubic
Curve - A collection of
CubicSegment
s chained into a single parametric curve. It is aCurve
with domain[0, N]
, whereN
is its number of segments. - Cubic
Hermite - 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.
- Cubic
InCurve f(t) = t³
- Cubic
InOut Curve - Behaves as
CubicIn
for t < 0.5 and asCubicOut
for t >= 0.5 - Cubic
Nurbs - 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). - Cubic
OutCurve f(t) = (t - 1.0)³ + 1.0
- Cubic
Segment - A segment of a cubic curve, used to hold precomputed coefficients for fast interpolation.
It is a
Curve
with domain[0, 1]
. - Cuboid
- A cuboid primitive, which is like a cube, except that the x, y, and z dimensions are not required to be the same.
- Cursor
Entered - An event that is sent whenever the user’s cursor enters a window.
- Cursor
Left - An event that is sent whenever the user’s cursor leaves a window.
- Cursor
Moved - An event reporting that the mouse cursor has moved inside a window.
- Curve
Reparam Curve - A curve that has been reparametrized by another curve, using that curve to transform the
sample times before sampling. Curves of this type are produced by
CurveExt::reparametrize_by_curve
. - Cylinder
- A cylinder primitive centered on the origin
- Debug
Name - Wrapper to help debugging ECS issues. This is used to display the names of systems, components, …
- Default
Picking Plugins - One plugin that contains the
PointerInputPlugin
,PickingPlugin
and theInteractionPlugin
, this is probably the plugin that will be most used. - Default
Plugins - This plugin group will add all the default plugins for a Bevy application:
- Default
UiCamera - Deferred
- A
SystemParam
that stores a buffer which gets applied to theWorld
duringApplyDeferred
. This is used internally byCommands
to deferWorld
mutations. - Despawn
EntityEvent
emitted for each component on an entity when it is despawned. SeeComponentHooks::on_despawn
for more information.- 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.
- Directional
Light - A Directional light.
- Distance
Fog - Configures the “classic” computer graphics distance fog effect,
in which objects appear progressively more covered in atmospheric haze the further away they are from the camera.
Affects meshes rendered via the PBR
StandardMaterial
. - Drag
- Fires while the target entity is being dragged.
- Drag
Drop - Fires when a pointer drops the
dropped
entity onto the target entity. - DragEnd
- Fires when a pointer is dragging the target entity and a pointer released event is received.
- Drag
Enter - Fires when a pointer dragging the
dragged
entity enters the target entity. - Drag
Entry - Dragging state.
- Drag
Leave - Fires when a pointer dragging the
dragged
entity leaves the target entity. - Drag
Over - Fires while the
dragged
entity is being dragged over the target entity. - Drag
Start - Fires when the target entity receives a pointer pressed event followed by a pointer move event.
- Dynamic
Texture Atlas Builder - Helper utility to update
TextureAtlasLayout
on the fly. - Easing
Curve - A
Curve
that is defined by - Elastic
Curve f(omega,t) = 1 - (1 - t)²(2sin(omega * t) / omega + cos(omega * t))
, parametrized byomega
- Elastic
InCurve f(t) = -2.0^(10.0 * t - 10.0) * sin((t * 10.0 - 10.75) * 2.0 * π / 3.0)
- Elastic
InOut Curve - Behaves as
ElasticIn
for t < 0.5 and asElasticOut
for t >= 0.5 - Elastic
OutCurve f(t) = 2.0^(-10.0 * t) * sin((t * 10.0 - 0.75) * 2.0 * π / 3.0) + 1.0
- Ellipse
- An ellipse primitive, which is like a circle, but the width and height can be different
- Entity
- Lightweight identifier of an entity.
- Entity
Commands - A list of commands that will be run to modify an
Entity
. - Entity
Mut - Provides mutable access to a single entity and all of its components.
- Entity
Ref - A read-only reference to a particular
Entity
and all of its components. - Entity
World Mut - A mutable reference to a particular
Entity
, and the entire world. - Environment
MapLight - A pair of cubemap textures that represent the surroundings of a specific area in space.
- Even
Core - The data core of a curve derived from evenly-spaced samples. The intention is to use this
in addition to explicit or inferred interpolation information in user-space in order to
implement curves using
domain
andsample_with
. - Exponential
InCurve f(t) ≈ 2.0^(10.0 * (t - 1.0))
- Exponential
InOut Curve - Behaves as
ExponentialIn
for t < 0.5 and asExponentialOut
for t >= 0.5 - Exponential
OutCurve f(t) ≈ 1.0 - 2.0^(-10.0 * t)
- Extract
Schedule - Schedule which extract data from the main world and inserts it into the render world.
- Extrusion
- A 3D shape representing an extruded 2D
base_shape
. - Filtered
Resources - Provides read-only access to a set of
Resource
s defined by the containedAccess
. - Filtered
Resources Mut - Provides mutable access to a set of
Resource
s defined by the containedAccess
. - First
- Runs first in the schedule.
- Fixed
- The fixed timestep game clock following virtual time.
- Fixed
First - Runs first in the
FixedMain
schedule. - Fixed
Last - The schedule that runs last in
FixedMain
- Fixed
Post Update - The schedule that runs after the
FixedUpdate
schedule, for reacting to changes made in the main update logic. - Fixed
PreUpdate - The schedule that contains logic that must run before
FixedUpdate
. - Fixed
Update - The schedule that contains most gameplay logic, which runs at a fixed rate rather than every render frame.
For logic that should run once per render frame, use the
Update
schedule instead. - Font
- An
Asset
that contains the data for a loaded font, if loaded as an asset. - Forever
Curve - The curve that results from repeating a curve forever.
- Function
Curve - A curve defined by a function together with a fixed domain.
- Gamepad
- Stores a connected gamepad’s metadata such as the name and its
GamepadButton
andGamepadAxis
. - Gamepad
Settings - Gamepad settings component.
- Generated
Environment MapLight - A generated environment map that is filtered at runtime.
- Global
Transform GlobalTransform
is an affine transformation from entity-local coordinates to worldspace coordinates.- GlobalZ
Index GlobalZIndex
allows aNode
entity anywhere in the UI hierarchy to escape the implicit draw ordering of the UI’s layout tree and be rendered above or below other UI nodes. Nodes with aGlobalZIndex
of greater than 0 will be drawn on top of nodes without aGlobalZIndex
or nodes with a lowerGlobalZIndex
. Nodes with aGlobalZIndex
of less than 0 will be drawn below nodes without aGlobalZIndex
or nodes with a greaterGlobalZIndex
.- Graph
Curve - A curve that is the graph of another curve over its parameter space. Curves of this type are
produced by
CurveExt::graph
. - Grid
Placement - Represents the position of a grid item in a single axis.
- Grid
Track - A
GridTrack
is a Row or Column of a CSS Grid. This struct specifies what size the track should be. See below for the different “track sizing functions” you can specify. - Has
- Returns a bool that describes if an entity has the component
T
. - Hsla
- Color in Hue-Saturation-Lightness (HSL) color space with alpha. Further information on this color model can be found on Wikipedia.
- Hsva
- Color in Hue-Saturation-Value (HSV) color space with alpha. Further information on this color model can be found on Wikipedia.
- Hwba
- Color in Hue-Whiteness-Blackness (HWB) color space with alpha. Further information on this color model can be found on Wikipedia.
- IRect
- A rectangle defined by two opposite corners.
- IVec2
- A 2-dimensional vector.
- IVec3
- A 3-dimensional vector.
- IVec4
- A 4-dimensional vector.
- If
- A
SystemParam
that wraps another parameter and causes its system to skip instead of failing when the parameter is invalid. - Image
- An image, optimized for usage in rendering.
- Image
Node - A UI Node that renders an image.
- Image
Plugin - Adds the
Image
as an asset and makes sure that they are extracted and prepared for the GPU. - In
- A
SystemInput
type which denotes that aSystem
receives an input value of typeT
from its caller. - InMut
- A
SystemInput
type which denotes that aSystem
receives a mutable reference to a value of typeT
from its caller. - InRef
- A
SystemInput
type which denotes that aSystem
receives a read-only reference to a value of typeT
from its caller. - Infinite
Plane3d - An unbounded plane in 3D space. It forms a separating surface through the origin, stretching infinitely far
- Inherited
Visibility - Whether or not an entity is visible in the hierarchy.
This will not be accurate until
VisibilityPropagate
runs in thePostUpdate
schedule. - Insert
- Trigger emitted when a component is inserted, regardless of whether or not the entity already
had that component. Runs after
Add
, if it ran. SeeComponentHooks::on_insert
for more information. - Interaction
Plugin - Generates
Pointer
events and handles event bubbling. - Interval
- A nonempty closed interval, possibly unbounded in either direction.
- IsDefault
UiCamera - Marker used to identify default cameras, they will have priority over the
PrimaryWindow
camera. - Isometry2d
- An isometry in two dimensions, representing a rotation followed by a translation. This can often be useful for expressing relative positions and transformations from one position to another.
- Isometry3d
- An isometry in three dimensions, representing a rotation followed by a translation. This can often be useful for expressing relative positions and transformations from one position to another.
- Laba
- Color in LAB color space, with alpha
- Label
- Marker struct for labels
- Last
- Runs last in the schedule.
- Layout
Config - This component can be added to any UI node to modify its layout behavior.
- Lcha
- Color in LCH color space, with alpha
- Light
Probe - A marker component for a light probe, which is a cuboid region that provides global illumination to all fragments inside it.
- Line2d
- An infinite line going through the origin along a direction in 2D space.
- Line3d
- An infinite line going through the origin along a direction in 3D space.
- Linear
Curve f(t) = t
- Linear
Gradient - A linear gradient
- Linear
Reparam Curve - A curve that has had its domain changed by a linear reparameterization (stretching and scaling).
Curves of this type are produced by
CurveExt::reparametrize_linear
. - Linear
Rgba - Linear RGB color with alpha.
- Local
- A system local
SystemParam
. - Main
- The schedule that contains the app logic that is evaluated each tick of
App::update()
. - Manual
Texture Views - Resource that stores manually managed
ManualTextureView
s for use as aRenderTarget
. This type dereferences to aHashMap<ManualTextureViewHandle, ManualTextureView>
. To add a new texture view, pick a newManualTextureViewHandle
and insert it into the map. Then, to render to the view, set aCamera
starget
toRenderTarget::TextureView(handle)
. - MapCurve
- A curve whose samples are defined by mapping samples from another curve through a
given function. Curves of this type are produced by
CurveExt::map
. - Mat2
- A 2x2 column major matrix.
- Mat3
- A 3x3 column major matrix.
- Mat4
- A 4x4 column major matrix.
- Mat3A
- A 3x3 column major matrix.
- Material
Plugin - Adds the necessary ECS resources and render logic to enable rendering entities using the given
Material
asset type. - Mesh
- A 3D object made out of vertices representing triangles, lines, or points, with “attribute” values for each vertex.
- Mesh2d
- A component for 2D meshes. Requires a
MeshMaterial2d
to be rendered, commonly using aColorMaterial
. - Mesh3d
- A component for 3D meshes. Requires a
MeshMaterial3d
to be rendered, commonly using aStandardMaterial
. - Mesh
Material3d - A material used for rendering a
Mesh3d
. - Message
Mutator - Mutably reads messages of type
T
keeping track of which messages have already been read by each system allowing multiple systems to read the same messages. Ideal for chains of systems that all want to modify the same messages. - Message
Reader - Reads
Message
s of typeT
in order and tracks which messages have already been read. - Message
Writer - Writes
Message
s of typeT
. - Messages
- A message collection that represents the messages that occurred within the last two
Messages::update
calls. Messages can be written to using aMessageWriter
and are typically cheaply read using aMessageReader
. - Minimal
Plugins - This plugin group will add the minimal plugins for a Bevy application:
- Morph
Weights - Controls the morph targets for all child
Mesh3d
entities. In most cases,MorphWeights
should be considered the “source of truth” when writing morph targets for meshes. However you can choose to write childMeshMorphWeights
if your situation requires more granularity. Just note that if you setMorphWeights
, it will overwrite childMeshMorphWeights
values. - Move
- Fires while a pointer is moving over the target entity.
- 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.
- Name
OrEntity - Convenient query for giving a human friendly name to an entity.
- Node
- The base component for UI entities. It describes UI layout and style properties.
- NonSend
- Shared borrow of a non-
Send
resource. - NonSend
Mut - Unique borrow of a non-
Send
resource. - Observer
- An
Observer
system. Add thisComponent
to anEntity
to turn it into an “observer”. - Oklaba
- Color in Oklab color space, with alpha
- Oklcha
- Color in Oklch color space, with alpha
- On
- A system parameter used by an observer to process events. See
Observer
andEvent
for examples. - Or
- A filter that tests if any of the given filters apply.
- Orthographic
Projection - Project a 3D space onto a 2D surface using parallel lines, i.e., unlike
PerspectiveProjection
, the size of objects remains the same regardless of their distance to the camera. - Out
- Fires when a pointer crosses out of the bounds of the target entity.
- Outline
- The
Outline
component adds an outline outside the edge of a UI node. Outlines do not take up space in the layout. - Over
- Fires when a pointer crosses into the bounds of the target entity.
- Overflow
- Whether to show or hide overflowing items
- Overflow
Clip Margin - The bounds of the visible area when a UI node is clipped.
- Override
Clip - UI node entities with this component will ignore any clipping rect they inherit,
the node will not be clipped regardless of its ancestors’
Overflow
setting. - Parallel
Commands - An alternative to
Commands
that can be used in parallel contexts, such as those inQuery::par_iter
. - Param
Set - A collection of potentially conflicting
SystemParam
s allowed by disjoint access. - Perspective
Projection - A 3D camera projection in which distant objects appear smaller than close objects.
- Pickable
- An optional component that marks an entity as usable by a backend, and overrides default picking behavior for an entity.
- Picking
Message Writers - A helper system param for accessing the picking event writers.
- Picking
Plugin - This plugin sets up the core picking infrastructure. It receives input events, and provides the shared types used by other picking plugins.
- Ping
Pong Curve - The curve that results from chaining a curve with its reversed version. The transition point is guaranteed to make no jump.
- 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.
- Point
Light - A light that emits light in all directions from a central point.
- Pointer
- Stores the common data needed for all pointer events.
- Pointer
Button State - An entry in the cache that drives the
pointer_events
system, storing additional data about pointer button presses. - Pointer
Input Plugin - Adds mouse and touch inputs for picking pointers to your app. This is a default input plugin, that you can replace with your own plugin as needed.
- Pointer
State - State for all pointers.
- Pointer
Traversal - A traversal query (i.e. it implements
Traversal
) intended for use withPointer
events. - Pointer
Traversal Item - Automatically generated
WorldQuery
item type forPointerTraversal
, returned when iterating over query results. - 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.
- Populated
- System parameter that works very much like
Query
except it always contains at least one matching entity. - Post
Startup - The schedule that runs once after
Startup
. - Post
Update - The schedule that contains logic that must run after
Update
. For example, synchronizing “local transforms” in a hierarchy to “global” absolute transforms. This enables thePostUpdate
transform-sync system to react to “local transform” changes inUpdate
without theUpdate
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 aMessages
resource. This enables systems inUpdate
to consume the messages from theMessages
resource without actually knowing about (or taking a direct scheduler dependency on) the “os-level keyboard event system”. - Press
- Fires when a pointer button is pressed over the target entity.
- Quadratic
InCurve f(t) = t²
- Quadratic
InOut Curve - Behaves as
QuadraticIn
for t < 0.5 and asQuadraticOut
for t >= 0.5 - Quadratic
OutCurve f(t) = -(t * (t - 2.0))
- Quartic
InCurve f(t) = t⁴
- Quartic
InOut Curve - Behaves as
QuarticIn
for t < 0.5 and asQuarticOut
for t >= 0.5 - Quartic
OutCurve f(t) = (t - 1.0)³ * (1.0 - t) + 1.0
- Quat
- A quaternion representing an orientation.
- Query
- A system parameter that provides selective access to the
Component
data stored in aWorld
. - Query
Builder - Builder struct to create
QueryState
instances at runtime. - Query
State - Provides scoped access to a
World
state according to a givenQueryData
andQueryFilter
. - Quintic
InCurve f(t) = t⁵
- Quintic
InOut Curve - Behaves as
QuinticIn
for t < 0.5 and asQuinticOut
for t >= 0.5 - Quintic
OutCurve f(t) = (t - 1.0)⁵ + 1.0
- Radial
Gradient - A radial gradient
- Rational
Curve - A collection of
RationalSegment
s chained into a single parametric curve. It is aCurve
with domain[0, N]
, whereN
is the number of segments. - Rational
Segment - A segment of a rational cubic curve, used to hold precomputed coefficients for fast interpolation.
It is a
Curve
with domain[0, 1]
. - Ray2d
- An infinite half-line starting at
origin
and going indirection
in 2D space. - Ray3d
- An infinite half-line starting at
origin
and going indirection
in 3D space. - Real
- Real time clock representing elapsed wall clock time.
- Rect
- A rectangle defined by two opposite corners.
- Rectangle
- A rectangle primitive, which is like a square, except that the width and height can be different
- 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. - Reflect
Component - A struct used to operate on reflected
Component
trait of a type. - Reflect
Default - A struct used to provide the default value of a type.
- Reflect
Deserialize - A struct used to deserialize reflected instances of a type.
- Reflect
From Reflect - Type data that represents the
FromReflect
trait and allows it to be used dynamically. - Reflect
From World - A struct used to operate on the reflected
FromWorld
trait of a type. - Reflect
Resource - A struct used to operate on reflected
Resource
of a type. - Reflect
Serialize - A struct used to serialize reflected instances of a type.
- Regular
Polygon - A polygon centered on the origin where all vertices lie on a circle, equally far apart.
- Release
- Fires when a pointer button is released over the target entity.
- Remove
- Trigger emitted when a component is removed from an entity, and runs before the component is
removed, so you can still access the component data.
See
ComponentHooks::on_remove
for more information. - Removed
Components - A
SystemParam
that yields entities that had theirT
Component
removed or have been despawned with it. - Reparam
Curve - A curve whose sample space is mapped onto that of some base curve’s before sampling.
Curves of this type are produced by
CurveExt::reparametrize
. - Repeat
Curve - The curve that results from repeating a curve
N
times. - Repeated
Grid Track - Represents a possibly repeated
GridTrack
. - Replace
- Trigger emitted when a component is removed from an entity, regardless of whether or not it is later replaced.
- Res
- Shared borrow of a
Resource
. - ResMut
- Unique mutable borrow of a
Resource
. - Resolved
Border Radius - Represents the resolved border radius values for a UI node.
- Reverse
Curve - The curve that results from reversing another.
- Rhombus
- A rhombus primitive, also known as a diamond shape. A four sided polygon, centered on the origin, where opposite sides are parallel but without requiring right angles.
- Rot2
- A 2D rotation.
- RunFixed
Main Loop - Runs the
FixedMain
schedule in a loop according until all relevant elapsed time has been “consumed”. - Sample
Auto Curve - A curve that is defined by neighbor interpolation over a set of evenly-spaced samples, interpolated automatically using a particularly well-behaved interpolation.
- Sample
Curve - A curve that is defined by explicit neighbor interpolation over a set of evenly-spaced samples.
- 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
Schedule
s mapped toScheduleLabel
s excluding the current runningSchedule
. - Screen
Space Ambient Occlusion Plugin - Plugin for screen space ambient occlusion.
- Scroll
- Fires while a pointer is scrolling over the target entity.
- Scroll
Position - The scroll position of the node. Values are in logical pixels, increasing from top-left to bottom-right.
- Segment2d
- A line segment defined by two endpoints in 2D space.
- Segment3d
- A line segment defined by two endpoints in 3D space.
- Shader
- An “unprocessed” shader. It can contain preprocessor directives.
- Shadow
Style - Short
Name - Lazily shortens a type name to remove all module paths.
- Sine
InCurve f(t) = 1.0 - cos(t * π / 2.0)
- Sine
InOut Curve - Behaves as
SineIn
for t < 0.5 and asSineOut
for t >= 0.5 - Sine
OutCurve f(t) = sin(t * π / 2.0)
- Single
- System parameter that provides access to single entity’s components, much like
Query::single
/Query::single_mut
. - Smooth
Step Curve f(t) = 3t² - 2t³
- Smooth
Step InCurve - Behaves as the first half of
SmoothStepCurve
. - Smooth
Step OutCurve - Behaves as the second half of
SmoothStepCurve
. - Smoother
Step Curve f(t) = 6t⁵ - 15t⁴ + 10t³
- Smoother
Step InCurve - Behaves as the first half of
SmootherStepCurve
. - Smoother
Step OutCurve - Behaves as the second half of
SmootherStepCurve
. - Spawn
- A wrapper over a
Bundle
indicating that an entity should be spawned with thatBundle
. This is intended to be used for hierarchical spawning via traits likeSpawnableList
andSpawnRelated
. - Spawn
Iter - A
SpawnableList
that spawns entities using an iterator of a givenBundle
: - Spawn
Scene - The schedule that contains scene spawning.
- Spawn
With - A
SpawnableList
that spawns entities using aFnOnce
with aRelatedSpawner
as an argument: - Sphere
- A sphere primitive, representing the set of all points some distance from the origin
- Spot
Light - A light that emits light in a given direction from a central point.
- Sprite
- Describes a sprite to be rendered to a 2D camera
- Srgba
- Non-linear standard RGB with alpha.
- Standard
Material - A material with “standard” properties used in PBR lighting. Standard property values with pictures here: https://google.github.io/filament/notes/material_properties.html.
- Startup
- The schedule that runs once when the app starts.
- Steps
Curve n
steps connecting the start and the end. Jumping behavior is customizable viaJumpAt
. SeeJumpAt
for all the options and visual examples.- String
- A UTF-8–encoded, growable string.
- SubApp
- A secondary application with its own
World
. These can run independently of each other. - Task
Pool Options - Helper for configuring and creating the default task pools. For end-users who want full control,
set up
TaskPoolPlugin
- Task
Pool Plugin - Setup of default task pools:
AsyncComputeTaskPool
,ComputeTaskPool
,IoTaskPool
. - Tetrahedron
- A tetrahedron primitive.
- Text
- The top-level UI text component.
- Text2d
- The top-level 2D text component.
- Text
Background Color - The background color of the text for this section.
- Text
Color - The color of the text for this section.
- Text
Font TextFont
determines the style of a text span within aComputedTextBlock
, specifically the font face, the font size, the line height, and the antialiasing method.- Text
Layout - Component with text format settings for a block of text.
- Text
Shadow - Adds a shadow behind text
- Text
Span - A span of text in a tree of spans.
- Texture
Atlas - An index into a
TextureAtlasLayout
, which corresponds to a specific section of a texture. - Texture
Atlas Builder - A builder which is used to create a texture atlas from many individual sprites.
- Texture
Atlas Layout - Stores a map used to lookup the position of a texture in a
TextureAtlas
. This can be used to either use and look up a specific section of a texture, or animate frame-by-frame as a sprite sheet. - Texture
Atlas Sources - Stores a mapping from sub texture handles to the related area index.
- Texture
Slice - Single texture slice, representing a texture rect to draw in a given area
- Texture
Slicer - Slices a texture using the 9-slicing technique. This allows to reuse an image at various sizes without needing to prepare multiple assets. The associated texture will be split into nine portions, so that on resize the different portions scale or tile in different ways to keep the texture in proportion.
- 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 The set of points some distance from a circle centered at the origin
- Touch
Input - A touch input event.
- Touches
- A collection of
Touch
es. - Transform
- Describe the position of an entity. If the entity has a parent, the position is relative to its parent position.
- Transform
Helper - System parameter for computing up-to-date
GlobalTransform
s. - Transform
Plugin - The base plugin for handling
Transform
components - Transform
Tree Changed - An optimization for transform propagation. This ZST marker component uses change detection to
mark all entities of the hierarchy as “dirty” if any of their descendants have a changed
Transform
. If this component is not markedis_changed()
, propagation will halt. - Triangle2d
- A triangle in 2D space
- Triangle3d
- A 3D triangle primitive.
- URect
- A rectangle defined by two opposite corners.
- UVec2
- A 2-dimensional vector.
- UVec3
- A 3-dimensional vector.
- UVec4
- A 4-dimensional vector.
- UiGlobal
Transform - Absolute 2D transform for UI nodes
- UiPosition
- Responsive position relative to a UI node.
- UiRect
- A type which is commonly used to define margins, paddings and borders.
- UiScale
- The current scale of the UI.
- UiTarget
Camera - Indicates that this root
Node
entity should be rendered to a specific camera. - UiTransform
- Relative 2D transform for UI nodes
- Uneven
Core - The data core of a curve defined by unevenly-spaced samples or keyframes. The intention is to
use this in concert with implicitly or explicitly-defined interpolation in user-space in
order to implement the curve interface using
domain
andsample_with
. - Uneven
Sample Auto Curve - A curve that is defined by interpolation over unevenly spaced samples, interpolated automatically using a particularly well-behaved interpolation.
- Uneven
Sample Curve - A curve that is defined by interpolation over unevenly spaced samples with explicit interpolation.
- Update
- The schedule that contains any app logic that must run once per render frame.
For most gameplay logic, consider using
FixedUpdate
instead. - Val2
- A pair of
Val
s used to represent a 2-dimensional size or offset. - Vec
- A contiguous growable array type, written as
Vec<T>
, short for ‘vector’. - Vec2
- A 2-dimensional vector.
- Vec3
- A 3-dimensional vector.
- Vec4
- A 4-dimensional vector.
- Vec3A
- A 3-dimensional vector.
- View
Visibility - Algorithmically-computed indication of whether an entity is visible and should be extracted for rendering.
- Viewport
Node - Component used to render a
Camera::target
to a node. - Virtual
- The virtual game clock representing game time.
- Window
- The defining
Component
for window entities, storing information about how it should appear and behave. - Window
Moved - An event that is sent when a window is repositioned in physical pixels.
- Window
Plugin - A
Plugin
that defines an interface for windowing support in Bevy. - Window
Resize Constraints - The size limits on a
Window
. - With
- Filter that selects entities with a component
T
. - With
OneRelated - A wrapper over an
Entity
indicating that an entity should be added. This is intended to be used for hierarchical spawning via traits likeSpawnableList
andSpawnRelated
. - With
Related - A
SpawnableList
that links already spawned entities to the root entity via relations of typeI
. - Without
- Filter that selects entities without a component
T
. - World
- Stores and exposes operations on entities, components, resources, and their associated metadata.
- Xyza
- CIE 1931 color space, also known as XYZ, with an alpha channel.
- ZIndex
- Indicates that this
Node
entity’s front-to-back ordering is not controlled solely by its location in the UI hierarchy. A node with a higher z-index will appear on top of sibling nodes with a lower z-index. - ZipCurve
- A curve that combines the output data from two constituent curves into a tuple output. Curves
of this type are produced by
CurveExt::zip
.
Enums§
- Align
Content - Used to control how items are distributed.
- Align
Items - Used to control how each individual item is aligned by default within the space they’re given.
- Align
Self - Used to control how the specified item is aligned within the space it’s given.
- Alpha
Mode - Sets how a material’s base color alpha channel is used for transparency.
- AppExit
- A
Message
that indicates theApp
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. - Asset
Event Message
s that occur for a specific loadedAsset
, such as “value changed” events and “dependency” events.- AssetId
- A unique runtime-only identifier for an
Asset
. This is cheap toCopy
/Clone
and is not directly tied to the lifetime of the Asset. This means it can point to anAsset
that no longer exists. - Asset
Mode - Controls whether or not assets are pre-processed before being loaded.
- BoxSizing
- Which part of a Node’s box length styles like width and height control
- Chain
Error - An error indicating that an end-to-end composition couldn’t be performed because of malformed inputs.
- Clear
Color Config - For a camera, specifies the color used to clear the viewport before rendering or when writing to the final render target texture.
- Color
- An enumerated type that can represent any of the color types in this crate.
- Convex
Polygon Error - An error that happens when creating a
ConvexPolygon
. - Cubic
Nurbs Error - Error during construction of
CubicNurbs
- Display
- Defines the layout model used by this node.
- Ease
Function - Curve functions over the unit interval, commonly used for easing transitions.
- Euler
Rot - Euler rotation sequences.
- File
Drag AndDrop - Events related to files being dragged and dropped on a window.
- Flex
Direction - Defines how flexbox items are ordered within a flexbox
- Flex
Wrap - Defines if flexbox items appear on a single line or on multiple lines
- FogFalloff
- Allows switching between different fog falloff modes, and configuring their parameters.
- Gamepad
Axis - Represents gamepad input types that are mapped in the range [-1.0, 1.0].
- Gamepad
Button - Represents gamepad input types that are mapped in the range [0.0, 1.0].
- Gradient
- Grid
Auto Flow - Controls whether grid items are placed row-wise or column-wise as well as whether the sparse or dense packing algorithm is used.
- Grid
Placement Error - Errors that occur when setting constraints for a
GridPlacement
- Grid
Track Repetition - How many times to repeat a repeated grid track
- Handle
- A handle to a specific
Asset
of typeA
. Handles act as abstract “references” to assets, whose data are stored in theAssets<A>
resource, avoiding the need to store multiple copies of the same data. - HexColor
Error - Error returned if a hex string could not be parsed as a color.
- Image
Format - Ime
- An Input Method Editor event.
- Interaction
- Describes what type of input interaction has occurred for a UI node.
- Interpolation
Color Space - The color space used for interpolation.
- JumpAt
- Configuration options for the
EaseFunction::Steps
curves. This closely replicates the CSS step function specification. - Justify
- Describes the horizontal alignment of multiple lines of text relative to each other.
- Justify
Content - Used to control how items are distributed.
- Justify
Items - Used to control how each individual item is aligned by default within the space they’re given.
- Justify
Self - Used to control how the specified item is aligned within the space it’s given.
- KeyCode
- The key code of a
KeyboardInput
. - Line
Break - Determines how lines will be broken when preventing text from running out of bounds.
- Linear
Reparam Error - An error indicating that a linear reparameterization couldn’t be performed because of malformed inputs.
- MaxTrack
Sizing Function - MinTrack
Sizing Function - Monitor
Selection - References a screen monitor.
- Mouse
Button - A button on a mouse device.
- Msaa
- Component for configuring the number of samples for Multi-Sample Anti-Aliasing
for a
Camera
. - Node
Image Mode - Controls how the image is altered to fit within the layout and how the layout algorithm determines the space in the layout for the image
- Overflow
Axis - Whether to show or hide overflowing items
- Overflow
Clip Box - Used to determine the bounds of the visible area when a UI node is clipped.
- Parallax
Mapping Method - The parallax mapping method to use to compute depth based on the
material’s
depth_map
. - Ping
Pong Error - An error indicating that a ping ponging of a curve couldn’t be performed because of malformed inputs.
- Pointer
Button - The button that was just pressed or released
- Position
Type - The strategy used to position this node
- Projection
- Component that defines how to compute a
Camera
’s projection matrix. - Radial
Gradient Shape - Repeat
Error - An error indicating that a repetition of a curve couldn’t be performed because of malformed inputs.
- Resampling
Error - An error indicating that a resampling operation could not be performed because of malformed inputs.
- Reverse
Error - An error indicating that a reversion of a curve couldn’t be performed because of malformed inputs.
- RunFixed
Main Loop Systems - Set enum for the systems that want to run inside
RunFixedMainLoop
, but before or after the fixed update logic. Systems in this set will run exactly once per frame, regardless of the number of fixed updates. They will also run under a variable timestep. - Scaling
Mode - Represents various modes for proportional scaling of a texture.
- Slice
Scale Mode - Defines how a texture slice scales when resized
- Sprite
Image Mode - Controls how the image is altered when scaled.
- Text
Error - Errors related to the textsystem
- Texture
Error - An error that occurs when loading a texture.
- Timer
Mode - Specifies
Timer
behavior. - Torus
Kind - The type of torus determined by the minor and major radii
- Transform
Systems - Set enum for the systems relating to transform propagation
- Untyped
Handle - An untyped variant of
Handle
, which internally stores theAsset
type information at runtime as aTypeId
instead of encoding it in the compile-time type. This allows handles acrossAsset
types to be stored together and compared. - Val
- Represents the possible value types for layout properties.
- ValArithmetic
Error - ValParse
Error - Video
Mode Selection - References an exclusive fullscreen video mode.
- Visibility
- User indication of whether an entity is visible. Propagates down the entity hierarchy.
- Winding
Order - The winding order for a set of points
- Window
Position - Defines where a
Window
should be placed on the screen.
Traits§
- Alpha
- Methods for manipulating alpha values.
- Asset
- Declares that this type is an asset,
which can be loaded and managed by the
AssetServer
and stored inAssets
collections. - Asset
App - Adds asset-related builder methods to
App
. - Build
Children Transform Ext - Collection of methods similar to the built-in parenting methods on
EntityWorldMut
andEntityCommands
, but preserving each entity’sGlobalTransform
. - Bundle
- The
Bundle
trait enables insertion and removal ofComponent
s from an entity. - Color
ToComponents - Trait with methods for converting colors to non-color types
- Color
ToPacked - Trait with methods for converting colors to packed non-color types
- Command
- A
World
mutation. - Component
- A data type that can be used to store data for an entity.
- Contains
Entity - A trait for types that contain an
Entity
. - Cubic
Generator - Implement this on cubic splines that can generate a cubic curve from their spline parameters.
- Curve
- A trait for a type that can represent values of type
T
parametrized over a fixed interval. - Curve
Ext - Extension trait implemented by curves, allowing access to a number of adaptors and convenience methods.
- Curve
Resample Ext - Extension trait implemented by curves, allowing access to generic resampling methods as well as those based on stable interpolation.
- Cyclic
Cubic Generator - Implement this on cubic splines that can generate a cyclic cubic curve from their spline parameters.
- Detect
Changes - Types that can read change detection information.
This change detection is controlled by
DetectChangesMut
types such asResMut
. - Detect
Changes Mut - Types that implement reliable change detection.
- Direct
Asset Access Ext - An extension trait for methods for working with assets directly from a
World
. - Ease
- A type whose values can be eased between.
- Entity
Command - A command which gets executed for a given
Entity
. - Entity
Event - An
EntityEvent
is anEvent
that is triggered for a specificEntityEvent::event_target
entity: - Entity
Mapper - An implementor of this trait knows how to map an
Entity
into anotherEntity
. - Event
- An
Event
is something that “happens” at a given moment. - Float
Ext - A trait for extending
f32
andf64
with extra methods. - From
Reflect - A trait that enables types to be dynamically constructed from reflected data.
- FromRng
- Ergonomics trait for a type with a
StandardUniform
distribution, allowing values to be generated uniformly from anRng
by a method in its own namespace. - From
World - 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. - GetTuple
Struct Field - A convenience trait which combines fetching and downcasting of tuple struct fields.
- Gray
- Trait for returning a grayscale color of a provided lightness.
- Hue
- Trait for manipulating the hue of a color.
- InColor
Space - Set the color space used for interpolation.
- Into
Schedule Configs - Types that can convert into a
ScheduleConfigs
. - Into
System - Conversion trait to turn something into a
System
. - Into
System Set - Types that can be converted into a
SystemSet
. - Luminance
- Methods for changing the luminance of a color. Note that these methods are not guaranteed to produce consistent results across color spaces, but will be within a given space.
- Material
- Materials are used alongside
MaterialPlugin
,Mesh3d
, andMeshMaterial3d
to spawn entities that are rendered with a specificMaterial
type. They serve as an easy to use high level way to renderMesh3d
entities with custom shader logic. - Measured2d
- A trait for getting measurements of 2D shapes
- Measured3d
- A trait for getting measurements of 3D shapes
- Mesh
Builder - A trait used to build
Mesh
es from a configuration - Meshable
- A trait for shapes that can be turned into a
Mesh
. - Message
- A buffered message for pull-based event handling.
- Mix
- Linear interpolation of two colors within a given color space.
- Partial
Reflect - The foundational trait of
bevy_reflect
, used for accessing and modifying data dynamically. - Plugin
- A collection of Bevy app logic and configuration.
- Plugin
Group - Combines multiple
Plugin
s into a single unit. - Primitive2d
- A marker trait for 2D primitives
- Primitive3d
- A marker trait for 3D primitives
- Rational
Generator - Implement this on cubic splines that can generate a rational cubic curve from their spline parameters.
- Read
Only System System
types that do not modify theWorld
when run. This is implemented for any systems whose parameters all implementReadOnlySystemParam
.- Reflect
- A core trait of
bevy_reflect
, used for downcasting to concrete types. - Reflect
Path - Something that can be interpreted as a reflection path in
GetPath
. - Relationship
Target - A
Component
containing the collection of entities that relate to thisEntity
via the associatedRelationship
type. See theRelationship
documentation for more information. - Resource
- A type that can be inserted into a
World
as a singleton. - Saturation
- Trait for manipulating the saturation of a color.
- Shape
Sample - Exposes methods to uniformly sample a variety of primitive shapes.
- Spawn
Related RelationshipTarget
methods that create aBundle
with aDynamicBundle::Effect
that:- Stable
Interpolate - A type with a natural interpolation that provides strong subdivision guarantees.
- Struct
- A trait used to power struct-like operations via reflection.
- System
- An ECS system that can be added to a
Schedule
- System
Condition - A system that determines if one or more scheduled systems should run.
- System
Input - Trait for types that can be used as input to
System
s. - System
Param Builder - A builder that can create a
SystemParam
. - System
Param Function - A trait implemented for all functions that can be used as
System
s. - System
Set - System sets are tag-like labels that can be used to group systems together.
- ToOwned
- A generalization of
Clone
to borrowed data. - ToString
- A trait for converting a value to a
String
. - Transform
Point - A trait for point transformation methods.
- Tuple
Struct - A trait used to power tuple struct-like operations via reflection.
- Type
Path - A static accessor to type paths and names.
- ValNum
- All the types that should be able to be used in the
Val
enum should implement this trait. - Vec2
Swizzles - Vec3
Swizzles - Vec4
Swizzles - _
- Trait used to provide default values for Bevy-external types that
do not implement
Default
. - _
Functions§
- any_
component_ removed - A
SystemCondition
-satisfying system that returnstrue
if there are any entity with a component of the given type removed. - any_
match_ filter - A
SystemCondition
-satisfying system that returnstrue
if there are any entities that match the givenQueryFilter
. - any_
with_ component - A
SystemCondition
-satisfying system that returnstrue
if there are any entities with the given component type. - auto
- Returns a
Val::Auto
where the value is automatically determined based on the context and otherNode
properties. - bvec2
- Creates a 2-dimensional
bool
vector mask. - bvec3
- Creates a 3-dimensional
bool
vector mask. - bvec4
- Creates a 4-dimensional
bool
vector mask. - bvec3a
- Creates a 3-dimensional
bool
vector mask. - bvec4a
- Creates a 4-dimensional
bool
vector mask. - condition_
changed - Generates a
SystemCondition
that returns true when the passed one changes. - condition_
changed_ to - Generates a
SystemCondition
that returns true when the result of the passed one went from false to true since the last time this was called. - default
- An ergonomic abbreviation for
Default::default()
to make initializing structs easier. - interval
- Create an
Interval
with a givenstart
andend
. Alias ofInterval::new
. - ivec2
- Creates a 2-dimensional vector.
- ivec3
- Creates a 3-dimensional vector.
- ivec4
- Creates a 4-dimensional vector.
- mat2
- Creates a 2x2 matrix from two column vectors.
- mat3
- Creates a 3x3 matrix from three column vectors.
- mat4
- Creates a 4x4 matrix from four column vectors.
- mat3a
- Creates a 3x3 matrix from three column vectors.
- not
- Generates a
SystemCondition
that inverses the result of passed one. - on_
event Deprecated - A
SystemCondition
-satisfying system that returnstrue
if there are any new events of the given type since it was last called. - on_
message - A
SystemCondition
-satisfying system that returnstrue
if there are any new messages of the given type since it was last called. - percent
- Returns a
Val::Percent
representing a percentage of the parent node’s length along a specific axis. - pointer_
events - Dispatches interaction events to the target entities.
- px
- Returns a
Val::Px
representing a value in logical pixels. - quat
- Creates a quaternion from
x
,y
,z
andw
values. - resource_
added - A
SystemCondition
-satisfying system that returnstrue
if the resource of the given type has been added since the condition was last checked. - resource_
changed - A
SystemCondition
-satisfying system that returnstrue
if the resource of the given type has been added or mutably dereferenced since the condition was last checked. - resource_
changed_ or_ removed - A
SystemCondition
-satisfying system that returnstrue
if the resource of the given type has been added, removed or mutably dereferenced since the condition was last checked. - resource_
equals - Generates a
SystemCondition
-satisfying closure that returnstrue
if the resource is equal tovalue
. - resource_
exists - A
SystemCondition
-satisfying system that returnstrue
if the resource exists. - resource_
exists_ and_ changed - A
SystemCondition
-satisfying system that returnstrue
if the resource of the given type has been added or mutably dereferenced since the condition was last checked. - resource_
exists_ and_ equals - Generates a
SystemCondition
-satisfying closure that returnstrue
if the resource exists and is equal tovalue
. - resource_
removed - A
SystemCondition
-satisfying system that returnstrue
if the resource of the given type has been removed since the condition was last checked. - run_
once - A
SystemCondition
-satisfying system that returnstrue
on the first time the condition is run and false every time after. - uvec2
- Creates a 2-dimensional vector.
- uvec3
- Creates a 3-dimensional vector.
- uvec4
- Creates a 4-dimensional vector.
- vec2
- Creates a 2-dimensional vector.
- vec3
- Creates a 3-dimensional vector.
- vec4
- Creates a 4-dimensional vector.
- vec3a
- Creates a 3-dimensional vector.
- vh
- Returns a
Val::Vh
representing a percentage of the viewport height. - vmax
- Returns a
Val::VMax
representing a percentage of the viewport’s larger dimension. - vmin
- Returns a
Val::VMin
representing a percentage of the viewport’s smaller dimension. - vw
- Returns a
Val::Vw
representing a percentage of the viewport width.
Type Aliases§
- Child
Spawner - A type alias over
RelatedSpawner
used to spawn child entities containing aChildOf
relationship. - Child
Spawner Commands - A type alias over
RelatedSpawnerCommands
used to spawn child entities containing aChildOf
relationship. - Event
Reader Deprecated - This is deprecated. See
MessageReader
- Event
Writer Deprecated - This is deprecated. See
MessageWriter
- Events
Deprecated - This is deprecated. See
Messages
- OnAdd
Deprecated - Deprecated in favor of
Add
. - OnDespawn
Deprecated - Deprecated in favor of
Despawn
. - OnInsert
Deprecated - Deprecated in favor of
Insert
. - OnRemove
Deprecated - Deprecated in favor of
Remove
. - OnReplace
Deprecated - Deprecated in favor of
Replace
. - Result
- A result type for use in fallible systems, commands and observers.
- System
In - Shorthand way to get the
System::In
for aSystem
as aSystemInput::Inner
. - Text2d
Reader - 2d alias for
TextReader
. - Text2d
Writer - 2d alias for
TextWriter
. - Text
UiReader - UI alias for
TextReader
. - Text
UiWriter - UI alias for
TextWriter
. - Trigger
Deprecated - Deprecated in favor of
On
.
Attribute Macros§
- bevy_
main - Generates the required main function boilerplate for Android.
- reflect_
trait - A macro that automatically generates type data for traits, which their implementors can then register.
Derive Macros§
- Asset
- Implement the
Asset
trait. - Bundle
- Implement the
Bundle
trait. - Component
- Cheat sheet for derive syntax,
see full explanation and examples on the
Component
trait doc. - Deref
- Implements
Deref
for structs. This is especially useful when utilizing the newtype pattern. - Deref
Mut - Implements
DerefMut
for structs. This is especially useful when utilizing the newtype pattern. - Entity
Event - Cheat sheet for derive syntax,
see full explanation on
EntityEvent
trait docs. - Event
- Implement the
Event
trait. - From
Reflect - Derives the
FromReflect
trait. - From
World - Implement the
FromWorld
trait. - Message
- Implement the
Message
trait. - Reflect
- The main derive macro used by
bevy_reflect
for deriving itsReflect
trait. - Resource
- Implement the
Resource
trait. - System
Set - Derive macro generating an impl of the trait
SystemSet
. - Type
Path - Derives the
TypePath
trait, providing a stable alternative to [std::any::type_name
].