VTK-m  2.1
Public Attributes | List of all members
vtkm::cont::InitializeResult Struct Reference

#include <Initialize.h>

Public Attributes

DeviceAdapterId Device = DeviceAdapterTagUndefined{}
 The device passed into --vtkm-device argument. More...
 
std::string Usage
 A usage statement for arguments parsed by VTK-m. More...
 

Member Data Documentation

◆ Device

DeviceAdapterId vtkm::cont::InitializeResult::Device = DeviceAdapterTagUndefined{}

The device passed into --vtkm-device argument.

If no device was specified, then this value is set to DeviceAdapterTagUndefined. Note that if the user specifies "any" device, then this value can be set to DeviceAdapterTagAny, which is a pseudo-tag that allows any supported device.

◆ Usage

std::string vtkm::cont::InitializeResult::Usage

A usage statement for arguments parsed by VTK-m.

If the calling code wants to print a usage statement documenting the options that can be provided on the command line, then this string can be added to document the options supported by VTK-m.


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