Skip to content

[Merged by Bors] - doc: document PerspectiveProjection#6310

Closed
dataphract wants to merge 3 commits into
bevyengine:mainfrom
dataphract:doc/persp-proj
Closed

[Merged by Bors] - doc: document PerspectiveProjection#6310
dataphract wants to merge 3 commits into
bevyengine:mainfrom
dataphract:doc/persp-proj

Conversation

@dataphract

Copy link
Copy Markdown
Member

Objective

Fixes #6279.

Solution

Added documentation explaining the meanings and default values of PerspectiveProjection's fields.

@dataphract dataphract added C-Docs An addition or correction to our documentation A-Rendering Drawing game state to the screen labels Oct 19, 2022
Comment thread crates/bevy_render/src/camera/projection.rs Outdated
Comment thread crates/bevy_render/src/camera/projection.rs Outdated
Comment thread crates/bevy_render/src/camera/projection.rs Outdated
@mockersf

Copy link
Copy Markdown
Member

You add the defaults to the documentation. Is there an easy way to ensure those remains in sync?

@dataphract

Copy link
Copy Markdown
Member Author

You add the defaults to the documentation. Is there an easy way to ensure those remains in sync?

Nothing automatic to my knowledge, but I wouldn't expect these defaults to change often.

@rparrett rparrett left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think some lines breaks would help with readability when rendered.

IMO, exposing these defaults to users is worth the overhead of maintaining the docs.

Comment thread crates/bevy_render/src/camera/projection.rs Outdated
Comment thread crates/bevy_render/src/camera/projection.rs Outdated
Comment thread crates/bevy_render/src/camera/projection.rs Outdated
Comment thread crates/bevy_render/src/camera/projection.rs Outdated
- insert additional line breaks
- provide default vertical FOV value in both radians and degrees

Co-authored-by: Rob Parrett <robparrett@gmail.com>
@james7132 james7132 added the S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it label Oct 20, 2022

@alice-i-cecile alice-i-cecile left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are fantastic, great work.

bors r+

bors Bot pushed a commit that referenced this pull request Oct 24, 2022
# Objective

Fixes #6279.

## Solution

Added documentation explaining the meanings and default values of `PerspectiveProjection`'s fields.


Co-authored-by: dataphract <86984145+dataphract@users.noreply.github.com>
@bors

bors Bot commented Oct 24, 2022

Copy link
Copy Markdown

Build failed (retrying...):

bors Bot pushed a commit that referenced this pull request Oct 24, 2022
# Objective

Fixes #6279.

## Solution

Added documentation explaining the meanings and default values of `PerspectiveProjection`'s fields.


Co-authored-by: dataphract <86984145+dataphract@users.noreply.github.com>
@bors bors Bot changed the title doc: document PerspectiveProjection [Merged by Bors] - doc: document PerspectiveProjection Oct 24, 2022
@bors bors Bot closed this Oct 24, 2022
james7132 pushed a commit to james7132/bevy that referenced this pull request Oct 28, 2022
# Objective

Fixes bevyengine#6279.

## Solution

Added documentation explaining the meanings and default values of `PerspectiveProjection`'s fields.


Co-authored-by: dataphract <86984145+dataphract@users.noreply.github.com>
Pietrek14 pushed a commit to Pietrek14/bevy that referenced this pull request Dec 17, 2022
# Objective

Fixes bevyengine#6279.

## Solution

Added documentation explaining the meanings and default values of `PerspectiveProjection`'s fields.


Co-authored-by: dataphract <86984145+dataphract@users.noreply.github.com>
ItsDoot pushed a commit to ItsDoot/bevy that referenced this pull request Feb 1, 2023
# Objective

Fixes bevyengine#6279.

## Solution

Added documentation explaining the meanings and default values of `PerspectiveProjection`'s fields.


Co-authored-by: dataphract <86984145+dataphract@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-Rendering Drawing game state to the screen C-Docs An addition or correction to our documentation S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it

Projects

None yet

Development

Successfully merging this pull request may close these issues.

PerspectiveProjection fields

5 participants