src/gui/kernel/qsurfaceformat.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: http://www.qt-project.org/
   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 <QtCore/qglobal.h>
  45
  46 QT_BEGIN_HEADER
  47
  48 QT_BEGIN_NAMESPACE
  49
  50
  51 class QOpenGLContext;
  52 class QSurfaceFormatPrivate;
  53
  54 class Q_GUI_EXPORT QSurfaceFormat
  55 {
  56 public:
  57     enum FormatOption {
  58         StereoBuffers            = 0x0001,
  59         DebugContext             = 0x0002,
  60         DeprecatedFunctions      = 0x0004
  61     };
  62     Q_DECLARE_FLAGS(FormatOptions, FormatOption)
  63
  64     enum SwapBehavior {
  65         DefaultSwapBehavior,
  66         SingleBuffer,
  67         DoubleBuffer,
  68         TripleBuffer
  69     };
  70
  71     enum OpenGLContextProfile {
  72         NoProfile,
  73         CoreProfile,
  74         CompatibilityProfile
  75     };
  76
  77     QSurfaceFormat();
  78     QSurfaceFormat(FormatOptions options);
  79     QSurfaceFormat(const QSurfaceFormat &other);
  80     QSurfaceFormat &operator=(const QSurfaceFormat &other);
  81     ~QSurfaceFormat();
  82
  83     void setDepthBufferSize(int size);
  84     int depthBufferSize() const;
  85
  86     void setStencilBufferSize(int size);
  87     int stencilBufferSize() const;
  88
  89     void setRedBufferSize(int size);
  90     int redBufferSize() const;
  91     void setGreenBufferSize(int size);
  92     int greenBufferSize() const;
  93     void setBlueBufferSize(int size);
  94     int blueBufferSize() const;
  95     void setAlphaBufferSize(int size);
  96     int alphaBufferSize() const;
  97
  98     void setSamples(int numSamples);
  99     int samples() const;
 100
 101     void setSwapBehavior(SwapBehavior behavior);
 102     SwapBehavior swapBehavior() const;
 103
 104     bool hasAlpha() const;
 105
 106     void setProfile(OpenGLContextProfile profile);
 107     OpenGLContextProfile profile() const;
 108
 109     void setMajorVersion(int majorVersion);
 110     int majorVersion() const;
 111
 112     void setMinorVersion(int minorVersion);
 113     int minorVersion() const;
 114
 115     bool stereo() const;
 116     void setStereo(bool enable);
 117
 118     void setOption(QSurfaceFormat::FormatOptions opt);
 119     bool testOption(QSurfaceFormat::FormatOptions opt) const;
 120
 121 private:
 122     QSurfaceFormatPrivate *d;
 123
 124     void detach();
 125
 126     friend Q_GUI_EXPORT bool operator==(const QSurfaceFormat&, const QSurfaceFormat&);
 127     friend Q_GUI_EXPORT bool operator!=(const QSurfaceFormat&, const QSurfaceFormat&);
 128 #ifndef QT_NO_DEBUG_STREAM
 129     friend Q_GUI_EXPORT QDebug operator<<(QDebug, const QSurfaceFormat &);
 130 #endif
 131 };
 132
 133 Q_GUI_EXPORT bool operator==(const QSurfaceFormat&, const QSurfaceFormat&);
 134 Q_GUI_EXPORT bool operator!=(const QSurfaceFormat&, const QSurfaceFormat&);
 135
 136 #ifndef QT_NO_DEBUG_STREAM
 137 Q_GUI_EXPORT QDebug operator<<(QDebug, const QSurfaceFormat &);
 138 #endif
 139
 140 Q_DECLARE_OPERATORS_FOR_FLAGS(QSurfaceFormat::FormatOptions)
 141
 142 inline bool QSurfaceFormat::stereo() const
 143 {
 144     return testOption(QSurfaceFormat::StereoBuffers);
 145 }
 146
 147 QT_END_NAMESPACE
 148
 149 QT_END_HEADER
 150
 151 #endif //QSURFACEFORMAT_H