/src/qtbase/src/gui/kernel/qsurface.cpp

Source
// 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
// Qt-Security score:significant reason:default

#include "qsurface.h"
#include "qopenglcontext.h"
#include <qpa/qplatformintegration.h>
#include <QtGui/private/qguiapplication_p.h>

QT_BEGIN_NAMESPACE

QT_IMPL_METATYPE_EXTERN_TAGGED(QSurface*, QSurface_ptr)

/*!
    \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 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 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 only supported
    on \macos and iOS.
    \value Direct3DSurface The surface is a Direct 3D 11 and 12 compatible
    surface and can be used in conjunction with the DXGI and Direct3D APIs. This
    surface type is only supported on Windows.

    \omitvalue RasterGLSurface
 */

/*!
    \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
{
    static bool openGLOnRasterSurfaceSupported =
        QGuiApplicationPrivate::instance()->platformIntegration()->hasCapability(QPlatformIntegration::OpenGLOnRasterSurface);
    return surfaceType() == OpenGLSurface
           || (surfaceType() == RasterSurface && openGLOnRasterSurfaceSupported);
}

/*!
    \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(nullptr)
{
}

/*!
    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

#include "moc_qsurface.cpp"


Line	Count	Source
1		// Copyright (C) 2016 The Qt Company Ltd.
2		// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
3		// Qt-Security score:significant reason:default
4
5		#include "qsurface.h"
6		#include "qopenglcontext.h"
7		#include <qpa/qplatformintegration.h>
8		#include <QtGui/private/qguiapplication_p.h>
9
10		QT_BEGIN_NAMESPACE
11
12		QT_IMPL_METATYPE_EXTERN_TAGGED(QSurface*, QSurface_ptr)
13
14		/*!
15		\class QSurface
16		\inmodule QtGui
17		\since 5.0
18		\brief The QSurface class is an abstraction of renderable surfaces in Qt.
19
20		The size of the surface is accessible with the size() function. The rendering
21		specific attributes of the surface are accessible through the format() function.
22		*/
23
24
25		/*!
26		\enum QSurface::SurfaceClass
27
28		The SurfaceClass enum describes the actual subclass of the surface.
29
30		\value Window The surface is an instance of QWindow.
31		\value Offscreen The surface is an instance of QOffscreenSurface.
32		*/
33
34		/*!
35		\enum QSurface::SurfaceType
36
37		The SurfaceType enum describes what type of surface this is.
38
39		\value RasterSurface The surface is composed of pixels and can be rendered to using
40		a software rasterizer like Qt's raster paint engine.
41		\value OpenGLSurface The surface is an OpenGL compatible surface and can be used
42		in conjunction with QOpenGLContext.
43		\value OpenVGSurface The surface is an OpenVG compatible surface and can be used
44		in conjunction with OpenVG contexts.
45		\value VulkanSurface The surface is a Vulkan compatible surface and can be used
46		in conjunction with the Vulkan graphics API.
47		\value MetalSurface The surface is a Metal compatible surface and can be used
48		in conjunction with Apple's Metal graphics API. This surface type is only supported
49		on \macos and iOS.
50		\value Direct3DSurface The surface is a Direct 3D 11 and 12 compatible
51		surface and can be used in conjunction with the DXGI and Direct3D APIs. This
52		surface type is only supported on Windows.
53
54		\omitvalue RasterGLSurface
55		*/
56
57		/*!
58		\fn QSurfaceFormat QSurface::format() const
59
60		Returns the format of the surface.
61		*/
62
63		/*!
64		Returns true if the surface is OpenGL compatible and can be used in
65		conjunction with QOpenGLContext; otherwise returns false.
66
67		\since 5.3
68		*/
69
70		bool QSurface::supportsOpenGL() const
71	0	{
72	0	static bool openGLOnRasterSurfaceSupported =
73	0	QGuiApplicationPrivate::instance()->platformIntegration()->hasCapability(QPlatformIntegration::OpenGLOnRasterSurface);
74	0	return surfaceType() == OpenGLSurface
75	0	\|\| (surfaceType() == RasterSurface && openGLOnRasterSurfaceSupported);
76	0	}
77
78		/*!
79		\fn QPlatformSurface *QSurface::surfaceHandle() const
80
81		Returns a handle to the platform-specific implementation of the surface.
82		*/
83
84		/*!
85		\fn SurfaceType QSurface::surfaceType() const
86
87		Returns the type of the surface.
88		*/
89
90		/*!
91		\fn QSize QSurface::size() const
92
93		Returns the size of the surface in pixels.
94		*/
95
96		/*!
97		Creates a surface with the given \a type.
98		*/
99		QSurface::QSurface(SurfaceClass type)
100	0	: m_type(type), m_reserved(nullptr)
101	0	{
102	0	}
103
104		/*!
105		Destroys the surface.
106		*/
107		QSurface::~QSurface()
108	0	{
109		#ifndef QT_NO_OPENGL
110		QOpenGLContext *context = QOpenGLContext::currentContext();
111		if (context && context->surface() == this)
112		context->doneCurrent();
113		#endif
114	0	}
115
116		/*!
117		Returns the surface class of this surface.
118		*/
119		QSurface::SurfaceClass QSurface::surfaceClass() const
120	0	{
121	0	return m_type;
122	0	}
123
124		QT_END_NAMESPACE
125
126		#include "moc_qsurface.cpp"
127

Coverage Report

Created: 2026-05-31 06:50