#include <trackmouse.h>

Inheritance diagram for KWin::TrackMouseEffect:

Public Member Functions
	TrackMouseEffect ()

	~TrackMouseEffect () override

void	prePaintScreen (ScreenPrePaintData &data, std::chrono::milliseconds presentTime) override

void	paintScreen (const RenderTarget &renderTarget, const RenderViewport &viewport, int mask, const QRegion &region, Output *screen) override

void	postPaintScreen () override

void	reconfigure (ReconfigureFlags) override

bool	isActive () const override

Qt::KeyboardModifiers	modifiers () const

bool	isMousePolling () const

Public Member Functions inherited from KWin::Effect
	Effect (QObject *parent=nullptr)

	~Effect () override

virtual void	prePaintWindow (EffectWindow *w, WindowPrePaintData &data, std::chrono::milliseconds presentTime)

virtual void	paintWindow (const RenderTarget &renderTarget, const RenderViewport &viewport, EffectWindow *w, int mask, QRegion region, WindowPaintData &data)

virtual void	postPaintWindow (EffectWindow *w)

virtual bool	provides (Feature)

virtual bool	perform (Feature feature, const QVariantList &arguments)

virtual void	drawWindow (const RenderTarget &renderTarget, const RenderViewport &viewport, EffectWindow *w, int mask, const QRegion &region, WindowPaintData &data)

virtual void	windowInputMouseEvent (QEvent *e)

virtual void	grabbedKeyboardEvent (QKeyEvent *e)

virtual QString	debug (const QString &parameter) const

virtual int	requestedEffectChainPosition () const

virtual bool	touchDown (qint32 id, const QPointF &pos, std::chrono::microseconds time)

virtual bool	touchMotion (qint32 id, const QPointF &pos, std::chrono::microseconds time)

virtual bool	touchUp (qint32 id, std::chrono::microseconds time)

virtual bool	tabletToolEvent (QTabletEvent *event)

virtual bool	tabletToolButtonEvent (uint button, bool pressed, quint64 tabletToolId)

virtual bool	tabletPadButtonEvent (uint button, bool pressed, void *tabletPadId)

virtual bool	tabletPadStripEvent (int number, int position, bool isFinger, void *tabletPadId)

virtual bool	tabletPadRingEvent (int number, int position, bool isFinger, void *tabletPadId)

template<typename T >
int	animationTime (int defaultDuration)

virtual bool	blocksDirectScanout () const

Properties
Qt::KeyboardModifiers	modifiers

bool	mousePolling

Additional Inherited Members
Public Types inherited from KWin::Effect
enum	{ PAINT_WINDOW_OPAQUE = 1 << 0 , PAINT_WINDOW_TRANSLUCENT = 1 << 1 , PAINT_WINDOW_TRANSFORMED = 1 << 2 , PAINT_SCREEN_REGION = 1 << 3 , PAINT_SCREEN_TRANSFORMED = 1 << 4 , PAINT_SCREEN_WITH_TRANSFORMED_WINDOWS = 1 << 5 , PAINT_SCREEN_BACKGROUND_FIRST = 1 << 6 }

enum	Feature { Nothing = 0 , ScreenInversion , Blur , Contrast , HighlightWindows }

enum	ReconfigureFlag { ReconfigureAll = 1 << 0 }

Public Slots inherited from KWin::Effect
virtual bool	borderActivated (ElectricBorder border)

Static Public Member Functions inherited from KWin::Effect
static QPointF	cursorPos ()

static double	animationTime (const KConfigGroup &cfg, const QString &key, int defaultTime)

static double	animationTime (int defaultTime)

static double	interpolate (double x, double y, double a)

static void	setPositionTransformations (WindowPaintData &data, QRect &region, EffectWindow *w, const QRect &r, Qt::AspectRatioMode aspect)

Detailed Description

Definition at line 22 of file trackmouse.h.

Constructor & Destructor Documentation

◆ TrackMouseEffect()

KWin::TrackMouseEffect::TrackMouseEffect ( )

Definition at line 35 of file trackmouse.cpp.

◆ ~TrackMouseEffect()

KWin::TrackMouseEffect::~TrackMouseEffect ( )

override

Definition at line 56 of file trackmouse.cpp.

Member Function Documentation

◆ isActive()

bool KWin::TrackMouseEffect::isActive ( ) const

overridevirtual

Overwrite this method to indicate whether your effect will be doing something in the next frame to be rendered. If the method returns false the effect will be excluded from the chained methods in the next rendered frame.

This method is called always directly before the paint loop begins. So it is totally fine to e.g. react on a window event, issue a repaint to trigger an animation and change a flag to indicate that this method returns true.

As the method is called each frame, you should not perform complex calculations. Best use just a boolean flag.

The default implementation of this method returns true.

Since: 4.8

Reimplemented from KWin::Effect.

Definition at line 249 of file trackmouse.cpp.

◆ isMousePolling()

bool KWin::TrackMouseEffect::isMousePolling ( ) const

inline

Definition at line 42 of file trackmouse.h.

◆ modifiers()

Qt::KeyboardModifiers KWin::TrackMouseEffect::modifiers ( ) const

inline

Definition at line 38 of file trackmouse.h.

◆ paintScreen()

void KWin::TrackMouseEffect::paintScreen	(	const RenderTarget &	renderTarget,
		const RenderViewport &	viewport,
		int	mask,
		const QRegion &	region,
		Output *	screen )

overridevirtual

In this method you can:

paint something on top of the windows (by painting after calling effects->paintScreen())
paint multiple desktops and/or multiple copies of the same desktop by calling effects->paintScreen() multiple times

In OpenGL based compositing, the frameworks ensures that the context is current when this method is invoked.

Reimplemented from KWin::Effect.

Definition at line 102 of file trackmouse.cpp.

◆ postPaintScreen()

void KWin::TrackMouseEffect::postPaintScreen ( )

overridevirtual

Called after all the painting has been finished. In this method you can:

schedule next repaint in case of animations You shouldn't paint anything here.

In OpenGL based compositing, the frameworks ensures that the context is current when this method is invoked.

Reimplemented from KWin::Effect.

Definition at line 144 of file trackmouse.cpp.

◆ prePaintScreen()

void KWin::TrackMouseEffect::prePaintScreen	(	ScreenPrePaintData &	data,
		std::chrono::milliseconds	presentTime )

overridevirtual

Called before starting to paint the screen. In this method you can:

set whether the windows or the entire screen will be transformed
change the region of the screen that will be painted
do various housekeeping tasks such as initing your effect's variables for the upcoming paint pass or updating animation's progress

presentTime specifies the expected monotonic time when the rendered frame will be displayed on the screen.

Reimplemented from KWin::Effect.

Definition at line 91 of file trackmouse.cpp.

◆ reconfigure()

void KWin::TrackMouseEffect::reconfigure ( ReconfigureFlags flags )

overridevirtual

Called when configuration changes (either the effect's or KWin's global).

In OpenGL based compositing, the frameworks ensures that the context is current when the Effect is reconfigured. If this method is called from within the Effect it is required to ensure that the context is current if the implementation does OpenGL calls.

Reimplemented from KWin::Effect.

Definition at line 63 of file trackmouse.cpp.

Property Documentation

◆ modifiers

Qt::KeyboardModifiers KWin::TrackMouseEffect::modifiers

read

Definition at line 26 of file trackmouse.h.

◆ mousePolling

bool KWin::TrackMouseEffect::mousePolling

read

Definition at line 27 of file trackmouse.h.

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

src/plugins/trackmouse/trackmouse.h
src/plugins/trackmouse/trackmouse.cpp

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TrackMouseEffect()

◆ ~TrackMouseEffect()

Member Function Documentation

◆ isActive()

◆ isMousePolling()

◆ modifiers()

◆ paintScreen()

◆ postPaintScreen()

◆ prePaintScreen()

◆ reconfigure()

Property Documentation

◆ modifiers

◆ mousePolling