#include <mousemark.h>

Inheritance diagram for KWin::MouseMarkEffect:

Public Member Functions
	MouseMarkEffect ()

	~MouseMarkEffect () override

void	reconfigure (ReconfigureFlags) override

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

bool	isActive () const override

int	requestedEffectChainPosition () const override

int	configuredWidth () const

QColor	configuredColor () const

Qt::KeyboardModifiers	freedraw_modifiers () const

Qt::KeyboardModifiers	arrowdraw_modifiers () const

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

	~Effect () override

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

virtual void	postPaintScreen ()

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 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
int	width

QColor	color

Qt::KeyboardModifiers	modifiers

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 19 of file mousemark.h.

Constructor & Destructor Documentation

◆ MouseMarkEffect()

KWin::MouseMarkEffect::MouseMarkEffect ( )

Definition at line 38 of file mousemark.cpp.

◆ ~MouseMarkEffect()

KWin::MouseMarkEffect::~MouseMarkEffect ( )

override

Definition at line 61 of file mousemark.cpp.

Member Function Documentation

◆ arrowdraw_modifiers()

Qt::KeyboardModifiers KWin::MouseMarkEffect::arrowdraw_modifiers ( ) const

inline

Definition at line 48 of file mousemark.h.

◆ configuredColor()

QColor KWin::MouseMarkEffect::configuredColor ( ) const

inline

Definition at line 40 of file mousemark.h.

◆ configuredWidth()

int KWin::MouseMarkEffect::configuredWidth ( ) const

inline

Definition at line 36 of file mousemark.h.

◆ freedraw_modifiers()

Qt::KeyboardModifiers KWin::MouseMarkEffect::freedraw_modifiers ( ) const

inline

Definition at line 44 of file mousemark.h.

◆ isActive()

bool KWin::MouseMarkEffect::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 268 of file mousemark.cpp.

◆ paintScreen()

void KWin::MouseMarkEffect::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 103 of file mousemark.cpp.

◆ reconfigure()

void KWin::MouseMarkEffect::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 67 of file mousemark.cpp.

◆ requestedEffectChainPosition()

int KWin::MouseMarkEffect::requestedEffectChainPosition ( ) const

overridevirtual

Reimplement this method to indicate where in the Effect chain the Effect should be placed.

A low number indicates early chain position, thus before other Effects got called, a high number indicates a late position. The returned number should be in the interval [0, 100]. The default value is 0.

In KWin4 this information was provided in the Effect's desktop file as property X-KDE-Ordering. In the case of Scripted Effects this property is still used.

Since: 5.0

Reimplemented from KWin::Effect.

Definition at line 273 of file mousemark.cpp.

Property Documentation

◆ color

QColor KWin::MouseMarkEffect::color

read

Definition at line 24 of file mousemark.h.

◆ modifiers

Qt::KeyboardModifiers KWin::MouseMarkEffect::modifiers

read

Definition at line 25 of file mousemark.h.

◆ width

int KWin::MouseMarkEffect::width

read

Definition at line 23 of file mousemark.h.

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

src/plugins/mousemark/mousemark.h
src/plugins/mousemark/mousemark.cpp

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MouseMarkEffect()

◆ ~MouseMarkEffect()

Member Function Documentation

◆ arrowdraw_modifiers()

◆ configuredColor()

◆ configuredWidth()

◆ freedraw_modifiers()

◆ isActive()

◆ paintScreen()

◆ reconfigure()

◆ requestedEffectChainPosition()

Property Documentation

◆ color

◆ modifiers

◆ width