vtkm::worklet::WorkletMapField::FieldOut Struct Reference

A control signature tag for output fields. More...

#include <WorkletMapField.h>

Inheritance diagram for vtkm::worklet::WorkletMapField::FieldOut:

Public Types
using	TypeCheckTag = vtkm::cont::arg::TypeCheckTagArrayOut
using	TransportTag = vtkm::cont::arg::TransportTagArrayOut
using	FetchTag = vtkm::exec::arg::FetchTagArrayDirectOut

Detailed Description

A control signature tag for output fields.

A FieldOut argument expects a vtkm::cont::ArrayHandle in the associated parameter of the invoke. The array is resized before scheduling begins, and each invocation of the worklet sets a single value in the array.

This tag means that the field is write only.

Although uncommon, it is possible to set the worklet's InputDomain to a FieldOut argument. If this is the case, then the vtkm::cont::ArrayHandle passed as the argument must be allocated before being passed to the invoke, and the input domain will be the size of the array.

Member Typedef Documentation

FetchTag

using vtkm::worklet::WorkletMapField::FieldOut::FetchTag = vtkm::exec::arg::FetchTagArrayDirectOut

TransportTag

using vtkm::worklet::WorkletMapField::FieldOut::TransportTag = vtkm::cont::arg::TransportTagArrayOut

TypeCheckTag

using vtkm::worklet::WorkletMapField::FieldOut::TypeCheckTag = vtkm::cont::arg::TypeCheckTagArrayOut

---

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

• WorkletMapField.h