Skip to main content

class nd_item

Declaration

template <int Dims = 1>
class nd_item { /* full declaration omitted */ };

Template Parameters

int Dims = 1

Member Variables

sycl::nd_item<sycl_dims> m_sycl_item
id<Dims> m_global_id
id<Dims> m_global_offset
range<Dims> m_global_range
id<Dims> m_group_id
range<Dims> m_group_range
static const int sycl_dims = std::max(1, Dims)

Member Function Overview

Member Functions

template <typename T>
sycl::device_event async_work_group_copy(
    decorated_global_ptr<T> dest,
    decorated_local_ptr<T> src,
    size_t num_elements) const

Template Parameters

T

Parameters

decorated_global_ptr<T> dest
decorated_local_ptr<T> src
size_t num_elements

template <typename T>
sycl::device_event async_work_group_copy(
    decorated_local_ptr<T> dest,
    decorated_global_ptr<T> src,
    size_t num_elements) const

Template Parameters

T

Parameters

decorated_local_ptr<T> dest
decorated_global_ptr<T> src
size_t num_elements

template <typename T>
sycl::device_event async_work_group_copy(
    decorated_local_ptr<T> dest,
    decorated_global_ptr<T> src,
    size_t num_elements,
    size_t src_stride) const

Template Parameters

T

Parameters

decorated_local_ptr<T> dest
decorated_global_ptr<T> src
size_t num_elements
size_t src_stride

template <typename T>
sycl::device_event async_work_group_copy(
    decorated_global_ptr<T> dest,
    decorated_local_ptr<T> src,
    size_t num_elements,
    size_t dest_stride) const

Template Parameters

T

Parameters

decorated_global_ptr<T> dest
decorated_local_ptr<T> src
size_t num_elements
size_t dest_stride

id<Dims> get_global_id() const

size_t get_global_id(int dimension) const

Parameters

int dimension

size_t get_global_linear_id() const

range<Dims> get_global_range() const

size_t get_global_range(int dimension) const

Parameters

int dimension

group<Dims> get_group() const

size_t get_group(int dimension) const

Parameters

int dimension

size_t get_group_linear_id() const

range<Dims> get_group_range() const

size_t get_group_range(int dimension) const

Parameters

int dimension

size_t get_local_id(int dimension) const

Parameters

int dimension

id<Dims> get_local_id() const

size_t get_local_linear_id() const

size_t get_local_range(int dimension) const

Parameters

int dimension

range<Dims> get_local_range() const

celerity::nd_range<Dims> get_nd_range() const

id<Dims> get_offset() const

sycl::sub_group get_sub_group() const

nd_item()

template <typename... DeviceEvents>
void wait_for(DeviceEvents... events) const

Template Parameters

DeviceEvents

Parameters

DeviceEvents... events

explicit nd_item(
    const sycl::nd_item<std::max(1, Dims)>&
        sycl_item,
    const range<Dims>& global_range,
    const id<Dims>& global_offset,
    const id<Dims>& chunk_offset,
    const range<Dims>& group_range,
    const id<Dims>& group_offset)

Parameters

const sycl::nd_item<std::max(1, Dims)>& sycl_item
const range<Dims>& global_range
const id<Dims>& global_offset
const id<Dims>& chunk_offset
const range<Dims>& group_range
const id<Dims>& group_offset