vtkDeviceArrayFactory.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 vtkDeviceArrayFactory_h
#define vtkDeviceArrayFactory_h
 
#include "vtkCommonCoreModule.h" // For export macro
#include "vtkObject.h"
#include "vtkSmartPointer.h" // For the descriptor
 
VTK_ABI_NAMESPACE_BEGIN
class vtkDataArray;
class vtkMemoryDescriptor;
 
class VTKCOMMONCORE_EXPORT vtkDeviceArrayFactory : public vtkObject
{
public:
  static vtkDeviceArrayFactory* New();
  vtkTypeMacro(vtkDeviceArrayFactory, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  vtkSetMacro(NumberOfTuples, vtkIdType);
  vtkGetMacro(NumberOfTuples, vtkIdType);
  vtkSetMacro(NumberOfComponents, int);
  vtkGetMacro(NumberOfComponents, int);
  vtkSetMacro(DataType, int);
  vtkGetMacro(DataType, int);


  void AddBuffer(vtkMemoryDescriptor* descriptor);
  void ClearBuffers();
  int GetNumberOfBuffers() const;

  VTK_NEWINSTANCE
  vtkDataArray* CreateArray();

  static bool IsMemorySpaceAvailable(const char* space);

  static int GetDeviceOrdinal(vtkMemoryDescriptor* descriptor);


  static void SetLevelZeroContext(
    vtkTypeUInt64 driver, vtkTypeUInt64 device, vtkTypeUInt64 context);
  static bool HasLevelZeroContext();
  static vtkTypeUInt64 GetLevelZeroDriverHandle();
  static vtkTypeUInt64 GetLevelZeroDeviceHandle();
  static vtkTypeUInt64 GetLevelZeroContextHandle();
 
protected:
  vtkDeviceArrayFactory();
  ~vtkDeviceArrayFactory() override;
 
private:
  vtkIdType NumberOfTuples = 0;
  int NumberOfComponents = 1;
  int DataType = 0;
  vtkSmartPointer<vtkMemoryDescriptor> Buffer;
 
  vtkDeviceArrayFactory(const vtkDeviceArrayFactory&) = delete;
  void operator=(const vtkDeviceArrayFactory&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif