KWin::ScreenShotEffect Class Reference

#include <screenshot.h>

Inheritance diagram for KWin::ScreenShotEffect:

Public Member Functions
	ScreenShotEffect ()
	~ScreenShotEffect () override
QFuture< QImage >	scheduleScreenShot (Output *screen, ScreenShotFlags flags={})
QFuture< QImage >	scheduleScreenShot (const QRect &area, ScreenShotFlags flags={})
QFuture< QImage >	scheduleScreenShot (EffectWindow *window, ScreenShotFlags flags={})
void	paintScreen (const RenderTarget &renderTarget, const RenderViewport &viewport, int mask, const QRegion &region, Output *screen) 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	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

Static Public Member Functions
static bool	supported ()
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)

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)

Detailed Description

The ScreenShotEffect provides a convenient way to capture the contents of a given window, screen or an area in the global coordinates.

Use the QFutureWatcher class to get notified when the requested screenshot is ready. Note that the screenshot QFuture object can get cancelled if the captured window or the screen is removed.

Definition at line 46 of file screenshot.h.

Constructor & Destructor Documentation

ScreenShotEffect()

KWin::ScreenShotEffect::ScreenShotEffect

(

)

Definition at line 91 of file screenshot.cpp.

~ScreenShotEffect()

KWin::ScreenShotEffect::~ScreenShotEffect ( )

override

Definition at line 99 of file screenshot.cpp.

Member Function Documentation

isActive()

bool KWin::ScreenShotEffect::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 427 of file screenshot.cpp.

paintScreen()

void KWin::ScreenShotEffect::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 204 of file screenshot.cpp.

requestedEffectChainPosition()

int KWin::ScreenShotEffect::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 433 of file screenshot.cpp.

scheduleScreenShot() [1/3]

QFuture< QImage > KWin::ScreenShotEffect::scheduleScreenShot	(	const QRect &	area,
		ScreenShotFlags	flags = {} )

Schedules a screenshot of the given area. The returned QFuture can be used to query the image data.

Definition at line 127 of file screenshot.cpp.

scheduleScreenShot() [2/3]

QFuture< QImage > KWin::ScreenShotEffect::scheduleScreenShot	(	EffectWindow *	window,
		ScreenShotFlags	flags = {} )

Schedules a screenshot of the given window. The returned QFuture can be used to query the image data. If the window is removed before the screenshot is taken, the future will be cancelled.

Definition at line 168 of file screenshot.cpp.

scheduleScreenShot() [3/3]

QFuture< QImage > KWin::ScreenShotEffect::scheduleScreenShot	(	Output *	screen,
		ScreenShotFlags	flags = {} )

Schedules a screenshot of the given screen. The returned QFuture can be used to query the image data. If the screen is removed before the screenshot is taken, the future will be cancelled.

Definition at line 106 of file screenshot.cpp.

supported()

bool KWin::ScreenShotEffect::supported ( )

static

Definition at line 86 of file screenshot.cpp.

---

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

• src/plugins/screenshot/screenshot.h
• src/plugins/screenshot/screenshot.cpp