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 ** No Commercial Usage
  11 ** This file contains pre-release code and may not be distributed.
  12 ** You may use this file in accordance with the terms and conditions
  13 ** contained in the Technology Preview License Agreement accompanying
  14 ** this package.
  15 **
  16 ** GNU Lesser General Public License Usage
  17 ** Alternatively, this file may be used under the terms of the GNU Lesser
  18 ** General Public License version 2.1 as published by the Free Software
  19 ** Foundation and appearing in the file LICENSE.LGPL included in the
  20 ** packaging of this file.  Please review the following information to
  21 ** ensure the GNU Lesser General Public License version 2.1 requirements
  22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  23 **
  24 ** In addition, as a special exception, Nokia gives you certain additional
  25 ** rights.  These rights are described in the Nokia Qt LGPL Exception
  26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  27 **
  28 ** If you have questions regarding the use of this file, please contact
  29 ** Nokia at qt-info@nokia.com.
  30 **
  31 **
  32 **
  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 QGuiGLContext;
  53 class QSurfaceFormatPrivate;
  54
  55 class Q_GUI_EXPORT QSurfaceFormat
  56 {
  57 public:
  58     enum FormatOption {
  59         StereoBuffers           = 0x0001
  60     };
  61     Q_DECLARE_FLAGS(FormatOptions, FormatOption)
  62
  63     enum SwapBehavior {
  64         DefaultSwapBehavior,
  65         SingleBuffer,
  66         DoubleBuffer,
  67         TripleBuffer
  68     };
  69
  70     enum OpenGLContextProfile {
  71         NoProfile,
  72         CoreProfile,
  73         CompatibilityProfile
  74     };
  75
  76     QSurfaceFormat();
  77     QSurfaceFormat(FormatOptions options);
  78     QSurfaceFormat(const QSurfaceFormat &other);
  79     QSurfaceFormat &operator=(const QSurfaceFormat &other);
  80     ~QSurfaceFormat();
  81
  82     void setDepthBufferSize(int size);
  83     int depthBufferSize() const;
  84
  85     void setStencilBufferSize(int size);
  86     int stencilBufferSize() const;
  87
  88     void setRedBufferSize(int size);
  89     int redBufferSize() const;
  90     void setGreenBufferSize(int size);
  91     int greenBufferSize() const;
  92     void setBlueBufferSize(int size);
  93     int blueBufferSize() const;
  94     void setAlphaBufferSize(int size);
  95     int alphaBufferSize() const;
  96
  97     void setSamples(int numSamples);
  98     int samples() const;
  99
 100     void setSwapBehavior(SwapBehavior behavior);
 101     SwapBehavior swapBehavior() const;
 102
 103     bool hasAlpha() const;
 104
 105     void setProfile(OpenGLContextProfile profile);
 106     OpenGLContextProfile profile() const;
 107
 108     bool stereo() const;
 109     void setStereo(bool enable);
 110
 111     void setOption(QSurfaceFormat::FormatOptions opt);
 112     bool testOption(QSurfaceFormat::FormatOptions opt) const;
 113
 114 private:
 115     QSurfaceFormatPrivate *d;
 116
 117     void detach();
 118
 119     friend Q_GUI_EXPORT bool operator==(const QSurfaceFormat&, const QSurfaceFormat&);
 120     friend Q_GUI_EXPORT bool operator!=(const QSurfaceFormat&, const QSurfaceFormat&);
 121 #ifndef QT_NO_DEBUG_STREAM
 122     friend Q_GUI_EXPORT QDebug operator<<(QDebug, const QSurfaceFormat &);
 123 #endif
 124 };
 125
 126 Q_GUI_EXPORT bool operator==(const QSurfaceFormat&, const QSurfaceFormat&);
 127 Q_GUI_EXPORT bool operator!=(const QSurfaceFormat&, const QSurfaceFormat&);
 128
 129 #ifndef QT_NO_DEBUG_STREAM
 130 Q_GUI_EXPORT QDebug operator<<(QDebug, const QSurfaceFormat &);
 131 #endif
 132
 133 Q_DECLARE_OPERATORS_FOR_FLAGS(QSurfaceFormat::FormatOptions)
 134
 135 inline bool QSurfaceFormat::stereo() const
 136 {
 137     return testOption(QSurfaceFormat::StereoBuffers);
 138 }
 139
 140 QT_END_NAMESPACE
 141
 142 QT_END_HEADER
 143
 144 #endif //QSURFACEFORMAT_H