Struct WorkgroupSize 

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

Workgroup size in 3 dimensions.

Fields

x: u32

Size in X dimension.

y: u32

Size in Y dimension.

z: u32

Size in Z dimension.

Implementations

impl WorkgroupSize

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

Create a new workgroup size.

pub fn linear(size: u32) -> Self

Create a 1D workgroup size.

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

Create a 2D workgroup size.

pub fn total(&self) -> u32

Total number of invocations in this workgroup.

pub fn is_valid(&self) -> bool

Check if the workgroup size is valid (within typical limits).

pub fn is_warp_aligned(&self) -> bool

Check if the total size is a multiple of the warp size.

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 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 Hash for WorkgroupSize

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 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 Copy for WorkgroupSize

impl Eq for WorkgroupSize

impl StructuralPartialEq for WorkgroupSize