[Merged by Bors] - Add some docs about lowspec rendering #5091
Conversation
|
I think this needs review of @alice-i-cecile and maybe @superdump. Thanks! UPD: couple of oopsies, will fix now |
inact1v1ty
force-pushed
the
lowspec-rendering-additional-comments
branch
from
2578e12
to
734c134
Compare
crates/bevy_render/src/settings.rs
Outdated
| @@ -16,6 +16,8 @@ pub enum WgpuSettingsPriority { | |||
| /// Provides configuration for renderer initialization. Use [`RenderDevice::features`](crate::renderer::RenderDevice::features), | |||
| /// [`RenderDevice::limits`](crate::renderer::RenderDevice::limits), and the [`WgpuAdapterInfo`](crate::render_resource::WgpuAdapterInfo) | |||
| /// resource to get runtime information about the actual adapter, backend, features, and limits. | |||
| /// NOTE: [`Backends::GL`](Backends::GL) is disabled by default. | |||
| /// You can use [`Backends::GL`](Backends::GL) on Windows only with the help of [`ANGLE`](https://github.com/gfx-rs/wgpu#angle). | |||
There was a problem hiding this comment.
| /// You can use [`Backends::GL`](Backends::GL) on Windows only with the help of [`ANGLE`](https://github.com/gfx-rs/wgpu#angle). | |
| /// On Windows, this requires [`ANGLE`](https://github.com/gfx-rs/wgpu#angle). |
There was a problem hiding this comment.
I committed this suggestion too, but now I think that it can be misunderstood as if all WgpuSettings require ANGLE on Windows 🤔
There was a problem hiding this comment.
Maybe it should be something like "GL is disabled by default and requires ANGL on Windows"?
There was a problem hiding this comment.
I think if we add a line break above the NOTE this will be clear by grouping.
There was a problem hiding this comment.
I didn't add a line break intentionally cause on docs.rs everything after first empty line is shown only on page of the item itself, not the module containing it, and docs.rs doesn't give any hints whether there are additional docs on an item, so I thought users can miss this rather important stuff. Dk if this is true and maybe I should add a line break anyway, your thoughts @alice-i-cecile? 🤔
Also from a fresh point of view I think that changing "this" to "it" solves ambiguity.
There was a problem hiding this comment.
I didn’t see this discussion and made my own suggestions. Let me know what you both think of them as to clarity / too much information.
There was a problem hiding this comment.
I'm happy with your suggestion :)
Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>
alice-i-cecile
added
C-Docs
Co-authored-by: Robert Swain <robert.swain@gmail.com>
|
Github making possible to comment before Ctrl-R and seeing new comments makes me sad :( |
|
@alice-i-cecile CI is not happy with Direct X and OpenGL not being backticked. Should I backtick them or somehow silence the warning? |
|
Backtick them please :) |
inact1v1ty
force-pushed
the
lowspec-rendering-additional-comments
branch
from
3cf105d
to
def85aa
Compare
# Objective - When experimenting with rendering on lowspec machines I've run into some non-obvious things (huge thanks [superdump](https://github.com/superdump), [alice-i-cecile](https://github.com/alice-i-cecile), [mockersf](https://github.com/mockersf) and others for help) and so volunteered to document them. - Is a follow-up of https://discordapp.com/channels/691052431525675048/989137552919375902 ## Solution - I added docs about necessity of `ANGLE` to use `Backends::GL` on Windows. - Also documented why `prepare_windows` can be long to execute and some causes.
bors
bot
changed the title
# Objective - When experimenting with rendering on lowspec machines I've run into some non-obvious things (huge thanks [superdump](https://github.com/superdump), [alice-i-cecile](https://github.com/alice-i-cecile), [mockersf](https://github.com/mockersf) and others for help) and so volunteered to document them. - Is a follow-up of https://discordapp.com/channels/691052431525675048/989137552919375902 ## Solution - I added docs about necessity of `ANGLE` to use `Backends::GL` on Windows. - Also documented why `prepare_windows` can be long to execute and some causes.
# Objective - When experimenting with rendering on lowspec machines I've run into some non-obvious things (huge thanks [superdump](https://github.com/superdump), [alice-i-cecile](https://github.com/alice-i-cecile), [mockersf](https://github.com/mockersf) and others for help) and so volunteered to document them. - Is a follow-up of https://discordapp.com/channels/691052431525675048/989137552919375902 ## Solution - I added docs about necessity of `ANGLE` to use `Backends::GL` on Windows. - Also documented why `prepare_windows` can be long to execute and some causes.
# Objective - When experimenting with rendering on lowspec machines I've run into some non-obvious things (huge thanks [superdump](https://github.com/superdump), [alice-i-cecile](https://github.com/alice-i-cecile), [mockersf](https://github.com/mockersf) and others for help) and so volunteered to document them. - Is a follow-up of https://discordapp.com/channels/691052431525675048/989137552919375902 ## Solution - I added docs about necessity of `ANGLE` to use `Backends::GL` on Windows. - Also documented why `prepare_windows` can be long to execute and some causes.
Objective
Solution
ANGLEto useBackends::GLon Windows.prepare_windowscan be long to execute and some causes.