#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_INTROSPECTION_CONSTANTMETADATA_H
#define NUCLEX_GRAPHICS_INTROSPECTION_CONSTANTMETADATA_H

#include "Nuclex/Graphics/Config.h"
#include "ConstantOrder.h"
#include "ConstantType.h"

#include <cstddef>
#include <cstdint>
#include <string>
#include <vector>

namespace Nuclex { namespace Graphics { namespace Introspection {

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

  /// <summary>Variable passed to the shader directly via a constant buffer</summary>
  /// <remarks>
  ///   <para>
  ///     Shaders execute many times in parallel on different inputs received from either
  ///     vertex buffers (in case of vertex shaders) or from vertex shader outputs (in
  ///     case of pixel shaders).
  ///   </para>
  ///   <para>
  ///     There are some constants that stay the same across all these executions. For
  ///     example, the camera position or light direction. These are stored in a constant
  ///     buffers and get reused by the shader for at least an entire draw call.
  ///   </para>
  /// </remarks>
  struct ConstantMetadata {

    /// <summary>Name the constant has been declared with in the shader</summary>
    public: std::string Name;

    /// <summary>Offset of the constant in the constant buffer</summary>
    public: std::size_t Offset;

    /// <summary>Size of the constant in bytes</summary>
    public: std::size_t Size;

    /// <summary>Order of the value in the constant, from scalar to matrix</summary>
    public: ConstantOrder::Enum Order;

    /// <summary>The data type of the constant</summary>
    public: ConstantType::Enum Type;

    /// <summary>Contains the default value of the constant</summary>
    public: std::vector<std::uint8_t> DefaultValue;

    /// <summary>Number of columns in a matrix or elements in a vector</summary>
    public: std::size_t ColumnCount;

    /// <summary>Number of rows in a matrix</summary>
    public: std::size_t RowCount;

  };

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

}}} // namespace Nuclex::Graphics::Introspection

#endif // NUCLEX_GRAPHICS_INTROSPECTION_CONSTANTMETADATA_H