screen.H

/*
 * This file is part of the "Archon" framework.
 * (http://files3d.sourceforge.net)
 *
 * Copyright © 2006 by Kristian Spangsege and Brian Kristiansen.
 *
 * Permission to use, copy, modify, and distribute this software and
 * its documentation under the terms of the GNU General Public License is
 * hereby granted. No representations are made about the suitability of
 * this software for any purpose. It is provided "as is" without express
 * or implied warranty. See the GNU General Public License
 * (http://www.gnu.org/copyleft/gpl.html) for more details.
 *
 * The characters in this file are ISO8859-1 encoded.
 *
 * The documentation in this file is in "Doxygen" style
 * (http://www.doxygen.org).
 */

#ifndef ARCHON_DISPLAY_SCREEN_H
#define ARCHON_DISPLAY_SCREEN_H

#include <stdexcept>
#include <string>

#include <archon/util/exception.H>
#include <archon/util/ref.H>
#include <archon/display/connection.H>
#include <archon/display/visual.H>

namespace Archon
{
  namespace Display
  {
    using namespace std;
    using namespace Utilities;

    // Fallback declarations. A fallback declaration for class Foo is
    // needed when the header that defines Foo includes this
    // header. In this case this header will not include "foo.H" due
    // to include guards, and Foo would be unknown.
    struct Connection;
    struct Visual;

    struct NoSuchVisualException: virtual Exception
    {
      NoSuchVisualException(string l): Exception(l) {}
    };


    struct Screen: virtual RefObjectBase
    {
      virtual Ref<Connection> getConnection() = 0;

      virtual Ref<Visual> getDefaultVisual() = 0;

      virtual Ref<Visual> chooseVisual(bool doubleBuffer = true,
                                       bool stereo = false,
                                       int red = 8, int green = 8,
                                       int blue = 8, int alpha = 8,
                                       int depth = 16, int stencil = 0,
                                       int accumRed = 0, int accumGreen = 0,
                                       int accumBlue = 0, int accumAlpha = 0)
        throw(NoSuchVisualException) = 0;

      virtual int getNumberOfVisuals() = 0;

      virtual Ref<Visual> getVisual(int index) throw(out_of_range) = 0;

      virtual int getWidth() = 0;

      virtual int getHeight() = 0;

      virtual double getHorizontalDotPitch() = 0;

      virtual double getVerticalDotPitch() = 0;
    };
  }
}

#endif // ARCHON_DISPLAY_SCREEN_H

---