Skip to content
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

Document when Camera::viewport_to_world and related methods return None #8841

Merged
merged 8 commits into from
Aug 3, 2023
Merged

Document when Camera::viewport_to_world and related methods return None #8841

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
2e35ff0
Document when Camera::viewport_to_world and related methods return None
tormeh Jun 14, 2023
0aa192b
fixup: backtick None in comments
tormeh Jun 29, 2023
8fd32f3
fixup?: clarify render target comment
tormeh Jun 29, 2023
f7c871e
fixup: logical_viewport_size doc improvements
tormeh Jul 1, 2023
b2a63bf
fixup: world_to_ndc doc improvements
tormeh Jul 1, 2023
3b0002c
ndc_to_world doc improvements.
tormeh Jul 1, 2023
9e065e7
fixup: implicit frustum note
tormeh Jul 1, 2023
23996f0
Fixup: unbalanced backtics
tormeh Jul 1, 2023
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
Prev Previous commit
Next Next commit
fixup?: clarify render target comment
  • Loading branch information
@tormeh
tormeh committed Aug 1, 2023
commit 8fd32f324ecd6dd455480750b0eb9a6d93d43ba4
16 changes: 12 additions & 4 deletions crates/bevy_render/src/camera/camera.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,9 @@ impl Camera {
///
/// Returns `None` if both:
/// - The viewport is not set
/// - The render target is not set
/// - Bevy has not set the render target. This can happen if:
/// - The function is called just after the `Camera` is created, before `camera_system` is executed
/// - The target isn't correctly set (for example it points to an image that doesn't exist)
#[inline]
pub fn logical_viewport_size(&self) -> Option<Vec2> {
self.viewport
Expand Down Expand Up @@ -226,7 +228,9 @@ impl Camera {
/// Returns `None` if any of these conditions occur:
/// - The logical viewport size cannot be computed. This can happen if both:
/// - The viewport is not set
/// - The render target is not set
/// - Bevy has not set the render target. This can happen if:
/// - The function is called just after the `Camera` is created, before `camera_system` is executed
/// - The target isn't correctly set (for example it points to an image that doesn't exist)
/// - The projection matrix is invalid
/// - The camera transform is invalid or cannot be inverted
/// - The world position is invalid
Expand Down Expand Up @@ -263,7 +267,9 @@ impl Camera {
/// Returns `None` if any of these conditions occur:
/// - The logical viewport size cannot be computed. This can happen if both:
/// - The viewport is not set
/// - The render target is not set
/// - Bevy has not set the render target. This can happen if:
/// - The function is called just after the `Camera` is created, before `camera_system` is executed
/// - The target isn't correctly set (for example it points to an image that doesn't exist)
/// - The near or far plane cannot be computed. This can happen if:
/// - The projection matrix is invalid or cannot be inverted
/// - The camera transform is invalid
Expand Down Expand Up @@ -300,7 +306,9 @@ impl Camera {
/// Returns `None` if any of these conditions occur:
/// - The logical viewport size cannot be computed. This can happen if both:
/// - The viewport is not set
/// - The render target is not set
/// - Bevy has not set the render target. This can happen if:
/// - The function is called just after the `Camera` is created, before `camera_system` is executed
/// - The target isn't correctly set (for example it points to an image that doesn't exist)
/// - The viewport position cannot be mapped to the world. This can happen if:
/// - The projection matrix is invalid or cannot be inverted
/// - The camera transform is invalid
Expand Down