// Copyright (C) 2016 The Qt Company Ltd.

// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only

#ifndef QSURFACEFORMAT_H

#define QSURFACEFORMAT_H

#include <QtGui/qtguiglobal.h>

#include <QtCore/qobjectdefs.h>

QT_BEGIN_NAMESPACE

class QColorSpace;

class QOpenGLContext;

class QSurfaceFormatPrivate;

class Q_GUI_EXPORT QSurfaceFormat

{

    Q_GADGET

public:

    enum FormatOption {

        StereoBuffers            = 0x0001,

        DebugContext             = 0x0002,

        DeprecatedFunctions      = 0x0004,

        ResetNotification        = 0x0008,

        ProtectedContent         = 0x0010

    };

    Q_ENUM(FormatOption)

    Q_DECLARE_FLAGS(FormatOptions, FormatOption)

    enum SwapBehavior {

        DefaultSwapBehavior,

        SingleBuffer,

        DoubleBuffer,

        TripleBuffer

    };

    Q_ENUM(SwapBehavior)

    enum RenderableType {

        DefaultRenderableType = 0x0,

        OpenGL                = 0x1,

        OpenGLES              = 0x2,

        OpenVG                = 0x4

    };

    Q_ENUM(RenderableType)

    enum OpenGLContextProfile {

        NoProfile,

        CoreProfile,

        CompatibilityProfile

    };

    Q_ENUM(OpenGLContextProfile)

#if QT_DEPRECATED_SINCE(6,0)

    enum ColorSpace {

        DefaultColorSpace,

        sRGBColorSpace

    };

    Q_ENUM(ColorSpace)

#endif

    enum ColorComponentType {

        FixedColorComponentType,

        FloatColorComponentType

    };

    Q_ENUM(ColorComponentType)

    QSurfaceFormat();

    Q_IMPLICIT QSurfaceFormat(FormatOptions options);

    QSurfaceFormat(const QSurfaceFormat &other);

    QSurfaceFormat &operator=(const QSurfaceFormat &other);

    ~QSurfaceFormat();

    void setDepthBufferSize(int size);

    int depthBufferSize() const;

    void setStencilBufferSize(int size);

    int stencilBufferSize() const;

    void setRedBufferSize(int size);

    int redBufferSize() const;

    void setGreenBufferSize(int size);

    int greenBufferSize() const;

    void setBlueBufferSize(int size);

    int blueBufferSize() const;

    void setAlphaBufferSize(int size);

    int alphaBufferSize() const;

    void setColorComponentType(ColorComponentType type);

    ColorComponentType colorComponentType() const;

    void setSamples(int numSamples);

    int samples() const;

    void setSwapBehavior(SwapBehavior behavior);

    SwapBehavior swapBehavior() const;

    bool hasAlpha() const;

    void setProfile(OpenGLContextProfile profile);

    OpenGLContextProfile profile() const;

    void setRenderableType(RenderableType type);

    RenderableType renderableType() const;

    void setMajorVersion(int majorVersion);

    int majorVersion() const;

    void setMinorVersion(int minorVersion);

    int minorVersion() const;

    std::pair<int, int> version() const;

    void setVersion(int major, int minor);

    bool stereo() const;

    void setStereo(bool enable);

    void setOptions(QSurfaceFormat::FormatOptions options);

    void setOption(FormatOption option, bool on = true);

    bool testOption(FormatOption option) const;

    QSurfaceFormat::FormatOptions options() const;

    int swapInterval() const;

    void setSwapInterval(int interval);

    const QColorSpace &colorSpace() const;

    void setColorSpace(const QColorSpace &colorSpace);

#if QT_DEPRECATED_SINCE(6,0)

    Q_DECL_DEPRECATED_X("Use setColorSpace(QColorSpace) instead.")

    void setColorSpace(ColorSpace colorSpace);

#endif

    static void setDefaultFormat(const QSurfaceFormat &format);

    static QSurfaceFormat defaultFormat();

private:

    QSurfaceFormatPrivate *d;

    void detach();

    bool equals(const QSurfaceFormat &other) const noexcept;

    friend inline bool operator==(const QSurfaceFormat &lhs, const QSurfaceFormat &rhs) noexcept

    { return lhs.equals(rhs); }

    friend inline bool operator!=(const QSurfaceFormat &lhs, const QSurfaceFormat &rhs) noexcept

    { return !lhs.equals(rhs); }

#ifndef QT_NO_DEBUG_STREAM

    friend Q_GUI_EXPORT QDebug operator<<(QDebug, const QSurfaceFormat &);

#endif

};

#ifndef QT_NO_DEBUG_STREAM

Q_GUI_EXPORT QDebug operator<<(QDebug, const QSurfaceFormat &);

#endif

Q_DECLARE_OPERATORS_FOR_FLAGS(QSurfaceFormat::FormatOptions)

inline bool QSurfaceFormat::stereo() const

{

    return testOption(QSurfaceFormat::StereoBuffers);

}

QT_END_NAMESPACE

#endif //QSURFACEFORMAT_H