vtkm::exec::arg::InputIndex Struct Reference

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

#include <InputIndex.h>

Inheritance diagram for vtkm::exec::arg::InputIndex:

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

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

Detailed Description

The ExecutionSignature tag to use to get the input index.

This tag produces a vtkm::Id that identifies the index of the input element, which can differ from the WorkIndex in a worklet with a scatter.

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

Member Typedef Documentation

AspectTag

using vtkm::exec::arg::InputIndex::AspectTag = vtkm::exec::arg::AspectTagInputIndex

Member Data Documentation

INDEX

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

staticconstexpr

---

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

• InputIndex.h