Struct opencl_core::Work

pub struct Work {
    pub global_size: Dims,
    pub global_offset: Option<Dims>,
    pub local_size: Option<Dims>,
}

Work is a representation of 1, 2, or 3 dimensions.

For global_size none of the specified dimensions can be 0.

For global_offset any specficied dimension can be any usize.

For local_size none of the specified dimensions can be 0.

Fields

global_size: Dims

global_offset: Option<Dims>

local_size: Option<Dims>

Methods

impl Work

pub fn new<D>(global_size: D) -> Work where
    D: Into<Dims>, 

pub fn with_global_offset<D>(self, offset: D) -> Work where
    D: Into<Dims>, 

pub fn with_local_size<D>(self, local_size: D) -> Work where
    D: Into<Dims>, 

pub fn work_dims(&self) -> u32

pub fn global_work_size(&self) -> Result<GlobalWorkSize, Error>

A 3D array that describes the Volume of the Work. A Work's global_work_size must describe a non-zero Volume. For example, [4, 3, 2] is a 4 by 3 by 2 Volume that does not result in an empty volume (4 * 3 * 2 != 0); to drive this point home the Volume [3, 3, 0] is not a valid global_work_size because the product of its elements equal 0.

pub fn global_work_offset(&self) -> GlobalWorkOffset

A 3D array that describes the 3 dimensional offset of the Work. The global_work_size can be None or can be specified as a Dims. Because the global_work_offset describes an of a 3 dimensional collection/buffer the dimensionality of the data can be zero. Some([0, 0, 0]) is a valid global_work_offset.

pub fn local_work_size(&self) -> Result<LocalWorkSize, Error>

pub fn n_items(&self) -> usize

Trait Implementations

impl Clone for Work

fn clone(&self) -> Work

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Work

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

Formats the value using the given formatter.

impl Eq for Work

impl PartialEq<Work> for Work

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralEq for Work

impl StructuralPartialEq for Work