vtkDeviceMemory.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
 
#ifndef vtkDeviceMemory_h
#define vtkDeviceMemory_h
 
#include "vtkCommonCoreModule.h" // For export macro
#include "vtkDataArray.h"        // For vtkDataArray::MemorySpace
 
#include <cstddef>
#include <string>
 
VTK_ABI_NAMESPACE_BEGIN
class VTKCOMMONCORE_EXPORT vtkDeviceMemory
{
public:
  static bool SpaceFromName(const char* name, vtkDataArray::MemorySpace& space);

  static const char* NameOf(vtkDataArray::MemorySpace space);

  static bool IsAvailable(vtkDataArray::MemorySpace space, std::string* why = nullptr);

  static bool IsDevicePointer(
    vtkDataArray::MemorySpace space, const void* pointer, std::string* why = nullptr);

  static bool CopyToHost(vtkDataArray::MemorySpace space, void* destination, const void* source,
    std::size_t bytes, std::string* why = nullptr);

  static int DeviceOrdinal(
    vtkDataArray::MemorySpace space, const void* pointer, std::string* why = nullptr);


  static void SetLevelZeroContext(void* driver, void* device, void* context);
  static bool HasLevelZeroContext();
  static bool GetLevelZeroContext(
    void*& driver, void*& device, void*& context, std::string* why = nullptr);
};
 
VTK_ABI_NAMESPACE_END
#endif
// VTK-HeaderTest-Exclude: vtkDeviceMemory.h