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

Explain SurfaceError better #5736

Open
kpreid opened this issue May 24, 2024 · 0 comments
Open

Explain SurfaceError better #5736

kpreid opened this issue May 24, 2024 · 0 comments
Labels
area: documentation Documentation for crate items, public or private help required We need community help to make this happen. type: bug Something isn't working

Comments

@kpreid
Copy link
Contributor

kpreid commented May 24, 2024

The documentation of SurfaceError currently includes:

Outdated
The underlying surface has changed, and therefore the swap chain must be updated.

Lost
The swap chain has been lost and needs to be recreated.

These are unactionable, because “the swap chain” is not an entity in the wgpu API and “update” is vague. They should refer to exact wgpu types and functions instead — for example, Surface::configure() for Outdated (if I understand correctly).
@Wumpf Wumpf added type: bug Something isn't working help required We need community help to make this happen. area: documentation Documentation for crate items, public or private labels May 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area: documentation Documentation for crate items, public or private help required We need community help to make this happen. type: bug Something isn't working
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@kpreid @Wumpf