OpenSubdiv/opensubdiv/osd/clGLVertexBuffer.h
Mike Erwin fc19cd2604 spelling phase 2
For completeness, ran files through an automated spell checker (Visual
Studio plugin) which caught several things missed while reading.
2017-01-24 22:48:44 -08:00

120 lines
3.8 KiB
C++

//
// Copyright 2013 Pixar
//
// Licensed under the Apache License, Version 2.0 (the "Apache License")
// with the following modification; you may not use this file except in
// compliance with the Apache License and the following modification to it:
// Section 6. Trademarks. is deleted and replaced with:
//
// 6. Trademarks. This License does not grant permission to use the trade
// names, trademarks, service marks, or product names of the Licensor
// and its affiliates, except as required to comply with Section 4(c) of
// the License and to reproduce the content of the NOTICE file.
//
// You may obtain a copy of the Apache License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the Apache License with the above modification is
// distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the Apache License for the specific
// language governing permissions and limitations under the Apache License.
//
#ifndef OPENSUBDIV3_OSD_CL_GL_VERTEX_BUFFER_H
#define OPENSUBDIV3_OSD_CL_GL_VERTEX_BUFFER_H
#include "../version.h"
#include "../osd/opengl.h"
#include "../osd/opencl.h"
namespace OpenSubdiv {
namespace OPENSUBDIV_VERSION {
namespace Osd {
///
/// \brief Concrete vertex buffer class for OpenCL subdivision and OpenGL drawing.
///
/// CLGLVertexBuffer implements CLVertexBufferInterface and
/// GLVertexBufferInterface.
///
/// The buffer interop between OpenCL and GL is handled automatically when a
/// client calls BindCLBuffer and BindVBO methods.
///
class CLGLVertexBuffer {
public:
/// Creator. Returns NULL if error.
static CLGLVertexBuffer * Create(int numElements,
int numVertices,
cl_context clContext);
template <typename DEVICE_CONTEXT>
static CLGLVertexBuffer * Create(int numElements, int numVertices,
DEVICE_CONTEXT context) {
return Create(numElements, numVertices, context->GetContext());
}
/// Destructor.
~CLGLVertexBuffer();
/// This method is meant to be used in client code in order to provide
/// coarse vertices data to Osd.
void UpdateData(const float *src, int startVertex, int numVertices,
cl_command_queue clQueue);
template<typename DEVICE_CONTEXT>
void UpdateData(const float *src, int startVertex, int numVertices,
DEVICE_CONTEXT context) {
UpdateData(src, startVertex, numVertices, context->GetCommandQueue());
}
/// Returns how many elements defined in this vertex buffer.
int GetNumElements() const;
/// Returns how many vertices allocated in this vertex buffer.
int GetNumVertices() const;
/// Returns the CL memory object. GL buffer will be mapped to CL memory
/// space if necessary.
cl_mem BindCLBuffer(cl_command_queue queue);
/// Returns the GL buffer object. If the buffer is mapped to CL memory
/// space, it will be unmapped back to GL.
GLuint BindVBO(void *deviceContext = NULL);
protected:
/// Constructor.
CLGLVertexBuffer(int numElements, int numVertices, cl_context clContext);
/// Allocates VBO for this buffer and register as a CL resource.
/// Returns true if success.
bool allocate(cl_context clContext);
/// Acquires a resource from GL.
void map(cl_command_queue queue);
/// Releases a resource to GL.
void unmap();
private:
int _numElements;
int _numVertices;
GLuint _vbo;
cl_command_queue _clQueue;
cl_mem _clMemory;
bool _clMapped;
};
} // end namespace Osd
} // end namespace OPENSUBDIV_VERSION
using namespace OPENSUBDIV_VERSION;
} // end namespace OpenSubdiv
#endif // OPENSUBDIV3_OSD_CL_GL_VERTEX_BUFFER_H