leyoda/softbuffer
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #5 from kpreid/mut

Browse source 
Make `GraphicsContext::window_mut()` an `unsafe fn`.
This commit is contained in:
David Johnson 2022-08-23 20:35:53 -05:00 • committed by GitHub
commit e217b5c7c5
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

19
src/lib.rs
View file

@ -62,15 +62,28 @@ impl<W: HasRawWindowHandle> GraphicsContext<W> {
})
}
/// Gets shared access to the underlying window
/// Gets shared access to the underlying window.
#[inline]
pub fn window(&self) -> &W {
&self.window
}
/// Gets mut/exclusive access to the underlying window
/// Gets mut/exclusive access to the underlying window.
///
/// This method is `unsafe` because it could be used to replace the window with another one,
/// thus dropping the original window and violating the property that this [`GraphicsContext`]
/// will always be destroyed before the window it writes into. This method should only be used
/// when the window type in use requires mutable access to perform some action on an existing
/// window.
///
/// # Safety
///
/// - After the returned mutable reference is dropped, the window must still be the same window
/// which this [`GraphicsContext`] was created for; and within that window, the
/// platform-specific configuration for 2D drawing must not have been modified. (For example,
/// on macOS the view hierarchy of the window must not have been modified.)
#[inline]
pub fn window_mut(&mut self) -> &mut W {
pub unsafe fn window_mut(&mut self) -> &mut W {
&mut self.window
}