Document additional safety requirements of Instance::create_surface
#1792
+2
−1
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This clarifies that the window that a surface is created on must be kept alive for the lifetime of the surface. This requirement and a proposal to change it are described in gfx-rs#1463
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Connections
Description
This updates the documentation for
Instance::create_surfaceto include the safety requirement that the underlying window must remain valid for the lifetime of the surface.Testing
I ran
cargo docand I re-read the sentence a few times :)In all seriousness, I spent way too much time trying to phrase this change. If anyone has a suggestion for better wording, I'm more than happy to update.