vtk-m/vtkm/cont/RuntimeDeviceInformation.h
2019-04-17 10:57:13 -06:00

51 lines
1.7 KiB
C++

//============================================================================
// Copyright (c) Kitware, Inc.
// All rights reserved.
// See LICENSE.txt for details.
//
// This software is distributed WITHOUT ANY WARRANTY; without even
// the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
// PURPOSE. See the above copyright notice for more information.
//============================================================================
#ifndef vtk_m_cont_RuntimeDeviceInformation_h
#define vtk_m_cont_RuntimeDeviceInformation_h
#include <vtkm/cont/DeviceAdapterTag.h>
#include <vtkm/internal/ExportMacros.h>
namespace vtkm
{
namespace cont
{
/// A class that can be used to determine if a given device adapter
/// is supported on the current machine at runtime. This is very important
/// for device adapters where a physical hardware requirements such as a GPU
/// or a Accelerator Card is needed for support to exist.
///
///
class VTKM_CONT_EXPORT RuntimeDeviceInformation
{
public:
/// Returns the name corresponding to the device adapter id. If @a id is
/// not recognized, `InvalidDeviceId` is returned. Queries for a
/// name are all case-insensitive.
VTKM_CONT
DeviceAdapterNameType GetName(DeviceAdapterId id) const;
/// Returns the id corresponding to the device adapter name. If @a name is
/// not recognized, DeviceAdapterTagUndefined is returned.
VTKM_CONT
DeviceAdapterId GetId(DeviceAdapterNameType name) const;
/// Returns true if the given device adapter is supported on the current
/// machine.
///
VTKM_CONT
bool Exists(DeviceAdapterId id) const;
};
}
} // namespace vtkm::cont
#endif //vtk_m_cont_RuntimeDeviceInformation_h