#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_GENERICINDEXBUFFER_H
#define NUCLEX_GRAPHICS_RASTERIZATION_GENERICINDEXBUFFER_H

#include "Buffer.h"

namespace Nuclex { namespace Graphics { namespace Rasterization {

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

  /// <summary>Stores indices used to connect vertices to primitives</summary>
  class GenericIndexBuffer : public Buffer {

    /// <summary>Initializes a new index buffer with the specified capacity</summary>
    /// <param name="capacityInBytes">Number of bytes to reserve for this buffer</param>
    /// <param name="usage">How the index buffer is going to be accessed</param>
    protected: NUCLEX_GRAPHICS_API GenericIndexBuffer(
      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 GenericIndexBuffer(const GenericIndexBuffer &other) :
      Buffer(other),
      usage(other.usage) {}

    /// <summary>Checks whether this index buffer is using 32 bit indices</summary>
    /// <returns>True if the index buffer uses 32 bit indices</returns>
    public: virtual bool Is32BitIndexBuffer() const = 0;

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

    /// <summary>Retrieves the number of indices that have been used</summary>
    /// <returns>The number of used indices in the index buffer</returns>
    public: virtual std::size_t CountUsedIndices() const = 0;

    /// <summary>Returns the usage this index buffer is intended for</summary>
    /// <returns>The intended usage pattern of the index 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 GenericIndexBuffer &operator =(
      const GenericIndexBuffer &other
    ) {
      Buffer::operator=(other);
      this->usage = other.usage;
      return *this;
    }

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

  };

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

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

#endif // NUCLEX_GRAPHICS_RASTERIZATION_GENERICINDEXBUFFER_H