vtkm::exec::arg::VisitIndex Struct Reference

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

#include <VisitIndex.h>

Inheritance diagram for vtkm::exec::arg::VisitIndex:

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

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

Detailed Description

The ExecutionSignature tag to use to get the visit index.

This tag produces a vtkm::IdComponent that uniquely identifies when multiple worklet invocations operate on the same input item, which can happen when defining a worklet with scatter.

When a worklet is dispatched, there is a scatter operation defined that optionally allows each input to go to multiple output entries. When one input is assigned to multiple outputs, there needs to be a mechanism to uniquely identify which output is which. The visit index is a value between 0 and the number of outputs a particular input goes to. This tag in the ExecutionSignature passes the visit index for this work.

Member Typedef Documentation

AspectTag

using vtkm::exec::arg::VisitIndex::AspectTag = vtkm::exec::arg::AspectTagVisitIndex

Member Data Documentation

INDEX

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

staticconstexpr

---

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

• VisitIndex.h