#include <slideback.h>

Inheritance diagram for KWin::SlideBackEffect:

Public Slots
void	slotWindowAdded (KWin::EffectWindow *w)

void	slotWindowDeleted (KWin::EffectWindow *w)

void	slotWindowUnminimized (KWin::EffectWindow *w)

void	slotStackingOrderChanged ()

void	slotTabBoxAdded ()

void	slotTabBoxClosed ()

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

Public Member Functions
	SlideBackEffect ()

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

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

void	postPaintWindow (EffectWindow *w) override

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

void	postPaintScreen () override

bool	isActive () const override

int	requestedEffectChainPosition () const override

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

	~Effect () override

virtual void	reconfigure (ReconfigureFlags flags)

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

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

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 }

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 slideback.h.

Constructor & Destructor Documentation

◆ SlideBackEffect()

KWin::SlideBackEffect::SlideBackEffect ( )

Definition at line 16 of file slideback.cpp.

Member Function Documentation

◆ isActive()

bool KWin::SlideBackEffect::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 345 of file slideback.cpp.

◆ paintWindow()

void KWin::SlideBackEffect::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 176 of file slideback.cpp.

◆ postPaintScreen()

void KWin::SlideBackEffect::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 154 of file slideback.cpp.

◆ postPaintWindow()

void KWin::SlideBackEffect::postPaintWindow ( EffectWindow * w )

overridevirtual

Called for every window after all painting has been finished. In this method you can:

schedule next repaint for individual window(s) 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 188 of file slideback.cpp.

◆ prePaintScreen()

void KWin::SlideBackEffect::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 133 of file slideback.cpp.

◆ prePaintWindow()

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

overridevirtual

Called for every window before the actual paint pass In this method you can:

enable or disable painting of the window (e.g. enable paiting of minimized window)
set window to be painted with translucency
set window to be transformed
request the window to be divided into multiple parts

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

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

Reimplemented from KWin::Effect.

Definition at line 167 of file slideback.cpp.

◆ requestedEffectChainPosition()

int KWin::SlideBackEffect::requestedEffectChainPosition ( ) const

inlineoverridevirtual

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 34 of file slideback.h.

◆ slotStackingOrderChanged

void KWin::SlideBackEffect::slotStackingOrderChanged ( )

slot

Definition at line 32 of file slideback.cpp.

◆ slotTabBoxAdded

void KWin::SlideBackEffect::slotTabBoxAdded ( )

slot

Definition at line 298 of file slideback.cpp.

◆ slotTabBoxClosed

void KWin::SlideBackEffect::slotTabBoxClosed ( )

slot

Definition at line 303 of file slideback.cpp.

◆ slotWindowAdded

void KWin::SlideBackEffect::slotWindowAdded ( KWin::EffectWindow * w )

slot

Definition at line 277 of file slideback.cpp.

◆ slotWindowDeleted

void KWin::SlideBackEffect::slotWindowDeleted ( KWin::EffectWindow * w )

slot

Definition at line 260 of file slideback.cpp.

◆ slotWindowUnminimized

void KWin::SlideBackEffect::slotWindowUnminimized ( KWin::EffectWindow * w )

slot

Definition at line 288 of file slideback.cpp.

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

src/plugins/slideback/slideback.h
src/plugins/slideback/slideback.cpp

Public Slots

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SlideBackEffect()

Member Function Documentation

◆ isActive()

◆ paintWindow()

◆ postPaintScreen()

◆ postPaintWindow()

◆ prePaintScreen()

◆ prePaintWindow()

◆ requestedEffectChainPosition()

◆ slotStackingOrderChanged

◆ slotTabBoxAdded

◆ slotTabBoxClosed

◆ slotWindowAdded

◆ slotWindowDeleted

◆ slotWindowUnminimized