vtkm::exec::arg::ThreadIndices Struct Reference

The ExecutionSignature tag to use to get the thread indices. More...

#include <ThreadIndices.h>

Inheritance diagram for vtkm::exec::arg::ThreadIndices:

Public Types
using	AspectTag = vtkm::exec::arg::AspectTagThreadIndices

Static Public Attributes
static constexpr vtkm::IdComponent	INDEX = 1

Detailed Description

The ExecutionSignature tag to use to get the thread indices.

This tag produces an internal object that manages indices and other metadata of the current thread. Thread indices objects vary by worklet type, but most users can get the information they need through other signature tags.

When a worklet is dispatched, it broken into pieces defined by the input domain and scheduled on independent threads. During this process multiple indices associated with the input and output can be generated. This tag in the ExecutionSignature passes the index for this work.

Member Typedef Documentation

AspectTag

using vtkm::exec::arg::ThreadIndices::AspectTag = vtkm::exec::arg::AspectTagThreadIndices

Member Data Documentation

INDEX

constexpr vtkm::IdComponent vtkm::exec::arg::ThreadIndices::INDEX = 1

staticconstexpr

---

The documentation for this struct was generated from the following file:

• ThreadIndices.h