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

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

//! View (camera) constructors for right-handed world coordinate systems.
//!
//! Every function transforms world space points into a right-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 `DMat4`, `DAffine3`, or
//! similar return a full view transform (rotation and translation).
//! Functions returning `DMat3`, or `DQuat` return
//! only the view rotation.

use crate::{DAffine3, DMat3, DMat4, DQuat, DVec3, dcamera::camera_impl};

/// Returns a `DMat4` view matrix from eye, focal point, and up.
///
/// Transforms right-handed world space points into right-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: DVec3, center: DVec3, up: DVec3) -> DMat4 {
    look_to_mat4(eye, (center - eye).normalize(), up)
}

/// Returns a `DMat4` view matrix from eye, forward direction, and up.
///
/// Transforms right-handed world space points into right-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: DVec3, dir: DVec3, up: DVec3) -> DMat4 {
    camera_impl::look_to_mat4::<true>(eye, dir, up)
}

/// Returns an `DAffine3` view transform from eye, focal point, and up.
///
/// Transforms right-handed world space points into right-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: DVec3, center: DVec3, up: DVec3) -> DAffine3 {
    look_to_affine3(eye, (center - eye).normalize(), up)
}

/// Returns an `DAffine3` view transform from eye, forward direction, and up.
///
/// Transforms right-handed world space points into right-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: DVec3, dir: DVec3, up: DVec3) -> DAffine3 {
    camera_impl::look_to_affine3::<true>(eye, dir, up)
}

/// Returns a `DMat3` view rotation (no translation) from eye, focal point, and up.
///
/// Transforms right-handed world space points into right-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: DVec3, center: DVec3, up: DVec3) -> DMat3 {
    look_to_mat3((center - eye).normalize(), up)
}

/// Returns a `DMat3` view rotation (no translation) from direction and up.
///
/// Transforms right-handed world space points into right-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: DVec3, up: DVec3) -> DMat3 {
    camera_impl::look_to_mat3::<true>(dir, up)
}

/// Returns a `DQuat` view rotation from eye, focal point, and up.
///
/// Transforms right-handed world space points into right-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: DVec3, center: DVec3, up: DVec3) -> DQuat {
    look_to_quat((center - eye).normalize(), up)
}

/// Returns a `DQuat` view rotation from direction and up.
///
/// Transforms right-handed world space points into right-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: DVec3, up: DVec3) -> DQuat {
    camera_impl::look_to_quat::<true>(dir, up)
}