KWin::SubSurfaceInterface Class Reference

#include <subcompositor.h>

Inheritance diagram for KWin::SubSurfaceInterface:

Public Types
enum class	Mode { Synchronized , Desynchronized }

Signals
void	positionChanged (const QPoint &position)
void	modeChanged (KWin::SubSurfaceInterface::Mode mode)

Public Member Functions
	~SubSurfaceInterface () override
QPoint	position () const
Mode	mode () const
bool	isSynchronized () const
SurfaceInterface *	surface () const
SurfaceInterface *	parentSurface () const
SurfaceInterface *	mainSurface () const

Static Public Member Functions
static SurfaceRole *	role ()

Friends
class	SurfaceInterfacePrivate
class	SubSurfaceInterfacePrivate
class	SubCompositorInterfacePrivate

Detailed Description

The SubSurfaceInterface corresponds to the Wayland interface wl_subsurface.

Definition at line 54 of file subcompositor.h.

Member Enumeration Documentation

Mode

enum class KWin::SubSurfaceInterface::Mode

strong

This enum type is used to specify the commit behavior for a subsurface.

Enumerator
Synchronized
Desynchronized

Definition at line 71 of file subcompositor.h.

Constructor & Destructor Documentation

~SubSurfaceInterface()

KWin::SubSurfaceInterface::~SubSurfaceInterface ( )

override

Definition at line 189 of file subcompositor.cpp.

Member Function Documentation

isSynchronized()

bool KWin::SubSurfaceInterface::isSynchronized

(

)

const

Returns true if the sub-surface is in synchronized mode; otherwise returns false.

This method checks whether this sub-surface or any of its ancestors is in the synchronized mode. Note that this function is not equivalent to calling mode() and checking whether the return value is Mode::Synchronized.

See also

mode

Definition at line 228 of file subcompositor.cpp.

mainSurface()

SurfaceInterface * KWin::SubSurfaceInterface::mainSurface

(

)

const

Returns the main surface for the sub-surface tree, that is the first surface without a parent

Definition at line 245 of file subcompositor.cpp.

mode()

SubSurfaceInterface::Mode KWin::SubSurfaceInterface::mode

(

)

const

Returns the current commit mode.

See also

isSynchronized

Definition at line 223 of file subcompositor.cpp.

modeChanged

void KWin::SubSurfaceInterface::modeChanged ( KWin::SubSurfaceInterface::Mode mode )

signal

This signal is emitted when the commit mode of the sub-surface has changed.

parentSurface()

SurfaceInterface * KWin::SubSurfaceInterface::parentSurface

(

)

const

Returns the parent surface for this SubSurfaceInterface. This function may return null.

Definition at line 218 of file subcompositor.cpp.

position()

QPoint KWin::SubSurfaceInterface::position

(

)

const

Returns the position of the sub-surface relative to the upper-left corner of its parent.

Definition at line 208 of file subcompositor.cpp.

positionChanged

void KWin::SubSurfaceInterface::positionChanged ( const QPoint & position )

signal

This signal is emitted when the position of the sub-surface has changed.

role()

SurfaceRole * KWin::SubSurfaceInterface::role ( )

static

Definition at line 202 of file subcompositor.cpp.

surface()

SurfaceInterface * KWin::SubSurfaceInterface::surface

(

)

const

Returns the SurfaceInterface for this SubSurfaceInterface. This function never returns a null.

Definition at line 213 of file subcompositor.cpp.

Friends And Related Symbol Documentation

SubCompositorInterfacePrivate

friend class SubCompositorInterfacePrivate

friend

Definition at line 129 of file subcompositor.h.

SubSurfaceInterfacePrivate

friend class SubSurfaceInterfacePrivate

friend

Definition at line 128 of file subcompositor.h.

SurfaceInterfacePrivate

friend class SurfaceInterfacePrivate

friend

Definition at line 127 of file subcompositor.h.

---

The documentation for this class was generated from the following files:

• src/wayland/subcompositor.h
• src/wayland/subcompositor.cpp