qoffscreensurface.h

Go to the documentation of this file.

/****************************************************************************
**
** Copyright (C) 2020 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtGui module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
 
#ifndef QOFFSCREENSURFACE_H
#define QOFFSCREENSURFACE_H
 
#include <QtGui/qtguiglobal.h>
#include <QtCore/QObject>
#include <QtCore/qnativeinterface.h>
#include <QtGui/qsurface.h>
Q_MOC_INCLUDE(<QScreen>)
 
QT_BEGIN_NAMESPACE
 
class QOffscreenSurfacePrivate;
 
class QScreen;
class QPlatformOffscreenSurface;
 
class Q_GUI_EXPORT QOffscreenSurface : public QObject, public QSurface
{
    Q_OBJECT
    Q_DECLARE_PRIVATE(QOffscreenSurface)
 
public:
    explicit QOffscreenSurface(QScreen *screen = nullptr, QObject *parent = nullptr);
    ~QOffscreenSurface();
 
    SurfaceType surfaceType() const override;
 
    void create();
    void destroy();
 
    bool isValid() const;
 
    void setFormat(const QSurfaceFormat &format);
    QSurfaceFormat format() const override;
    QSurfaceFormat requestedFormat() const;
 
    QSize size() const override;
 
    QScreen *screen() const;
    void setScreen(QScreen *screen);
 
    QPlatformOffscreenSurface *handle() const;
 
    QT_DECLARE_NATIVE_INTERFACE_ACCESSOR(QOffscreenSurface)
 
Q_SIGNALS:
    void screenChanged(QScreen *screen);
 
private Q_SLOTS:
    void screenDestroyed(QObject *screen);
 
private:
 
    QPlatformSurface *surfaceHandle() const override;
 
    Q_DISABLE_COPY(QOffscreenSurface)
};
 
QT_END_NAMESPACE
 
#include <QtGui/qoffscreensurface_platform.h>
 
#endif // QOFFSCREENSURFACE_H