[Merged by Bors] - Add some docs about lowspec rendering by inact1v1ty · Pull Request #5091 · bevyengine/bevy

inact1v1ty · 2022-06-24T14:27:55Z

Objective

When experimenting with rendering on lowspec machines I've run into some non-obvious things (huge thanks superdump, alice-i-cecile, 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.

inact1v1ty · 2022-06-24T14:29:16Z

I think this needs review of @alice-i-cecile and maybe @superdump. Thanks!

UPD: couple of oopsies, will fix now

alice-i-cecile · 2022-06-24T21:01:08Z

crates/bevy_render/src/settings.rs

 /// [`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).


Suggested change

/// 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).

I committed this suggestion too, but now I think that it can be misunderstood as if all WgpuSettings require ANGLE on Windows 🤔

Maybe it should be something like "GL is disabled by default and requires ANGL on Windows"?

I think if we add a line break above the NOTE this will be clear by grouping.

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.

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.

I'm happy with your suggestion :)

crates/bevy_render/src/view/window.rs

alice-i-cecile

Some wording feedback, but I'm happy with this :)

Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>

crates/bevy_render/src/settings.rs

crates/bevy_render/src/view/window.rs

Co-authored-by: Robert Swain <robert.swain@gmail.com>

inact1v1ty · 2022-06-25T14:26:09Z

Github making possible to comment before Ctrl-R and seeing new comments makes me sad :(
I committed @superdump variant as it better describes not only quirks we've found but the state of things in general

inact1v1ty · 2022-06-25T14:31:49Z

@alice-i-cecile CI is not happy with Direct X and OpenGL not being backticked. Should I backtick them or somehow silence the warning?

alice-i-cecile · 2022-06-25T14:48:10Z

Backtick them please :)

superdump

bors r+

# 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 · 2022-06-25T16:36:34Z

Pull request successfully merged into main.

Build succeeded:

# 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.

Add some docs about lowspec rendering

734c134

inact1v1ty force-pushed the lowspec-rendering-additional-comments branch from 2578e12 to 734c134 Compare June 24, 2022 15:39

alice-i-cecile requested review from alice-i-cecile and superdump June 24, 2022 21:00

alice-i-cecile reviewed Jun 24, 2022

View reviewed changes

crates/bevy_render/src/view/window.rs Outdated Show resolved Hide resolved

alice-i-cecile reviewed Jun 24, 2022

View reviewed changes

crates/bevy_render/src/view/window.rs Outdated Show resolved Hide resolved

alice-i-cecile requested changes Jun 24, 2022

View reviewed changes

Apply suggestions from code review

fd37ed0

Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>

inact1v1ty requested a review from alice-i-cecile June 24, 2022 22:56

alice-i-cecile approved these changes Jun 24, 2022

View reviewed changes

alice-i-cecile added C-Docs An addition or correction to our documentation A-Rendering Drawing game state to the screen labels Jun 25, 2022

superdump requested changes Jun 25, 2022

View reviewed changes

crates/bevy_render/src/settings.rs Outdated Show resolved Hide resolved

crates/bevy_render/src/view/window.rs Outdated Show resolved Hide resolved

crates/bevy_render/src/view/window.rs Outdated Show resolved Hide resolved

Apply suggestions from code review

79ed137

Co-authored-by: Robert Swain <robert.swain@gmail.com>

Backtick rendering API names and fix link

def85aa

inact1v1ty force-pushed the lowspec-rendering-additional-comments branch from 3cf105d to def85aa Compare June 25, 2022 15:05

alice-i-cecile approved these changes Jun 25, 2022

View reviewed changes

inact1v1ty requested a review from superdump June 25, 2022 15:23

superdump approved these changes Jun 25, 2022

View reviewed changes

bors bot changed the title ~~Add some docs about lowspec rendering~~ [Merged by Bors] - Add some docs about lowspec rendering Jun 25, 2022

bors bot closed this Jun 25, 2022

	/// 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).

Uh oh!

Conversation

inact1v1ty commented Jun 24, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Objective

Solution

Uh oh!

inact1v1ty commented Jun 24, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

alice-i-cecile Jun 24, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

inact1v1ty Jun 24, 2022

Choose a reason for hiding this comment

Uh oh!

inact1v1ty Jun 24, 2022

Choose a reason for hiding this comment

Uh oh!

alice-i-cecile Jun 24, 2022

Choose a reason for hiding this comment

Uh oh!

inact1v1ty Jun 25, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

superdump Jun 25, 2022

Choose a reason for hiding this comment

Uh oh!

alice-i-cecile Jun 25, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

alice-i-cecile left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

inact1v1ty commented Jun 25, 2022

Uh oh!

inact1v1ty commented Jun 25, 2022

Uh oh!

alice-i-cecile commented Jun 25, 2022

Uh oh!

superdump left a comment

Choose a reason for hiding this comment

Uh oh!

bors bot commented Jun 25, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

inact1v1ty commented Jun 24, 2022 •

edited

Loading

inact1v1ty commented Jun 24, 2022 •

edited

Loading

alice-i-cecile Jun 24, 2022 •

edited

Loading

inact1v1ty Jun 25, 2022 •

edited

Loading