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

Jump to bottom

PerspectiveProjection fields #6279

Closed
Feilkin opened this issue Oct 17, 2022 · 2 comments
Closed

PerspectiveProjection fields #6279

Feilkin opened this issue Oct 17, 2022 · 2 comments
Labels
A-Rendering Drawing game state to the screen C-Docs An addition or correction to our documentation D-Trivial Nice and easy! A great choice to get started with Bevy

Comments

@Feilkin
Copy link
Contributor

Feilkin commented Oct 17, 2022

How can Bevy's documentation be improved?

Provide a link to the documentation and describe how it could be improved. In what ways is it incomplete, incorrect, or misleading?

The fields of the PerspectiveProjection have no documentation, and this is extremely confusing for the fov field at least, since it is not told if this should be in degrees or radians, and if it is the vertical or horizontal FOV. Looking at the default value, I'd guess it is supposed to be given in radians.

If you have suggestions on exactly what the new docs should say, feel free to include them here. Or alternatively, make the changes yourself and create a pull request instead.

I suggest that documentation is added for all these fields, what they are used for and what units they should be in.
@Feilkin Feilkin added C-Docs An addition or correction to our documentation S-Needs-Triage This issue needs to be labelled labels Oct 17, 2022
@rparrett rparrett added D-Trivial Nice and easy! A great choice to get started with Bevy A-Rendering Drawing game state to the screen and removed S-Needs-Triage This issue needs to be labelled labels Oct 17, 2022
@rparrett
Copy link
Contributor

fov is the vertical fov in radians.

@rparrett
Copy link
Contributor

There are WIP docs here for OrthographicProjection that might be of use for near and far.

@dataphract dataphract mentioned this issue Oct 19, 2022
Closed
bors bot pushed a commit that referenced this issue Oct 24, 2022
@dataphract
doc: document PerspectiveProjection (#6310)
1f0d473 
# Objective

Fixes #6279.

## Solution

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


Co-authored-by: dataphract <[email protected]>
@bors bors bot closed this as completed in e8368a0 Oct 24, 2022
james7132 pushed a commit to james7132/bevy that referenced this issue Oct 28, 2022
@dataphract @james7132
doc: document PerspectiveProjection (bevyengine#6310)
57da561 
# Objective

Fixes bevyengine#6279.

## Solution

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


Co-authored-by: dataphract <[email protected]>
Pietrek14 pushed a commit to Pietrek14/bevy that referenced this issue Dec 17, 2022
@dataphract @Pietrek14
doc: document PerspectiveProjection (bevyengine#6310)
0f2805b 
# Objective

Fixes bevyengine#6279.

## Solution

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


Co-authored-by: dataphract <[email protected]>
ItsDoot pushed a commit to ItsDoot/bevy that referenced this issue Feb 1, 2023
@dataphract @ItsDoot
doc: document PerspectiveProjection (bevyengine#6310)
7a454dd 
# Objective

Fixes bevyengine#6279.

## Solution

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


Co-authored-by: dataphract <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-Rendering Drawing game state to the screen C-Docs An addition or correction to our documentation D-Trivial Nice and easy! A great choice to get started with Bevy
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[Merged by Bors] - doc: document PerspectiveProjection dataphract/bevy
2 participants
@rparrett @Feilkin