#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_RASTERIZERSETTINGS_H
#define NUCLEX_GRAPHICS_RASTERIZATION_RASTERIZERSETTINGS_H

#include "../Config.h"

#include <cstddef>

namespace Nuclex { namespace Graphics { namespace Rasterization {

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

  class PolygonOptions;

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

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

namespace Nuclex { namespace Graphics { namespace Rasterization {

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

  ///<summary>Controls various settings the rasterizer can be configured with</summary>
  class RasterizerSettings {

    #pragma region struct ResolutionInfo

    /// <summary>Stores informations about the screen resolution</summary>
    public: struct ResolutionInfo {

      /// <summary>Width for the screen resolution or window in pixels</summary>
      public: std::size_t Width;
      /// <summary>Height for the screen resolution or window in pixels</summary>
      public: std::size_t Height;
      /// <summary>Desired refresh rate in Hz (0 = default)</summary>
      public: std::size_t RefreshRateInHz;
      /// <summary>Whether the view should fill the entire screen</summary>
      public: std::size_t IsFullscreen;

    };

    #pragma endregion // struct ResolutionInfo

    /// <summary>Frees all resources owned by the rasterizer settings interface</summary>
    public: virtual ~RasterizerSettings() {}

    /// <summary>Whether the rasterizer is currently synching page flips</summary>
    /// <returns>True if the rasterizr is synching page flips</returns>
    public: virtual bool IsVerticalSynchronizationEnabled() const = 0;

    /// <summary>Switches whether the rasterizer will synchronize its page flips</summary>
    /// <param name="wait">True if the rasterizer should synchronize its page flips</param>
    public: virtual void EnableVerticalSynchronization(bool wait = true) = 0;

    /// <summary>Counts the number of supported display resolutions</summary>
    /// <returns>The total number of display resolutions supported</returns>
    public: virtual std::size_t CountSupportedResolutions() const = 0;

#if 0
    /// <summary>Retrieves one of the supported display resolutions</summary>
    /// <param name="index">Index of the resolution that will be retrieved</param>
    /// <returns>Informations about the requested display resolution</returns>
    public: virtual ResolutionInfo GetSupportedResolution(std::size_t index) const = 0;

    /// <summary>Retrieves the currently active display resolution</summary>
    /// <returns>The currently active screen resolution</returns>
    public: virtual ResolutionInfo GetCurrentResolution() const = 0;

    /// <summary>Switches to a different display resolution</summary>
    /// <param name="resolutionInfo">Resolution to switch to</param>
    public: virtual void ChangeResolution(const ResolutionInfo &resolutionInfo) = 0;
#endif

#if 0
    /// <summary>Retrieves the currently active options for rendering polygons</summary>
    /// <returns>The polygon options currently in effect</returns>
    public: virtual const std::shared_ptr<PolygonOptions> &GetPolygonOptions() const = 0;

    /// <summary>Sets the options to use for rendering polygons</summary>
    /// <param name="options">Options that will be used when rendering polygons</param>
    public: virtual void SetPolygonOptions(const std::shared_ptr<PolygonOptions> &options) = 0;
#endif

  };

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

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

#endif // NUCLEX_GRAPHICS_RASTERIZATION_RASTERIZERSETTINGS_H