glam 0.34.1

A simple and fast 3D math library for games and graphics
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196

// Generated from camera_view.rs.tera template. Edit the template, not the generated file.

//! View (camera) constructors for left-handed world coordinate systems.
//!
//! Every function transforms world space points into a left-handed Y-up
//! view space with X-right and +Z-forward.
//!
//! * `look_at_*` targets a focal point (`center`)
//! * `look_to_*` targets a forward direction (`dir`)
//!
//! Functions returning `Mat4`, `Affine3`, `Affine3A`, or
//! similar return a full view transform (rotation and translation).
//! Functions returning `Mat3`, `Mat3A`, or `Quat` return
//! only the view rotation.

use crate::{Affine3, Affine3A, Mat3, Mat3A, Mat4, Quat, Vec3, camera::camera_impl};

/// Returns a `Mat4` view matrix from eye, focal point, and up.
///
/// Transforms left-handed world space points into left-handed Y-up view space.
///
/// # Panics
///
/// Will panic if `up` is not normalized, if `center` is equal to `eye`, or if the view
/// direction is parallel to `up`, when `glam_assert` is enabled.
#[inline]
#[must_use]
#[cfg_attr(any(debug_assertions, feature = "glam-assert"), track_caller)]
pub fn look_at_mat4(eye: Vec3, center: Vec3, up: Vec3) -> Mat4 {
    look_to_mat4(eye, (center - eye).normalize(), up)
}

/// Returns a `Mat4` view matrix from eye, forward direction, and up.
///
/// Transforms left-handed world space points into left-handed Y-up view space.
///
/// # Panics
///
/// Will panic if `dir` or `up` are not normalized, or if `dir` and `up` are parallel,
/// when `glam_assert` is enabled.
#[inline]
#[must_use]
#[cfg_attr(any(debug_assertions, feature = "glam-assert"), track_caller)]
pub fn look_to_mat4(eye: Vec3, dir: Vec3, up: Vec3) -> Mat4 {
    camera_impl::look_to_mat4::<false>(eye, dir, up)
}

/// Returns an `Affine3` view transform from eye, focal point, and up.
///
/// Transforms left-handed world space points into left-handed Y-up view space.
///
/// # Panics
///
/// Will panic if `up` is not normalized, if `center` is equal to `eye`, or if the view
/// direction is parallel to `up`, when `glam_assert` is enabled.
#[inline]
#[must_use]
#[cfg_attr(any(debug_assertions, feature = "glam-assert"), track_caller)]
pub fn look_at_affine3(eye: Vec3, center: Vec3, up: Vec3) -> Affine3 {
    look_to_affine3(eye, (center - eye).normalize(), up)
}

/// Returns an `Affine3` view transform from eye, forward direction, and up.
///
/// Transforms left-handed world space points into left-handed Y-up view space.
///
/// # Panics
///
/// Will panic if `dir` or `up` are not normalized, or if `dir` and `up` are parallel,
/// when `glam_assert` is enabled.
#[inline]
#[must_use]
#[cfg_attr(any(debug_assertions, feature = "glam-assert"), track_caller)]
pub fn look_to_affine3(eye: Vec3, dir: Vec3, up: Vec3) -> Affine3 {
    camera_impl::look_to_affine3::<false>(eye, dir, up)
}

/// Returns an `Affine3A` view transform from eye, focal point, and up.
///
/// Transforms left-handed world space points into left-handed Y-up view space.
///
/// # Panics
///
/// Will panic if `up` is not normalized, if `center` is equal to `eye`, or if the view
/// direction is parallel to `up`, when `glam_assert` is enabled.
#[inline]
#[must_use]
#[cfg_attr(any(debug_assertions, feature = "glam-assert"), track_caller)]
pub fn look_at_affine3a(eye: Vec3, center: Vec3, up: Vec3) -> Affine3A {
    look_to_affine3a(eye, (center - eye).normalize(), up)
}

/// Returns an `Affine3A` view transform from eye, forward direction, and up.
///
/// Transforms left-handed world space points into left-handed Y-up view space.
///
/// # Panics
///
/// Will panic if `dir` or `up` are not normalized, or if `dir` and `up` are parallel,
/// when `glam_assert` is enabled.
#[inline]
#[must_use]
#[cfg_attr(any(debug_assertions, feature = "glam-assert"), track_caller)]
pub fn look_to_affine3a(eye: Vec3, dir: Vec3, up: Vec3) -> Affine3A {
    camera_impl::look_to_affine3a::<false>(eye, dir, up)
}

/// Returns a `Mat3` view rotation (no translation) from eye, focal point, and up.
///
/// Transforms left-handed world space points into left-handed Y-up view space.
///
/// # Panics
///
/// Will panic if `up` is not normalized, if `center` is equal to `eye`, or if the view
/// direction is parallel to `up`, when `glam_assert` is enabled.
#[inline]
#[must_use]
#[cfg_attr(any(debug_assertions, feature = "glam-assert"), track_caller)]
pub fn look_at_mat3(eye: Vec3, center: Vec3, up: Vec3) -> Mat3 {
    look_to_mat3((center - eye).normalize(), up)
}

/// Returns a `Mat3` view rotation (no translation) from direction and up.
///
/// Transforms left-handed world space points into left-handed Y-up view space.
///
/// # Panics
///
/// Will panic if `dir` or `up` are not normalized, or if `dir` and `up` are parallel,
/// when `glam_assert` is enabled.
#[inline]
#[must_use]
#[cfg_attr(any(debug_assertions, feature = "glam-assert"), track_caller)]
pub fn look_to_mat3(dir: Vec3, up: Vec3) -> Mat3 {
    camera_impl::look_to_mat3::<false>(dir, up)
}

/// Returns a `Mat3A` view rotation (no translation) from eye, focal point, and up.
///
/// Transforms left-handed world space points into left-handed Y-up view space.
///
/// # Panics
///
/// Will panic if `up` is not normalized, if `center` is equal to `eye`, or if the view
/// direction is parallel to `up`, when `glam_assert` is enabled.
#[inline]
#[must_use]
#[cfg_attr(any(debug_assertions, feature = "glam-assert"), track_caller)]
pub fn look_at_mat3a(eye: Vec3, center: Vec3, up: Vec3) -> Mat3A {
    look_to_mat3a((center - eye).normalize(), up)
}

/// Returns a `Mat3A` view rotation (no translation) from direction and up.
///
/// Transforms left-handed world space points into left-handed Y-up view space.
///
/// # Panics
///
/// Will panic if `dir` or `up` are not normalized, or if `dir` and `up` are parallel,
/// when `glam_assert` is enabled.
#[inline]
#[must_use]
#[cfg_attr(any(debug_assertions, feature = "glam-assert"), track_caller)]
pub fn look_to_mat3a(dir: Vec3, up: Vec3) -> Mat3A {
    camera_impl::look_to_mat3a::<false>(dir, up)
}

/// Returns a `Quat` view rotation from eye, focal point, and up.
///
/// Transforms left-handed world space points into left-handed Y-up view space.
///
/// # Panics
///
/// Will panic if `up` is not normalized, if `center` is equal to `eye`, or if the view
/// direction is parallel to `up`, when `glam_assert` is enabled.
#[inline]
#[must_use]
#[cfg_attr(any(debug_assertions, feature = "glam-assert"), track_caller)]
pub fn look_at_quat(eye: Vec3, center: Vec3, up: Vec3) -> Quat {
    look_to_quat((center - eye).normalize(), up)
}

/// Returns a `Quat` view rotation from direction and up.
///
/// Transforms left-handed world space points into left-handed Y-up view space.
///
/// # Panics
///
/// Will panic if `dir` or `up` are not normalized, or if `dir` and `up` are parallel,
/// when `glam_assert` is enabled.
#[inline]
#[must_use]
#[cfg_attr(any(debug_assertions, feature = "glam-assert"), track_caller)]
pub fn look_to_quat(dir: Vec3, up: Vec3) -> Quat {
    camera_impl::look_to_quat::<false>(dir, up)
}