Struct WorkgroupSize 

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

A 3-D workgroup size.

Fields

x: u32

y: u32

z: u32

Implementations

impl WorkgroupSize

pub const fn linear(x: u32) -> Self

Create a 1-D workgroup (y=1, z=1).

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

Create a 2-D workgroup (z=1).

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

Create a full 3-D workgroup.

pub const fn thread_count(self) -> u32

Total number of threads per workgroup.

pub fn is_valid(self, max_threads: u32) -> bool

Returns true if the workgroup size is valid (all dims ≥ 1 and total threads ≤ max_threads).

Trait Implementations

impl Clone for WorkgroupSize

fn clone(&self) -> WorkgroupSize

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for WorkgroupSize

impl Debug for WorkgroupSize

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

Formats the value using the given formatter.

impl Default for WorkgroupSize

fn default() -> Self

Returns the “default value” for a type.

impl Eq for WorkgroupSize

impl PartialEq for WorkgroupSize

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for WorkgroupSize