#include <thumbnailaside.h>

Inheritance diagram for KWin::ThumbnailAsideEffect:

Public Member Functions
	ThumbnailAsideEffect ()

void	reconfigure (ReconfigureFlags) override

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

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

int	configuredMaxWidth () const

int	configuredSpacing () const

qreal	configuredOpacity () const

int	configuredScreen () const

bool	isActive () const override

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

int	spacing

qreal	opacity

int	screen

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 26 of file thumbnailaside.h.

Constructor & Destructor Documentation

◆ ThumbnailAsideEffect()

KWin::ThumbnailAsideEffect::ThumbnailAsideEffect ( )

Definition at line 26 of file thumbnailaside.cpp.

Member Function Documentation

◆ configuredMaxWidth()

int KWin::ThumbnailAsideEffect::configuredMaxWidth ( ) const

inline

Definition at line 41 of file thumbnailaside.h.

◆ configuredOpacity()

qreal KWin::ThumbnailAsideEffect::configuredOpacity ( ) const

inline

Definition at line 49 of file thumbnailaside.h.

◆ configuredScreen()

int KWin::ThumbnailAsideEffect::configuredScreen ( ) const

inline

Definition at line 53 of file thumbnailaside.h.

◆ configuredSpacing()

int KWin::ThumbnailAsideEffect::configuredSpacing ( ) const

inline

Definition at line 45 of file thumbnailaside.h.

◆ isActive()

bool KWin::ThumbnailAsideEffect::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 201 of file thumbnailaside.cpp.

◆ paintScreen()

void KWin::ThumbnailAsideEffect::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 58 of file thumbnailaside.cpp.

◆ paintWindow()

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

overridevirtual

This is the main method for painting windows. In this method you can:

do various transformations
change opacity of the window
change brightness and/or saturation, if it's supported

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

Reimplemented from KWin::Effect.

Definition at line 74 of file thumbnailaside.cpp.

◆ reconfigure()

void KWin::ThumbnailAsideEffect::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 48 of file thumbnailaside.cpp.

Property Documentation

◆ maxWidth

int KWin::ThumbnailAsideEffect::maxWidth

read

Definition at line 30 of file thumbnailaside.h.

◆ opacity

qreal KWin::ThumbnailAsideEffect::opacity

read

Definition at line 32 of file thumbnailaside.h.

◆ screen

int KWin::ThumbnailAsideEffect::screen

read

Definition at line 33 of file thumbnailaside.h.

◆ spacing

int KWin::ThumbnailAsideEffect::spacing

read

Definition at line 31 of file thumbnailaside.h.

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

src/plugins/thumbnailaside/thumbnailaside.h
src/plugins/thumbnailaside/thumbnailaside.cpp

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ThumbnailAsideEffect()

Member Function Documentation

◆ configuredMaxWidth()

◆ configuredOpacity()

◆ configuredScreen()

◆ configuredSpacing()

◆ isActive()

◆ paintScreen()

◆ paintWindow()

◆ reconfigure()

Property Documentation

◆ maxWidth

◆ opacity

◆ screen

◆ spacing