Skip to content

Commit

Permalink
Docs surface creation no longer unsafe (gfx-rs#5265)
Browse files Browse the repository at this point in the history
* doc: as of gfx-rs#4597 surface creation is no longer unsafe

* doc: extend documentation of the include_wgsl macro
  • Loading branch information
hackaugusto authored and cwfitzgerald committed Feb 29, 2024
1 parent 502b140 commit 091d786
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 2 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ Bottom level categories:
### Documentation
- Fix link in `wgpu::Instance::create_surface` documentation. By @HexoKnight in [#5280](https://github.com/gfx-rs/wgpu/pull/5280).
- Fix typo in `wgpu::CommandEncoder::clear_buffer` documentation. By @PWhiddy in [#5281](https://github.com/gfx-rs/wgpu/pull/5281).
- `Surface` configuration incorrectly claimed that `wgpu::Instance::create_surface` was unsafe. By @hackaugusto in [#5265](https://github.com/gfx-rs/wgpu/pull/5265).


### Bug Fixes
Expand Down
2 changes: 1 addition & 1 deletion wgpu/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -403,7 +403,7 @@ static_assertions::assert_impl_all!(SurfaceConfiguration: Send, Sync);
/// Handle to a presentable surface.
///
/// A `Surface` represents a platform-specific surface (e.g. a window) onto which rendered images may
/// be presented. A `Surface` may be created with the unsafe function [`Instance::create_surface`].
/// be presented. A `Surface` may be created with the function [`Instance::create_surface`].
///
/// This type is unique to the Rust API of `wgpu`. In the WebGPU specification,
/// [`GPUCanvasContext`](https://gpuweb.github.io/gpuweb/#canvas-context)
Expand Down
11 changes: 10 additions & 1 deletion wgpu/src/macros.rs
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,16 @@ macro_rules! include_spirv_raw {
};
}

/// Macro to load a WGSL module statically.
/// Load WGSL source code from a file at compile time.
///
/// The loaded path is relative to the path of the file containing the macro call, in the same way
/// as [`include_str!`] operates.
///
/// ```ignore
/// fn main() {
/// let module: ShaderModuleDescriptor = include_wgsl!("shader.wgsl");
/// }
/// ```
#[macro_export]
macro_rules! include_wgsl {
($($token:tt)*) => {
Expand Down

0 comments on commit 091d786

Please sign in to comment.