| /**************************************************************************** |
| ** |
| ** Copyright (C) 2016 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$ |
| ** |
| ****************************************************************************/ |
| |
| #include "qsurface.h" |
| #include "qopenglcontext.h" |
| #include <qpa/qplatformintegration.h> |
| #include <QtGui/private/qguiapplication_p.h> |
| |
| QT_BEGIN_NAMESPACE |
| |
| |
| /*! |
| \class QSurface |
| \inmodule QtGui |
| \since 5.0 |
| \brief The QSurface class is an abstraction of renderable surfaces in Qt. |
| |
| The size of the surface is accessible with the size() function. The rendering |
| specific attributes of the surface are accessible through the format() function. |
| */ |
| |
| |
| /*! |
| \enum QSurface::SurfaceClass |
| |
| The SurfaceClass enum describes the actual subclass of the surface. |
| |
| \value Window The surface is an instance of QWindow. |
| \value Offscreen The surface is an instance of QOffscreenSurface. |
| */ |
| |
| |
| /*! |
| \enum QSurface::SurfaceType |
| |
| The SurfaceType enum describes what type of surface this is. |
| |
| \value RasterSurface The surface is is composed of pixels and can be rendered to using |
| a software rasterizer like Qt's raster paint engine. |
| \value OpenGLSurface The surface is an OpenGL compatible surface and can be used |
| in conjunction with QOpenGLContext. |
| \value RasterGLSurface The surface can be rendered to using a software rasterizer, |
| and also supports OpenGL. This surface type is intended for internal Qt use, and |
| requires the use of private API. |
| \value OpenVGSurface The surface is an OpenVG compatible surface and can be used |
| in conjunction with OpenVG contexts. |
| \value VulkanSurface The surface is a Vulkan compatible surface and can be used |
| in conjunction with the Vulkan graphics API. |
| \value MetalSurface The surface is a Metal compatible surface and can be used |
| in conjunction with Apple's Metal graphics API. This surface type is supported |
| on macOS only. |
| |
| */ |
| |
| |
| /*! |
| \fn QSurfaceFormat QSurface::format() const |
| |
| Returns the format of the surface. |
| */ |
| |
| /*! |
| Returns true if the surface is OpenGL compatible and can be used in |
| conjunction with QOpenGLContext; otherwise returns false. |
| |
| \since 5.3 |
| */ |
| |
| bool QSurface::supportsOpenGL() const |
| { |
| SurfaceType type = surfaceType(); |
| if (type == RasterSurface) { |
| QPlatformIntegration *integ = QGuiApplicationPrivate::instance()->platformIntegration(); |
| return integ->hasCapability(QPlatformIntegration::OpenGLOnRasterSurface); |
| } |
| return type == OpenGLSurface || type == RasterGLSurface; |
| } |
| |
| /*! |
| \fn QPlatformSurface *QSurface::surfaceHandle() const |
| |
| Returns a handle to the platform-specific implementation of the surface. |
| */ |
| |
| /*! |
| \fn SurfaceType QSurface::surfaceType() const |
| |
| Returns the type of the surface. |
| */ |
| |
| /*! |
| \fn QSize QSurface::size() const |
| |
| Returns the size of the surface in pixels. |
| */ |
| |
| /*! |
| Creates a surface with the given \a type. |
| */ |
| QSurface::QSurface(SurfaceClass type) |
| : m_type(type), m_reserved(0) |
| { |
| } |
| |
| /*! |
| Destroys the surface. |
| */ |
| QSurface::~QSurface() |
| { |
| #ifndef QT_NO_OPENGL |
| QOpenGLContext *context = QOpenGLContext::currentContext(); |
| if (context && context->surface() == this) |
| context->doneCurrent(); |
| #endif |
| } |
| |
| /*! |
| Returns the surface class of this surface. |
| */ |
| QSurface::SurfaceClass QSurface::surfaceClass() const |
| { |
| return m_type; |
| } |
| |
| QT_END_NAMESPACE |
| |