vtkOpenGLArrayTextureBufferAdapter.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 vtkOpenGLArrayTextureBufferAdapter_h
#define vtkOpenGLArrayTextureBufferAdapter_h

#include "vtkDataArray.h"
#include "vtkOpenGLBufferObject.h"
#include "vtkRenderingOpenGL2Module.h"
#include "vtkSmartPointer.h"
#include "vtkTextureObject.h"
#include "vtkWindow.h"

#include <cstddef> // for std::size_t
#include <vector>

VTK_ABI_NAMESPACE_BEGIN
class vtkOpenGLRenderWindow;

class VTKRENDERINGOPENGL2_EXPORT vtkOpenGLArrayTextureBufferAdapter
{
public:
  std::vector<vtkSmartPointer<vtkDataArray>> Arrays;
  vtkSmartPointer<vtkTextureObject> Texture;
  vtkSmartPointer<vtkOpenGLBufferObject> Buffer;
  vtkOpenGLBufferObject::ObjectType BufferType;
  vtkOpenGLBufferObject::ObjectUsage BufferUsage;
  bool IntegerTexture;
  bool ScalarComponents;

  vtkOpenGLArrayTextureBufferAdapter();
  vtkOpenGLArrayTextureBufferAdapter(
    vtkDataArray* array, bool asScalars, bool* integerTexture = nullptr);
  vtkOpenGLArrayTextureBufferAdapter(const vtkOpenGLArrayTextureBufferAdapter&) = default;
  vtkOpenGLArrayTextureBufferAdapter& operator=(
    const vtkOpenGLArrayTextureBufferAdapter&) = default;

  void Upload(vtkOpenGLRenderWindow* renderWindow, bool force = false);

  void ReleaseGraphicsResources(vtkWindow* window);


  void SetUploaded(bool uploaded) { this->Uploaded = uploaded; }
  bool GetUploaded() const { return this->Uploaded; }


  void SetOwnsTexture(bool ownsTexture) { this->OwnsTexture = ownsTexture; }
  bool GetOwnsTexture() const { return this->OwnsTexture; }


  void SetPendingReset(bool pendingReset) { this->PendingReset = pendingReset; }
  bool GetPendingReset() const { return this->PendingReset; }

private:
  void UploadImpl(vtkOpenGLRenderWindow* renderWindow);

  struct NarrowedArrayInfo
  {
    std::size_t ByteLength = 0; 
    vtkIdType TexelCount = 0;   
    int NumComps = 0;           
    int Vtktype = 0;            
  };

  NarrowedArrayInfo AppendNarrowed(vtkDataArray* array, std::vector<unsigned char>& dest) const;

  struct SubArrayUpload
  {
    const void* SourceId = nullptr; 
    vtkMTimeType MTime = 0;         
    std::size_t ByteOffset = 0;     
    std::size_t ByteLength = 0;     
    vtkIdType TexelOffset = 0;      
    vtkIdType TexelCount = 0;       
  };
  struct UploadedLayout
  {
    std::vector<SubArrayUpload> Subs;
    std::size_t TotalBytes = 0;
    vtkIdType TotalTuples = 0;
    int NumComps = 0;
    int Vtktype = 0;
    bool Scalars = false;
    bool Valid = false;
  };
  UploadedLayout LastUpload;
  bool Uploaded = false;
  bool OwnsTexture = true;
  bool PendingReset = false;
};

VTK_ABI_NAMESPACE_END
#endif
// Need to skip header testing since we do not inherit vtkObject:
// VTK-HeaderTest-Exclude: vtkOpenGLArrayTextureBufferAdapter.h