Struct Dim3 

pub struct Dim3 {
    pub x: u32,
    pub y: u32,
    pub z: u32,
}

3-dimensional size specification for grids and blocks.

Used to specify the number of thread blocks in a grid and the number of threads in a block. Dimensions default to 1 when not explicitly provided.

Examples

use oxicuda_launch::Dim3;

// 1D: 256 threads
let block = Dim3::x(256);
assert_eq!(block.x, 256);
assert_eq!(block.y, 1);
assert_eq!(block.z, 1);

// 2D: 16x16 threads
let block = Dim3::xy(16, 16);
assert_eq!(block.total(), 256);

// 3D
let block = Dim3::new(8, 8, 4);
assert_eq!(block.total(), 256);

// From conversions
let block: Dim3 = 256u32.into();
assert_eq!(block, Dim3::x(256));

let block: Dim3 = (16u32, 16u32).into();
assert_eq!(block, Dim3::xy(16, 16));

let block: Dim3 = (8u32, 8u32, 4u32).into();
assert_eq!(block, Dim3::new(8, 8, 4));

Fields

x: u32

X dimension.

y: u32

Y dimension (default 1).

z: u32

Z dimension (default 1).

Implementations

impl Dim3

pub fn new(x: u32, y: u32, z: u32) -> Self

Creates a new Dim3 with explicit values for all three dimensions.

pub fn x(x: u32) -> Self

Creates a 1-dimensional Dim3 with the given X value.

Y and Z are set to 1.

pub fn xy(x: u32, y: u32) -> Self

Creates a 2-dimensional Dim3 with the given X and Y values.

Z is set to 1.

pub fn total(&self) -> u32

Total number of elements (x * y * z), saturating at u32::MAX rather than panicking (debug builds) or silently wrapping (release builds) when the true product would overflow a u32.

Use total_u64 instead when the exact product matters, e.g. for u64-typed accounting or comparisons.

pub fn total_u64(&self) -> u64

Total number of elements (x * y * z) widened to u64, saturating at u64::MAX on overflow.

Note that the product of three arbitrary u32 values does not always fit in a u64 (e.g. u32::MAX cubed is far larger than u64::MAX), so the multiplication is carried out in u128 — which is always wide enough for three u32 factors — before narrowing back down, exactly mirroring how total narrows this value to u32.

Trait Implementations

impl Clone for Dim3

fn clone(&self) -> Dim3

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for Dim3

impl Debug for Dim3

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for Dim3

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for Dim3

impl From<(u32, u32)> for Dim3

fn from((x, y): (u32, u32)) -> Self

Converts a (u32, u32) tuple into a 2D Dim3.

impl From<(u32, u32, u32)> for Dim3

fn from((x, y, z): (u32, u32, u32)) -> Self

Converts a (u32, u32, u32) tuple into a 3D Dim3.

impl From<u32> for Dim3

fn from(x: u32) -> Self

Converts a single u32 into a 1D Dim3.

impl Hash for Dim3

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Dim3

fn eq(&self, other: &Dim3) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Dim3