#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_GENERICCONSTANTBUFFER_H
#define NUCLEX_GRAPHICS_RASTERIZATION_GENERICCONSTANTBUFFER_H

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

namespace Nuclex { namespace Graphics { namespace Rasterization {

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

  ///<summary>Stores constants that are passed to a shader</summary>
  class GenericConstantBuffer : public Buffer {

    /// <summary>Initializes a new constant buffer with the specified capacity</summary>
    /// <param name="capacityInBytes">Number of bytes to reserve for this buffer</param>
    protected: NUCLEX_GRAPHICS_API GenericConstantBuffer(std::size_t capacityInBytes) :
      Buffer(capacityInBytes) {}

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

    /// <summary>Frees all resources owned by the instance</summary>
    public: NUCLEX_GRAPHICS_API virtual ~GenericConstantBuffer() {}

    /// <summary>Counts the number of elements stored in the constant buffer</summary>
    /// <returns>The number of elements stored in the constant buffer</returns>
    public: virtual std::size_t CountElements() const = 0;

    /// <summary>
    ///   Retrieves an array describing the elements stored in the constant buffer
    /// </summary>
    /// <returns>An array describing the elements stored in the constant buffer</returns>
    public: virtual const VertexElement *GetElements() const = 0;

    /// <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 GenericConstantBuffer &operator =(
      const GenericConstantBuffer &other
    ) {
      Buffer::operator=(other);
      return *this;
    }

  };

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

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

#endif // NUCLEX_GRAPHICS_RASTERIZATION_GENERICCONSTANTBUFFER_H