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.

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

Add documentation for bevy_window::window::WindowMode::Fullscreen #3136

Closed
alterae opened this issue Nov 15, 2021 · 3 comments
Closed

Add documentation for bevy_window::window::WindowMode::Fullscreen #3136

alterae opened this issue Nov 15, 2021 · 3 comments
Labels
A-Windowing Platform-agnostic interface layer to run your app in C-Docs An addition or correction to our documentation D-Trivial Nice and easy! A great choice to get started with Bevy

Comments

@alterae
Copy link

alterae commented Nov 15, 2021

How can Bevy's documentation be improved?

In the Fullscreen variant of the WindowMode enum, the use_size field is undocumented, and it is not clear what it does

@alterae alterae added C-Docs An addition or correction to our documentation S-Needs-Triage This issue needs to be labelled labels Nov 15, 2021
@alice-i-cecile alice-i-cecile added A-Windowing Platform-agnostic interface layer to run your app in D-Trivial Nice and easy! A great choice to get started with Bevy and removed S-Needs-Triage This issue needs to be labelled labels Nov 15, 2021
@DJMcNab
Copy link
Member

DJMcNab commented Nov 15, 2021

The full_size field appears to be described on the very page you have linked.

It's to do with whether the full screen window should be created at the given size (e.g. automatically stretched out by the display to make the aspect ratio outputted by the OS fit - depends on how clever your monitor/OS combination wants to be) or created at whatever the screen resolution is.

@alterae
Copy link
Author

alterae commented Nov 15, 2021

The full_size field appears to be described on the very page you have linked.

It's to do with whether the full screen window should be created at the given size (e.g. automatically stretched out by the display to make the aspect ratio outputted by the OS fit - depends on how clever your monitor/OS combination wants to be) or created at whatever the screen resolution is.

Ah, I see. Thank you for pointing that out, I missed it.

I feel it would be useful for that to be documented directly on the field itself.

@DJMcNab
Copy link
Member

DJMcNab commented Nov 15, 2021

Certainly, adding some documentation for that would be welcome.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Windowing Platform-agnostic interface layer to run your app in 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
3 participants