#pragma region CPL License
/*
Nuclex Native Framework
Copyright (C) 2002-2013 Nuclex Development Labs

This library is free software; you can redistribute it and/or
modify it under the terms of the IBM Common Public License as
published by the IBM Corporation; either version 1.0 of the
License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
IBM Common Public License for more details.

You should have received a copy of the IBM Common Public
License along with this library
*/
#pragma endregion // CPL License

#ifndef NUCLEX_GRAPHICS_RASTERIZATION_GENERICVERTEXBUFFER_H
#define NUCLEX_GRAPHICS_RASTERIZATION_GENERICVERTEXBUFFER_H

#include "Buffer.h"
#include "../VertexElement.h"

namespace Nuclex { namespace Graphics { namespace Rasterization {

  // ------------------------------------------------------------------------------------------- //

  ///<summary>Stores vertices used to define geometric features for rasterization</summary>
  class GenericVertexBuffer : public Buffer {

    /// <summary>Initializes a new vertex buffer with the specified capacity</summary>
    /// <param name="capacityInBytes">Number of bytes to reserve for this buffer</param>
    /// <param name="usage">How the vertex buffer will be accessed</param>
    protected: NUCLEX_GRAPHICS_API GenericVertexBuffer(
      std::size_t capacityInBytes, Usage::Enum usage
    ) :
      Buffer(capacityInBytes),
      usage(usage) {}

    /// <summary>Initializes a new index buffer by copying an existing index buffer</summary>
    /// <param name="other">Existing index buffer that will be copied</param>
    protected: NUCLEX_GRAPHICS_API GenericVertexBuffer(const GenericVertexBuffer &other) :
      Buffer(other),
      usage(other.usage) {}

    /// <summary>Retrieves the stride to get from one vertex to the next</summary>
    /// <returns>The stride of the vertex buffer in bytes</returns>
    public: virtual std::size_t GetStride() const = 0;

    /// <summary>Retrieves the total capacity of the vertex buffer in vertices</summary>
    /// <returns>The capacity of the vertex buffer in vertices</returns>
    public: virtual std::size_t GetCapacityInVertices() const = 0;

    /// <summary>Counts the number of vertices that have been used</summary>
    /// <returns>The number of used vertices in the vertex buffer</returns>
    public: virtual std::size_t CountUsedVertices() const = 0;

    /// <summary>Counts the number of elements a vertex consists of</summary>
    /// <returns>The number of elements in a vertex</returns>
    public: virtual std::size_t CountVertexElements() const = 0;

    /// <summary>Retrieves an array describing the elements a vertex consists of</summary>
    /// <returns>An array describing the elements a vertices are made up from</returns>
    public: virtual const VertexElement *GetVertexElements() const = 0;

    /// <summary>Returns the usage this vertex buffer is intended for</summary>
    /// <returns>The intended usage pattern of the vertex buffer</returns>
    public: NUCLEX_GRAPHICS_API Usage::Enum GetUsage() const {
      return this->usage;
    }

    /// <summary>Copies the contents of another buffer into this buffer</summary>
    /// <param name="other">Other buffer whose contents will be copied</param>
    /// <returns>A reference to this buffer</returns>
    protected: NUCLEX_GRAPHICS_API GenericVertexBuffer &operator =(
      const GenericVertexBuffer &other
    ) {
      Buffer::operator=(other);
      this->usage = other.usage;
      return *this;
    }

    /// <summary>How the vertex buffer will be accessed</summary>
    private: Usage::Enum usage;

  };

  // ------------------------------------------------------------------------------------------- //

}}} // namespace Nuclex::Graphics::Rasterization

#endif // NUCLEX_GRAPHICS_RASTERIZATION_GENERICVERTEXBUFFER_H