bevy_window::PresentMode: The documentation for the AutoVsync and AutoNoVsync variants causes confusion.
#9151
Labels
A-Windowing
Platform-agnostic interface layer to run your app in
C-Docs
An addition or correction to our documentation
Milestone
Comments
LikeLakers2
added
C-Docs
Selene-Amanita
added
A-Windowing
|
|
|
How about just adding the |
That would work for one of my issues. However, it doesn't fix the other issue - the confusing "(on web)" descriptor on the Would that be something I report to |
|
I also found "on web" confusing in https://wgpu.rs/doc/wgpu/enum.PresentMode.html#variant.AutoNoVsync. I think it's great to report this to wgpu and improve the documentation there, then bevy updates the doc back. |
github-merge-queue bot
pushed a commit
that referenced
this issue
Jul 21, 2023
# Objective - Update `bevy_window::PresentMode` to mirror `wgpu::PresentMode`, Fixes #9151. ## Solution Add `bevy_window::PresentMode::FifoRelaxed` to `bevy_window::PresentMode`, add documents. --- ## Changelog ### Added - Add `bevy_window::PresentMode::FifoRelaxed` to `bevy_window::PresentMode`. ## Migration Guide - Handle `bevy_window::PresentMode::FifoRelaxed` when tweaking window present mode manually.
cart
pushed a commit
that referenced
this issue
Aug 10, 2023
# Objective - Update `bevy_window::PresentMode` to mirror `wgpu::PresentMode`, Fixes #9151. ## Solution Add `bevy_window::PresentMode::FifoRelaxed` to `bevy_window::PresentMode`, add documents. --- ## Changelog ### Added - Add `bevy_window::PresentMode::FifoRelaxed` to `bevy_window::PresentMode`. ## Migration Guide - Handle `bevy_window::PresentMode::FifoRelaxed` when tweaking window present mode manually.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Hi again! I was browsing the documentation, and noticed that two of the variants of
bevy_window::PresentModehave slightly confusing documentation.First off, the
AutoVsyncvariant onbevy_window::PresentModementions something aboutFifoRelaxed. My intuition says that this is meant to referenceMailbox, but without testing I would not know either way.And second off, in the
AutoNoVsyncvariant, says "Chooses Immediate -> Mailbox -> Fifo (on web)". The "(on web)" causes some level of confusion, as I'm unsure what it's meant to mean. Does that mean that Fifo is only considered when on the web? Or does it mean something else? In any case, separating the "(on web)" part out into its own sentence (i.e. "Fifo is only considered when running on the web.") may be a good idea.Thanks for your hard work, whoever responds to this!
The text was updated successfully, but these errors were encountered: