src/gui/kernel/qsurfaceformat.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: Nokia Corporation (qt-info@nokia.com)
   6 **
   7 ** This file is part of the QtGui module of the Qt Toolkit.
   8 **
   9 ** $QT_BEGIN_LICENSE:LGPL$
  10 ** GNU Lesser General Public License Usage
  11 ** This file may be used under the terms of the GNU Lesser General Public
  12 ** License version 2.1 as published by the Free Software Foundation and
  13 ** appearing in the file LICENSE.LGPL included in the packaging of this
  14 ** file. Please review the following information to ensure the GNU Lesser
  15 ** General Public License version 2.1 requirements will be met:
  16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  17 **
  18 ** In addition, as a special exception, Nokia gives you certain additional
  19 ** rights. These rights are described in the Nokia Qt LGPL Exception
  20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  21 **
  22 ** GNU General Public License Usage
  23 ** Alternatively, this file may be used under the terms of the GNU General
  24 ** Public License version 3.0 as published by the Free Software Foundation
  25 ** and appearing in the file LICENSE.GPL included in the packaging of this
  26 ** file. Please review the following information to ensure the GNU General
  27 ** Public License version 3.0 requirements will be met:
  28 ** http://www.gnu.org/copyleft/gpl.html.
  29 **
  30 ** Other Usage
  31 ** Alternatively, this file may be used in accordance with the terms and
  32 ** conditions contained in a signed written agreement between you and Nokia.
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41 #ifndef QSURFACEFORMAT_H
  42 #define QSURFACEFORMAT_H
  43
  44 #include <qglobal.h>
  45
  46 QT_BEGIN_HEADER
  47
  48 QT_BEGIN_NAMESPACE
  49
  50 QT_MODULE(Gui)
  51
  52 class QOpenGLContext;
  53 class QSurfaceFormatPrivate;
  54
  55 class Q_GUI_EXPORT QSurfaceFormat
  56 {
  57 public:
  58     enum FormatOption {
  59         StereoBuffers            = 0x0001,
  60         DebugContext             = 0x0002,
  61         DeprecatedFunctions      = 0x0004
  62     };
  63     Q_DECLARE_FLAGS(FormatOptions, FormatOption)
  64
  65     enum SwapBehavior {
  66         DefaultSwapBehavior,
  67         SingleBuffer,
  68         DoubleBuffer,
  69         TripleBuffer
  70     };
  71
  72     enum OpenGLContextProfile {
  73         NoProfile,
  74         CoreProfile,
  75         CompatibilityProfile
  76     };
  77
  78     QSurfaceFormat();
  79     QSurfaceFormat(FormatOptions options);
  80     QSurfaceFormat(const QSurfaceFormat &other);
  81     QSurfaceFormat &operator=(const QSurfaceFormat &other);
  82     ~QSurfaceFormat();
  83
  84     void setDepthBufferSize(int size);
  85     int depthBufferSize() const;
  86
  87     void setStencilBufferSize(int size);
  88     int stencilBufferSize() const;
  89
  90     void setRedBufferSize(int size);
  91     int redBufferSize() const;
  92     void setGreenBufferSize(int size);
  93     int greenBufferSize() const;
  94     void setBlueBufferSize(int size);
  95     int blueBufferSize() const;
  96     void setAlphaBufferSize(int size);
  97     int alphaBufferSize() const;
  98
  99     void setSamples(int numSamples);
 100     int samples() const;
 101
 102     void setSwapBehavior(SwapBehavior behavior);
 103     SwapBehavior swapBehavior() const;
 104
 105     bool hasAlpha() const;
 106
 107     void setProfile(OpenGLContextProfile profile);
 108     OpenGLContextProfile profile() const;
 109
 110     void setMajorVersion(int majorVersion);
 111     int majorVersion() const;
 112
 113     void setMinorVersion(int minorVersion);
 114     int minorVersion() const;
 115
 116     bool stereo() const;
 117     void setStereo(bool enable);
 118
 119     void setOption(QSurfaceFormat::FormatOptions opt);
 120     bool testOption(QSurfaceFormat::FormatOptions opt) const;
 121
 122 private:
 123     QSurfaceFormatPrivate *d;
 124
 125     void detach();
 126
 127     friend Q_GUI_EXPORT bool operator==(const QSurfaceFormat&, const QSurfaceFormat&);
 128     friend Q_GUI_EXPORT bool operator!=(const QSurfaceFormat&, const QSurfaceFormat&);
 129 #ifndef QT_NO_DEBUG_STREAM
 130     friend Q_GUI_EXPORT QDebug operator<<(QDebug, const QSurfaceFormat &);
 131 #endif
 132 };
 133
 134 Q_GUI_EXPORT bool operator==(const QSurfaceFormat&, const QSurfaceFormat&);
 135 Q_GUI_EXPORT bool operator!=(const QSurfaceFormat&, const QSurfaceFormat&);
 136
 137 #ifndef QT_NO_DEBUG_STREAM
 138 Q_GUI_EXPORT QDebug operator<<(QDebug, const QSurfaceFormat &);
 139 #endif
 140
 141 Q_DECLARE_OPERATORS_FOR_FLAGS(QSurfaceFormat::FormatOptions)
 142
 143 inline bool QSurfaceFormat::stereo() const
 144 {
 145     return testOption(QSurfaceFormat::StereoBuffers);
 146 }
 147
 148 QT_END_NAMESPACE
 149
 150 QT_END_HEADER
 151
 152 #endif //QSURFACEFORMAT_H