src/libANGLE/renderer/gl/VertexArrayGL.h

//
// Copyright 2015 The ANGLE Project Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
//

// VertexArrayGL.h: Defines the class interface for VertexArrayGL.

#ifndef LIBANGLE_RENDERER_GL_VERTEXARRAYGL_H_
#define LIBANGLE_RENDERER_GL_VERTEXARRAYGL_H_

#include "libANGLE/renderer/VertexArrayImpl.h"

#include "common/mathutil.h"
#include "libANGLE/Context.h"
#include "libANGLE/renderer/gl/ContextGL.h"

namespace rx
{

class FunctionsGL;
class StateManagerGL;
struct VertexArrayStateGL;

class VertexArrayGL : public VertexArrayImpl
{
  public:
    VertexArrayGL(const gl::VertexArrayState &data, GLuint id);
    VertexArrayGL(const gl::VertexArrayState &data, GLuint id, VertexArrayStateGL *sharedState);
    ~VertexArrayGL() override;

    void destroy(const gl::Context *context) override;

    angle::Result syncClientSideData(const gl::Context *context,
                                     const gl::AttributesMask &activeAttributesMask,
                                     GLint first,
                                     GLsizei count,
                                     GLsizei instanceCount) const;
    angle::Result syncDrawElementsState(const gl::Context *context,
                                        const gl::AttributesMask &activeAttributesMask,
                                        GLsizei count,
                                        gl::DrawElementsType type,
                                        const void *indices,
                                        GLsizei instanceCount,
                                        bool primitiveRestartEnabled,
                                        const void **outIndices) const;

    GLuint getVertexArrayID() const;
    VertexArrayStateGL *getNativeState() const;

    angle::Result syncState(const gl::Context *context,
                            const gl::VertexArray::DirtyBits &dirtyBits,
                            gl::VertexArray::DirtyAttribBitsArray *attribBits,
                            gl::VertexArray::DirtyBindingBitsArray *bindingBits) override;

    angle::Result applyNumViewsToDivisor(const gl::Context *context, int numViews);
    angle::Result applyActiveAttribLocationsMask(const gl::Context *context,
                                                 const gl::AttributesMask &activeMask);

    angle::Result validateState(const gl::Context *context) const;

    angle::Result recoverForcedStreamingAttributesForDrawArraysInstanced(
        const gl::Context *context) const;

  private:
    angle::Result syncDrawState(const gl::Context *context,
                                const gl::AttributesMask &activeAttributesMask,
                                GLint first,
                                GLsizei count,
                                gl::DrawElementsType type,
                                const void *indices,
                                GLsizei instanceCount,
                                bool primitiveRestartEnabled,
                                const void **outIndices) const;

    // Apply index data, only sets outIndexRange if attributesNeedStreaming is true
    angle::Result syncIndexData(const gl::Context *context,
                                GLsizei count,
                                gl::DrawElementsType type,
                                const void *indices,
                                bool primitiveRestartEnabled,
                                bool attributesNeedStreaming,
                                gl::IndexRange *outIndexRange,
                                const void **outIndices) const;

    // Returns the amount of space needed to stream all attributes that need streaming
    // and the data size of the largest attribute
    void computeStreamingAttributeSizes(const gl::AttributesMask &attribsToStream,
                                        GLsizei instanceCount,
                                        const gl::IndexRange &indexRange,
                                        size_t *outStreamingDataSize,
                                        size_t *outMaxAttributeDataSize) const;

    // Stream attributes that have client data
    angle::Result streamAttributes(const gl::Context *context,
                                   const gl::AttributesMask &attribsToStream,
                                   GLsizei instanceCount,
                                   const gl::IndexRange &indexRange,
                                   bool applyExtraOffsetWorkaroundForInstancedAttributes) const;
    angle::Result syncDirtyAttrib(const gl::Context *context,
                                  size_t attribIndex,
                                  const gl::VertexArray::DirtyAttribBits &dirtyAttribBits);
    angle::Result syncDirtyBinding(const gl::Context *context,
                                   size_t bindingIndex,
                                   const gl::VertexArray::DirtyBindingBits &dirtyBindingBits);

    angle::Result updateAttribEnabled(const gl::Context *context, size_t attribIndex);
    angle::Result updateAttribPointer(const gl::Context *context, size_t attribIndex);

    bool supportVertexAttribBinding(const gl::Context *context) const;

    angle::Result updateAttribFormat(const gl::Context *context, size_t attribIndex);
    angle::Result updateAttribBinding(const gl::Context *context, size_t attribIndex);
    angle::Result updateBindingBuffer(const gl::Context *context, size_t bindingIndex);
    angle::Result updateBindingDivisor(const gl::Context *context, size_t bindingIndex);

    angle::Result updateElementArrayBufferBinding(const gl::Context *context) const;

    angle::Result callVertexAttribPointer(const gl::Context *context,
                                          GLuint attribIndex,
                                          const gl::VertexAttribute &attrib,
                                          GLsizei stride,
                                          GLintptr offset) const;

    angle::Result recoverForcedStreamingAttributesForDrawArraysInstanced(
        const gl::Context *context,
        gl::AttributesMask *attributeMask) const;

    GLuint mVertexArrayID = 0;
    int mAppliedNumViews  = 1;

    // Remember the program's active attrib location mask so that attributes can be enabled/disabled
    // based on whether they are active in the program
    gl::AttributesMask mProgramActiveAttribLocationsMask;

    bool mOwnsNativeState            = false;
    VertexArrayStateGL *mNativeState = nullptr;

    mutable gl::BindingPointer<gl::Buffer> mElementArrayBuffer;
    mutable std::array<gl::BindingPointer<gl::Buffer>, gl::MAX_VERTEX_ATTRIBS> mArrayBuffers;

    mutable size_t mStreamingElementArrayBufferSize = 0;
    mutable GLuint mStreamingElementArrayBuffer     = 0;

    mutable size_t mStreamingArrayBufferSize = 0;
    mutable GLuint mStreamingArrayBuffer     = 0;

    // Used for Mac Intel instanced draw workaround
    mutable gl::AttributesMask mForcedStreamingAttributesForDrawArraysInstancedMask;
    mutable gl::AttributesMask mInstancedAttributesMask;
    mutable std::array<GLint, gl::MAX_VERTEX_ATTRIBS> mForcedStreamingAttributesFirstOffsets;
};

ANGLE_INLINE angle::Result VertexArrayGL::syncDrawElementsState(
    const gl::Context *context,
    const gl::AttributesMask &activeAttributesMask,
    GLsizei count,
    gl::DrawElementsType type,
    const void *indices,
    GLsizei instanceCount,
    bool primitiveRestartEnabled,
    const void **outIndices) const
{
    return syncDrawState(context, activeAttributesMask, 0, count, type, indices, instanceCount,
                         primitiveRestartEnabled, outIndices);
}

}  // namespace rx

#endif  // LIBANGLE_RENDERER_GL_VERTEXARRAYGL_H_