Skip to content

Commit fcbadc9

Browse files
authored
Link to TextureBlitterBuilder from TextureBlitter::new (#7003)
1 parent 7e4cfb5 commit fcbadc9

File tree

2 files changed

+7
-1
lines changed

2 files changed

+7
-1
lines changed

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ By @brodycj in [#6925](https://github.com/gfx-rs/wgpu/pull/6925).
8686

8787
### Documentation
8888

89-
- Improved documentation around pipeline caches. By @DJMcNab in [#6978](https://github.com/gfx-rs/wgpu/pull/6978).
89+
- Improved documentation around pipeline caches and `TextureBlitter`. By @DJMcNab in [#6978](https://github.com/gfx-rs/wgpu/pull/6978) and [#7003](https://github.com/gfx-rs/wgpu/pull/7003).
9090

9191
- Added a hello window example. By @laycookie in [#6992](https://github.com/gfx-rs/wgpu/pull/6992).
9292

wgpu/src/util/texture_blitter.rs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -156,6 +156,12 @@ pub struct TextureBlitter {
156156

157157
impl TextureBlitter {
158158
/// Returns a [`TextureBlitter`] with default settings.
159+
///
160+
/// # Arguments
161+
/// - `device` - A [`Device`]
162+
/// - `format` - The [`TextureFormat`] of the texture that will be copied to. This has to have the `RENDER_TARGET` usage.
163+
///
164+
/// Properties of the blitting (such as the [`BlendState`]) can be customised by using [`TextureBlitterBuilder`] instead.
159165
pub fn new(device: &Device, format: TextureFormat) -> Self {
160166
TextureBlitterBuilder::new(device, format).build()
161167
}

0 commit comments

Comments
 (0)