The QWaylandSurface class represents a rectangular area on an output device. 更多...
| 頭： | #include <QWaylandSurface> |
| qmake: | QT += waylandcompositor |
| Since: | Qt 5.8 |
| 實例化： | WaylandSurface |
| 繼承： | QWaylandObject |
該類在 Qt 5.8 引入。
| enum | Origin { OriginTopLeft, OriginBottomLeft } |
|
|
| QWaylandSurface (QWaylandCompositor * compositor , QWaylandClient * client , uint id , int version ) | |
| QWaylandSurface () | |
| virtual | ~QWaylandSurface () override |
| int | bufferScale () const |
| QSize | bufferSize () const |
| QWaylandClient * | client () const |
| QWaylandCompositor * | compositor () const |
| Qt::ScreenOrientation | contentOrientation () const |
| QSize | destinationSize () const |
| void | destroy () |
| void | frameStarted () |
| bool | hasContent () const |
| bool | inhibitsIdle () const |
| void | initialize (QWaylandCompositor * compositor , QWaylandClient * client , uint id , int version ) |
| bool | inputRegionContains (const QPoint & p ) const |
| bool | inputRegionContains (const QPointF & position ) const |
| bool | isCursorSurface () const |
| bool | isDestroyed () const |
| bool | isInitialized () const |
| void | markAsCursorSurface (bool cursorSurface ) |
| QWaylandSurface::Origin | origin () const |
| QWaylandView * | primaryView () const |
| struct wl_resource * | resource () const |
| void | sendFrameCallbacks () |
| void | setPrimaryView (QWaylandView * view ) |
| bool | setRole (QWaylandSurfaceRole * role , wl_resource * errorResource , uint32_t errorCode ) |
| QRectF | sourceGeometry () const |
| QList<QWaylandView *> | views () const |
| ::wl_client * | waylandClient () const |
| void | updateSelection () |
| void | bufferScaleChanged () |
| void | bufferSizeChanged () |
| void | childAdded (QWaylandSurface * child ) |
| void | contentOrientationChanged () |
| void | cursorSurfaceChanged () |
| void | destinationSizeChanged () |
| void | dragStarted (QWaylandDrag * drag ) |
| void | hasContentChanged () |
| void | inhibitsIdleChanged () |
| void | originChanged () |
| void | sourceGeometryChanged () |
| void | surfaceDestroyed () |
| QWaylandSurface * | fromResource (::wl_resource * resource ) |
This class encapsulates a rectangular area of pixels that is displayed on an output device. It corresponds to the interface
wl_surface
in the Wayland protocol.
This enum type is used to specify the origin of a QWaylandSurface 's buffer.
| 常量 | 值 | 描述 |
|---|---|---|
QWaylandSurface::OriginTopLeft
|
0
|
The origin is the top left corner of the buffer. |
QWaylandSurface::OriginBottomLeft
|
1
|
The origin is the bottom left corner of the buffer. |
此特性保持 QWaylandSurface 's buffer scale. The buffer scale lets a client supply higher resolution buffer data for use on high resolution outputs.
訪問函數：
| int | bufferScale () const |
通知程序信號：
| void | bufferScaleChanged () |
This property holds the size of the current buffer of this QWaylandSurface in pixels, not in surface coordinates.
For the size in surface coordinates, use destinationSize 代替。
訪問函數：
| QSize | bufferSize () const |
通知程序信號：
| void | bufferSizeChanged () |
另請參閱 destinationSize and bufferScale .
This property holds the client using this QWaylandSurface .
訪問函數：
| QWaylandClient * | client () const |
This property holds the orientation of the QWaylandSurface 's contents.
訪問函數：
| Qt::ScreenOrientation | contentOrientation () const |
通知程序信號：
| void | contentOrientationChanged () |
另請參閱 QWaylandOutput::transform .
This property holds whether the QWaylandSurface is a cursor surface.
訪問函數：
| bool | isCursorSurface () const |
| void | markAsCursorSurface (bool cursorSurface ) |
通知程序信號：
| void | cursorSurfaceChanged () |
This property holds the size of this WaylandSurface in surface coordinates.
該特性在 Qt 5.13 引入。
訪問函數：
| QSize | destinationSize () const |
通知程序信號：
| void | destinationSizeChanged () |
另請參閱 bufferScale and bufferSize .
This property holds whether the QWaylandSurface has content.
訪問函數：
| bool | hasContent () const |
通知程序信號：
| void | hasContentChanged () |
This property holds whether this surface is intended to inhibit the idle behavior of the compositor such as screen blanking, locking and screen saving.
該特性在 Qt 5.14 引入。
訪問函數：
| bool | inhibitsIdle () const |
通知程序信號：
| void | inhibitsIdleChanged () |
另請參閱 QWaylandIdleInhibitManagerV1 .
This property holds the origin of the QWaylandSurface 's buffer, or QWaylandSurface::OriginTopLeft if the surface has no buffer.
訪問函數：
| QWaylandSurface::Origin | origin () const |
通知程序信號：
| void | originChanged () |
This property describes the portion of the attached QWaylandBuffer that should be drawn on the screen. The coordinates are from the corner of the buffer and are scaled by bufferScale .
該特性在 Qt 5.13 引入。
訪問函數：
| QRectF | sourceGeometry () const |
通知程序信號：
| void | sourceGeometryChanged () |
另請參閱 bufferScale , bufferSize ，和 destinationSize .
Constructs and initializes a QWaylandSurface for the given compositor and client ，和采用給定 id and version .
Constructs a an uninitialized QWaylandSurface.
[signal]
void
QWaylandSurface::
childAdded
(
QWaylandSurface
*
child
)
This signal is emitted when a wl_subsurface, child , has been added to the surface.
[signal]
void
QWaylandSurface::
dragStarted
(
QWaylandDrag
*
drag
)
This signal is emitted when a drag has started from this surface.
[signal]
void
QWaylandSurface::
surfaceDestroyed
()
This signal is emitted when the corresponing wl_surface is destroyed.
[slot]
void
QWaylandSurface::
updateSelection
()
Updates the surface with the compositor's retained clipboard selection. Although this is done automatically when the surface receives keyboard focus, this function is useful for updating clients which do not have keyboard focus.
[override virtual]
QWaylandSurface::
~QWaylandSurface
()
銷毀 QWaylandSurface .
Returns the compositor for this QWaylandSurface .
銷毀 QWaylandSurface .
注意： 此函數可以被援引，通過元對象係統和從 QML。見 Q_INVOKABLE .
Prepares all frame callbacks for sending.
注意： 此函數可以被援引，通過元對象係統和從 QML。見 Q_INVOKABLE .
[static]
QWaylandSurface
*QWaylandSurface::
fromResource
(
::wl_resource
*
resource
)
返迴 QWaylandSurface corresponding to the Wayland resource resource .
初始化 QWaylandSurface 采用給定 compositor and client ，和采用給定 id and version .
注意： 此函數可以被援引，通過元對象係統和從 QML。見 Q_INVOKABLE .
返迴
true
若
QWaylandSurface
's input region contains the point
p
. Otherwise returns
false
.
返迴
true
若
QWaylandSurface
's input region contains the point
position
. Otherwise returns
false
.
該函數在 Qt 5.14 引入。
返迴 true 若 QWaylandSurface has been destroyed. Otherwise returns false.
注意： 此函數可以被援引，通過元對象係統和從 QML。見 Q_INVOKABLE .
返迴 true 若 QWaylandSurface has been initialized.
Returns this QWaylandSurface 's primary view.
另請參閱 QWaylandView::advance () 和 QWaylandSurface::setPrimaryView ().
Returns the Wayland resource corresponding to this QWaylandSurface .
Sends pending frame callbacks.
注意： 此函數可以被援引，通過元對象係統和從 QML。見 Q_INVOKABLE .
設置此 QWaylandSurface 's primary view to view , in case there are multiple views of this surface. The primary view is the view that governs the client's refresh rate. It takes care of discarding buffer references when QWaylandView::advance () is called. See the documentation for QWaylandView::advance () 瞭解更多細節。
In shell surface integrations, such as QWaylandWlShellIntegration and QWaylandXdgShellV5Integration, maximize and fullscreen requests from the client will only have an effect if the integration has the primary view of the surface.
另請參閱 primaryView () 和 QWaylandView::advance ().
設置 role on the surface. A role defines how a surface will be mapped on screen; without a role a surface is supposed to be hidden. Only one role can be set on a surface, at all times. Although setting the same role many times is allowed, attempting to change the role of a surface will trigger a protocol error to the errorResource and send an errorCode to the client.
Returns true if a role can be assigned; false otherwise.
Returns the views for this QWaylandSurface .
保持
wl_client
using this
QWaylandSurface
.