/Users/kitware/Dashboards/MyTests/VTK_BLD_Release_docs/Utilities/Doxygen/dox/Rendering/OpenGL2/vtkglBufferObject.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Visualization Toolkit

  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm 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 vtkglBufferObject_h
#define vtkglBufferObject_h

#include "vtkRenderingOpenGL2Module.h"
#include "vtkStdString.h" // for std::string

namespace vtkgl {

class VTKRENDERINGOPENGL2_EXPORT BufferObject
{
public:
  enum ObjectType {
    ArrayBuffer,
    ElementArrayBuffer
  };

  BufferObject(ObjectType type = ArrayBuffer);
  ~BufferObject();

  ObjectType GetType() const;

  int GetHandle() const;

  bool IsReady() const { return Dirty == false; }

  template <class T>
  bool Upload(const T &array, ObjectType type);

  // non vector version
  template <class T>
  bool Upload(const T *array, size_t numElements, ObjectType type);

  bool Bind();

  bool Release();


  // Description:
  // Release any graphics resources that are being consumed by this class.
  void ReleaseGraphicsResources();

  std::string GetError() const { return Error; }

private:
  bool UploadInternal(const void *buffer, size_t size, ObjectType objectType);

  struct Private;
  Private *d;

  bool  Dirty;
  std::string Error;
};

template <class T>
inline bool BufferObject::Upload(const T &array,
                                 BufferObject::ObjectType objectType)
{
  if (array.empty())
    {
    this->Error = "Refusing to upload empty array.";
    return false;
    }
  return this->UploadInternal(&array[0],
                              array.size() * sizeof(typename T::value_type),
                              objectType);
}

template <class T>
inline bool BufferObject::Upload(const T *array, size_t numElements,
                                 BufferObject::ObjectType objectType)
{
  if (!array)
    {
    this->Error = "Refusing to upload empty array.";
    return false;
    }
  return this->UploadInternal(array,
                              numElements * sizeof(T),
                              objectType);
}

}

#endif

// VTK-HeaderTest-Exclude: vtkglBufferObject.h