mirror of
https://github.com/gfx-rs/wgpu.git
synced 2026-04-22 03:02:01 -04:00
Merge #1279
1279: Fix some typos r=kvark a=grovesNL **Description** Fix a few small typos in doc comments **Testing** None Co-authored-by: Joshua Groves <josh@joshgroves.com>
This commit is contained in:
@@ -1311,7 +1311,7 @@ pub mod bundle_ffi {
|
||||
/// # Safety
|
||||
///
|
||||
/// This function is unsafe as there is no guarantee that the given `label`
|
||||
/// is a valid null-terminated stricng.
|
||||
/// is a valid null-terminated string.
|
||||
#[no_mangle]
|
||||
pub unsafe extern "C" fn wgpu_render_bundle_push_debug_group(
|
||||
_bundle: &mut RenderBundleEncoder,
|
||||
@@ -1328,7 +1328,7 @@ pub mod bundle_ffi {
|
||||
/// # Safety
|
||||
///
|
||||
/// This function is unsafe as there is no guarantee that the given `label`
|
||||
/// is a valid null-terminated stricng.
|
||||
/// is a valid null-terminated string.
|
||||
#[no_mangle]
|
||||
pub unsafe extern "C" fn wgpu_render_bundle_insert_debug_marker(
|
||||
_bundle: &mut RenderBundleEncoder,
|
||||
|
||||
@@ -751,7 +751,7 @@ pub mod compute_ffi {
|
||||
/// # Safety
|
||||
///
|
||||
/// This function is unsafe as there is no guarantee that the given `label`
|
||||
/// is a valid null-terminated stricng.
|
||||
/// is a valid null-terminated string.
|
||||
#[no_mangle]
|
||||
pub unsafe extern "C" fn wgpu_compute_pass_push_debug_group(
|
||||
pass: &mut ComputePass,
|
||||
@@ -775,7 +775,7 @@ pub mod compute_ffi {
|
||||
/// # Safety
|
||||
///
|
||||
/// This function is unsafe as there is no guarantee that the given `label`
|
||||
/// is a valid null-terminated stricng.
|
||||
/// is a valid null-terminated string.
|
||||
#[no_mangle]
|
||||
pub unsafe extern "C" fn wgpu_compute_pass_insert_debug_marker(
|
||||
pass: &mut ComputePass,
|
||||
|
||||
@@ -150,7 +150,7 @@ pub enum ResolveError {
|
||||
end_query: u32,
|
||||
query_set_size: u32,
|
||||
},
|
||||
#[error("Resolving queries {start_query}..{end_query} ({stride} byte queries) will end up overruning the bounds of the destination buffer of size {buffer_size} using offsets {buffer_start_offset}..{buffer_end_offset}")]
|
||||
#[error("Resolving queries {start_query}..{end_query} ({stride} byte queries) will end up overrunning the bounds of the destination buffer of size {buffer_size} using offsets {buffer_start_offset}..{buffer_end_offset}")]
|
||||
BufferOverrun {
|
||||
start_query: u32,
|
||||
end_query: u32,
|
||||
|
||||
@@ -2258,7 +2258,7 @@ pub mod render_ffi {
|
||||
/// # Safety
|
||||
///
|
||||
/// This function is unsafe as there is no guarantee that the given `label`
|
||||
/// is a valid null-terminated stricng.
|
||||
/// is a valid null-terminated string.
|
||||
#[no_mangle]
|
||||
pub unsafe extern "C" fn wgpu_render_pass_push_debug_group(
|
||||
pass: &mut RenderPass,
|
||||
@@ -2282,7 +2282,7 @@ pub mod render_ffi {
|
||||
/// # Safety
|
||||
///
|
||||
/// This function is unsafe as there is no guarantee that the given `label`
|
||||
/// is a valid null-terminated stricng.
|
||||
/// is a valid null-terminated string.
|
||||
#[no_mangle]
|
||||
pub unsafe extern "C" fn wgpu_render_pass_insert_debug_marker(
|
||||
pass: &mut RenderPass,
|
||||
|
||||
@@ -45,14 +45,14 @@ pub enum TransferError {
|
||||
MissingCopySrcUsageFlag,
|
||||
#[error("destination buffer/texture is missing the `COPY_DST` usage flag")]
|
||||
MissingCopyDstUsageFlag(Option<BufferId>, Option<TextureId>),
|
||||
#[error("copy of {start_offset}..{end_offset} would end up overruning the bounds of the {side:?} buffer of size {buffer_size}")]
|
||||
#[error("copy of {start_offset}..{end_offset} would end up overrunning the bounds of the {side:?} buffer of size {buffer_size}")]
|
||||
BufferOverrun {
|
||||
start_offset: BufferAddress,
|
||||
end_offset: BufferAddress,
|
||||
buffer_size: BufferAddress,
|
||||
side: CopySide,
|
||||
},
|
||||
#[error("copy of {dimension:?} {start_offset}..{end_offset} would end up overruning the bounds of the {side:?} texture of {dimension:?} size {texture_size}")]
|
||||
#[error("copy of {dimension:?} {start_offset}..{end_offset} would end up overrunning the bounds of the {side:?} texture of {dimension:?} size {texture_size}")]
|
||||
TextureOverrun {
|
||||
start_offset: u32,
|
||||
end_offset: u32,
|
||||
|
||||
@@ -148,7 +148,7 @@ pub enum BufferAccessError {
|
||||
UnalignedOffset { offset: wgt::BufferAddress },
|
||||
#[error("buffer range size invalid: range_size {range_size} must be multiple of 4")]
|
||||
UnalignedRangeSize { range_size: wgt::BufferAddress },
|
||||
#[error("buffer access out of bounds: index {index} would underun the buffer (limit: {min})")]
|
||||
#[error("buffer access out of bounds: index {index} would underrun the buffer (limit: {min})")]
|
||||
OutOfBoundsUnderrun {
|
||||
index: wgt::BufferAddress,
|
||||
min: wgt::BufferAddress,
|
||||
|
||||
@@ -407,7 +407,7 @@ bitflags::bitflags! {
|
||||
/// Enables 64-bit floating point types in SPIR-V shaders.
|
||||
///
|
||||
/// Note: even when supported by GPU hardware, 64-bit floating point operations are
|
||||
/// frequently between 16 and 64 _times_ slower than equivelent operations on 32-bit floats.
|
||||
/// frequently between 16 and 64 _times_ slower than equivalent operations on 32-bit floats.
|
||||
///
|
||||
/// Supported Platforms:
|
||||
/// - Vulkan
|
||||
@@ -2842,12 +2842,12 @@ bitflags::bitflags! {
|
||||
///
|
||||
/// The amount of values written when resolved depends
|
||||
/// on the amount of flags. If 3 flags are enabled, 3
|
||||
/// 64-bit values will be writen per-query.
|
||||
/// 64-bit values will be written per-query.
|
||||
///
|
||||
/// The order they are written is the order they are declared
|
||||
/// in this bitflags. If you enabled `CLIPPER_PRIMITIVES_OUT`
|
||||
/// and `COMPUTE_SHADER_INVOCATIONS`, it would write 16 bytes,
|
||||
/// the first 8 bytes being the primative out value, the last 8
|
||||
/// the first 8 bytes being the primitive out value, the last 8
|
||||
/// bytes being the compute shader invocation count.
|
||||
#[repr(transparent)]
|
||||
#[cfg_attr(feature = "trace", derive(Serialize))]
|
||||
@@ -2868,7 +2868,7 @@ bitflags::bitflags! {
|
||||
/// derivatives.
|
||||
const FRAGMENT_SHADER_INVOCATIONS = 0x08;
|
||||
/// Amount of times a compute shader is invoked. This will
|
||||
/// be equivilent to the dispatch count times the workgroup size.
|
||||
/// be equivalent to the dispatch count times the workgroup size.
|
||||
const COMPUTE_SHADER_INVOCATIONS = 0x10;
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user