bevy_math/
lib.rs

1#![forbid(unsafe_code)]
2#![cfg_attr(
3    any(docsrs, docsrs_dep),
4    expect(
5        internal_features,
6        reason = "rustdoc_internals is needed for fake_variadic"
7    )
8)]
9#![cfg_attr(any(docsrs, docsrs_dep), feature(rustdoc_internals))]
10#![cfg_attr(docsrs, feature(doc_cfg))]
11#![doc(
12    html_logo_url = "https://bevy.org/assets/icon.png",
13    html_favicon_url = "https://bevy.org/assets/icon.png"
14)]
15#![no_std]
16
17//! Provides math types and functionality for the Bevy game engine.
18//!
19//! The commonly used types are vectors like [`Vec2`] and [`Vec3`],
20//! matrices like [`Mat2`], [`Mat3`] and [`Mat4`] and orientation representations
21//! like [`Quat`].
22
23#[cfg(feature = "std")]
24extern crate std;
25
26#[cfg(feature = "alloc")]
27extern crate alloc;
28
29mod affine3;
30mod aspect_ratio;
31pub mod common_traits;
32mod compass;
33mod direction;
34mod float_ord;
35mod isometry;
36mod mat3;
37pub mod ops;
38mod rects;
39mod rotation2d;
40
41#[cfg(feature = "rand")]
42pub mod sampling;
43
44pub use affine3::*;
45pub use aspect_ratio::AspectRatio;
46pub use common_traits::*;
47pub use compass::{CompassOctant, CompassQuadrant};
48pub use direction::*;
49pub use float_ord::*;
50pub use glam::camera::rh::proj::directx as proj;
51pub use glam::dcamera::rh::proj::directx as dproj;
52pub use isometry::{Isometry2d, Isometry3d};
53pub use mat3::*;
54pub use ops::FloatPow;
55pub use rects::*;
56pub use rotation2d::Rot2;
57
58#[cfg(feature = "rand")]
59pub use sampling::FromRng;
60
61/// The math prelude.
62///
63/// This includes the most common types in this crate, re-exported for your convenience.
64pub mod prelude {
65    #[doc(hidden)]
66    pub use crate::{
67        bvec2, bvec3, bvec3a, bvec4, bvec4a,
68        direction::{Dir2, Dir3, Dir3A},
69        ivec2, ivec3, ivec4, mat2, mat3, mat3a, mat4, ops, quat, uvec2, uvec3, uvec4, vec2, vec3,
70        vec3a, vec4, BVec2, BVec3, BVec3A, BVec4, BVec4A, EulerRot, FloatExt, IRect, IVec2, IVec3,
71        IVec4, Isometry2d, Isometry3d, Mat2, Mat3, Mat3A, Mat4, Quat, Rect, Rot2,
72        StableInterpolate, URect, UVec2, UVec3, UVec4, Vec2, Vec2Swizzles, Vec3, Vec3A,
73        Vec3Swizzles, Vec4, Vec4Swizzles,
74    };
75
76    #[doc(hidden)]
77    #[cfg(feature = "rand")]
78    pub use crate::sampling::FromRng;
79}
80
81pub use glam::prelude::*;
bevy_math/lib.rs

bevy_math/
lib.rs
