vtkm::exec::arg::OutputIndex Struct Reference

The ExecutionSignature tag to use to get the output index. More...

#include <OutputIndex.h>

Inheritance diagram for vtkm::exec::arg::OutputIndex:

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

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

Detailed Description

The ExecutionSignature tag to use to get the output index.

This tag produces a vtkm::Id that identifies the index of the output element. (This is generally the same as WorkIndex.)

When a worklet is dispatched, it broken into pieces defined by the output domain and scheduled on independent threads. This tag in the ExecutionSignature passes the index of the output element that the work thread is currently working on. When a worklet has a scatter associated with it, the output and output indices can be different.

Member Typedef Documentation

AspectTag

using vtkm::exec::arg::OutputIndex::AspectTag = vtkm::exec::arg::AspectTagOutputIndex

Member Data Documentation

INDEX

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

staticconstexpr

---

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

• OutputIndex.h