OpenSubdiv/opensubdiv/osd/glslComputeContext.h

//
//   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 OSD_GLSL_COMPUTE_CONTEXT_H
#define OSD_GLSL_COMPUTE_CONTEXT_H

#include "../version.h"

#include "../osd/nonCopyable.h"
#include "../osd/opengl.h"

#include <vector>

namespace OpenSubdiv {
namespace OPENSUBDIV_VERSION {

namespace Far{ class StencilTables; }

namespace Osd {

///
/// \brief GLSL-Compute Refine Context
///
/// The GLSL-Compute implementation of the Refine module contextual functionality.
///
/// Contexts interface the serialized topological data pertaining to the
/// geometric primitives with the capabilities of the selected discrete
/// compute device.
///
class GLSLComputeContext {

public:
    /// Creates an GLSLComputeContext instance
    ///
    /// @param vertexStencilTables   The Far::StencilTables used for vertex
    ///                              interpolation
    ///
    /// @param varyingStencilTables  The Far::StencilTables used for varying
    ///                              interpolation
    ///
    static GLSLComputeContext * Create(Far::StencilTables const * vertexStencilTables,
                                          Far::StencilTables const * varyingStencilTables=0);

    /// Destructor
    virtual ~GLSLComputeContext();

    /// Returns true if the Context has a 'vertex' interpolation stencil table
    bool HasVertexStencilTables() const;

    /// Returns true if the Context has a 'varying' interpolation stencil table
    bool HasVaryingStencilTables() const;

    /// Returns the number of control vertices
    int GetNumControlVertices() const {
        return _numControlVertices;
    }

    /// Returns the Cuda buffer containing vertex-stencil stencil sizes
    GLuint GetVertexStencilTablesSizes() const;

    /// Returns the Cuda buffer containing vertex-stencil stencil offsets
    GLuint GetVertexStencilTablesOffsets() const;

    /// Binds GL buffers containing stencils for 'vertex' interpolation
    void BindVertexStencilTables() const;

    /// Binds GL buffers containing stencils for 'varying' interpolation
    void BindVaryingStencilTables() const;

    /// Unbinds GL stencil buffers
    void UnbindStencilTables() const;

protected:

    explicit GLSLComputeContext(Far::StencilTables const * vertexStencilTables,
                                   Far::StencilTables const * varyingStencilTables);

private:

    class GLSLStencilTables;

    GLSLStencilTables * _vertexStencilTables,
                      * _varyingStencilTables;

    int _numControlVertices;
};

}  // end namespace Osd

}  // end namespace OPENSUBDIV_VERSION
using namespace OPENSUBDIV_VERSION;

}  // end namespace OpenSubdiv

#endif  // OSD_GLSL_COMPUTE_CONTEXT_H