Struct LaunchConfig 

#[non_exhaustive]
pub struct LaunchConfig {
    pub workgroups: Option<[u32; 3]>,
    pub threads_per_workgroup: Option<[u32; 3]>,
}

A GPU kernel never comes alone, it is always groups of them that are launched together.

A number of launched threads together are called a workgroup. And a number of workgroups are launched together. This struct specifies how many workgroups are launched and how many threads are contained in each of them.

The total number of threads launched is number of workgroups times threads per workgroup.

Example

let launch_config = LaunchConfig::new()
    .workgroups([1, 0, 0])
    .threads_per_workgroup([1, 0, 0]);

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

workgroups: Option<[u32; 3]>

The number of workgroups launched on the GPU.

A three-dimensional size for x, y, z dimensions. For a simple list of threads, this can be [n, 1, 1].

threads_per_workgroup: Option<[u32; 3]>

The number of threads in each workgroup.

A three-dimensional size for x, y, z dimensions. For a simple list of threads, this can be [n, 1, 1].

Implementations

impl LaunchConfig

pub fn new() -> Self

Create an empty LaunchConfig.

At least Self::workgroups and Self::threads_per_workgroup need to be filled out, otherwise launching panics.

pub fn workgroups(&mut self, workgroups: [u32; 3]) -> &mut Self

The number of workgroups launched on the GPU.

A three-dimensional size for x, y, z dimensions. For a simple list of threads, this can be [n, 1, 1].

pub fn threads_per_workgroup( &mut self, threads_per_workgroup: [u32; 3], ) -> &mut Self

The number of threads in each workgroup.

A three-dimensional size for x, y, z dimensions. For a simple list of threads, this can be [n, 1, 1].

Trait Implementations

impl Clone for LaunchConfig

fn clone(&self) -> LaunchConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for LaunchConfig

fn default() -> LaunchConfig

Returns the “default value” for a type.

impl Eq for LaunchConfig

impl Hash for LaunchConfig

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 LaunchConfig

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for LaunchConfig