Skip to content

doc(render): fix incorrectly transposed view matrix docs #19317

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

doc(render): fix incorrectly transposed view matrix docs #19317

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 22 additions & 18 deletions crates/bevy_render/src/view/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -262,16 +262,16 @@ impl RetainedViewEntity {
pub struct ExtractedView {
/// The entity in the main world corresponding to this render world view.
pub retained_view_entity: RetainedViewEntity,
/// Typically a right-handed projection matrix, one of either:
/// Typically a column-major right-handed projection matrix, one of either:
///
/// Perspective (infinite reverse z)
/// ```text
/// f = 1 / tan(fov_y_radians / 2)
///
/// ⎡ f / aspect 0 0 0 ⎤
/// ⎢ 0 f 0 0 ⎥
/// ⎢ 0 0 0 -1 ⎥
/// ⎣ 0 0 near 0 ⎦
/// ⎡ f / aspect 0 0 0 ⎤
/// ⎢ 0 f 0 0 ⎥
/// ⎢ 0 0 0 near ⎥
/// ⎣ 0 0 -1 0 ⎦
/// ```
///
/// Orthographic
Expand All @@ -282,14 +282,16 @@ pub struct ExtractedView {
/// cw = -right - left
/// ch = -top - bottom
///
/// ⎡ 2 / w 0 0 0 ⎤
/// ⎢ 0 2 / h 0 0 ⎥
/// ⎢ 0 0 1 / d 0 ⎥
/// ⎣ cw / w ch / h near / d 1 ⎦
/// ⎡ 2 / w 0 0 cw / w ⎤
/// ⎢ 0 2 / h 0 ch / h ⎥
/// ⎢ 0 0 1 / d near / d ⎥
/// ⎣ 0 0 0 1 ⎦
/// ```
///
/// `clip_from_view[3][3] == 1.0` is the standard way to check if a projection is orthographic
///
/// Glam matrices are column major, so for example getting the near plane is `clip_from_view[3][2]`
///
/// Custom projections are also possible however.
pub clip_from_view: Mat4,
pub world_from_view: GlobalTransform,
Expand Down Expand Up @@ -529,16 +531,16 @@ pub struct ViewUniform {
pub world_from_clip: Mat4,
pub world_from_view: Mat4,
pub view_from_world: Mat4,
/// Typically a right-handed projection matrix, one of either:
/// Typically a column-major right-handed projection matrix, one of either:
///
/// Perspective (infinite reverse z)
/// ```text
/// f = 1 / tan(fov_y_radians / 2)
///
/// ⎡ f / aspect 0 0 0 ⎤
/// ⎢ 0 f 0 0 ⎥
/// ⎢ 0 0 0 -1 ⎥
/// ⎣ 0 0 near 0 ⎦
/// ⎡ f / aspect 0 0 0 ⎤
/// ⎢ 0 f 0 0 ⎥
/// ⎢ 0 0 0 near ⎥
/// ⎣ 0 0 -1 0 ⎦
/// ```
///
/// Orthographic
Expand All @@ -549,14 +551,16 @@ pub struct ViewUniform {
/// cw = -right - left
/// ch = -top - bottom
///
/// ⎡ 2 / w 0 0 0 ⎤
/// ⎢ 0 2 / h 0 0 ⎥
/// ⎢ 0 0 1 / d 0 ⎥
/// ⎣ cw / w ch / h near / d 1 ⎦
/// ⎡ 2 / w 0 0 cw / w ⎤
/// ⎢ 0 2 / h 0 ch / h ⎥
/// ⎢ 0 0 1 / d near / d ⎥
/// ⎣ 0 0 0 1 ⎦
/// ```
///
/// `clip_from_view[3][3] == 1.0` is the standard way to check if a projection is orthographic
///
/// Glam matrices are column major, so for example getting the near plane is `clip_from_view[3][2]`
///
/// Custom projections are also possible however.
pub clip_from_view: Mat4,
pub view_from_clip: Mat4,
Expand Down
20 changes: 11 additions & 9 deletions crates/bevy_render/src/view/view.wgsl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,16 @@ struct View {
world_from_clip: mat4x4<f32>,
world_from_view: mat4x4<f32>,
view_from_world: mat4x4<f32>,
// Typically a right-handed projection matrix, one of either:
// Typically a column-major right-handed projection matrix, one of either:
//
// Perspective (infinite reverse z)
// ```
// f = 1 / tan(fov_y_radians / 2)
//
// ⎡ f / aspect 0 0 0 ⎤
// ⎢ 0 f 0 0 ⎥
// ⎢ 0 0 0 -1 ⎥
// ⎣ 0 0 near 0 ⎦
// ⎡ f / aspect 0 0 0 ⎤
// ⎢ 0 f 0 0 ⎥
// ⎢ 0 0 0 near ⎥
// ⎣ 0 0 -1 0 ⎦
// ```
//
// Orthographic
Expand All @@ -39,13 +39,15 @@ struct View {
// cw = -right - left
// ch = -top - bottom
//
// ⎡ 2 / w 0 0 0 ⎤
// ⎢ 0 2 / h 0 0 ⎥
// ⎢ 0 0 1 / d 0 ⎥
// ⎣ cw / w ch / h near / d 1 ⎦
// ⎡ 2 / w 0 0 cw / w ⎤
// ⎢ 0 2 / h 0 ch / h ⎥
// ⎢ 0 0 1 / d near / d ⎥
// ⎣ 0 0 0 1 ⎦
// ```
//
// `clip_from_view[3][3] == 1.0` is the standard way to check if a projection is orthographic
//
// Wgsl matrices are column major, so for example getting the near plane is `clip_from_view[3][2]`
//
// Custom projections are also possible however.
clip_from_view: mat4x4<f32>,
Expand Down