8e88139fd6
Summary:
There are several issues with code of AbstractOutput class:
(a) Some methods are documented, and some are not. In general, we tend
to document all public methods in KWin core. It looks like a very
minor issue, but there are methods that have very ambiguous return
value. One such method is geometry(). It's not obvious whether the
returned geometry is in device independent pixels or not;
(b) There's a mix of methods defined in the cpp file and in the header.
This is not very good because reading such code becomes a bit harder
if you don't use any fancy IDE;
(c) Missing Q_DISABLE_COPY, etc.
This change addresses these issues, so the code is a bit more readable
and easier to work with.
Reviewers: #kwin, davidedmundson
Reviewed By: #kwin, davidedmundson
Subscribers: broulik, cfeck, davidedmundson, kwin
Tags: #kwin
Differential Revision: https://phabricator.kde.org/D21874
162 lines
3.9 KiB
C++
162 lines
3.9 KiB
C++
/********************************************************************
|
|
KWin - the KDE window manager
|
|
This file is part of the KDE project.
|
|
|
|
Copyright 2019 Roman Gilg <subdiff@gmail.com>
|
|
|
|
This program is free software; you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation; either version 2 of the License, or
|
|
(at your option) any later version.
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*********************************************************************/
|
|
#ifndef KWIN_ABSTRACT_OUTPUT_H
|
|
#define KWIN_ABSTRACT_OUTPUT_H
|
|
|
|
#include <kwin_export.h>
|
|
|
|
#include <QObject>
|
|
#include <QRect>
|
|
#include <QSize>
|
|
#include <QVector>
|
|
|
|
namespace KWin
|
|
{
|
|
|
|
class KWIN_EXPORT GammaRamp
|
|
{
|
|
public:
|
|
GammaRamp(uint32_t size);
|
|
|
|
/**
|
|
* Returns the size of the gamma ramp.
|
|
**/
|
|
uint32_t size() const;
|
|
|
|
/**
|
|
* Returns pointer to the first red component in the gamma ramp.
|
|
*
|
|
* The returned pointer can be used for altering the red component
|
|
* in the gamma ramp.
|
|
**/
|
|
uint16_t *red();
|
|
|
|
/**
|
|
* Returns pointer to the first red component in the gamma ramp.
|
|
**/
|
|
const uint16_t *red() const;
|
|
|
|
/**
|
|
* Returns pointer to the first green component in the gamma ramp.
|
|
*
|
|
* The returned pointer can be used for altering the green component
|
|
* in the gamma ramp.
|
|
**/
|
|
uint16_t *green();
|
|
|
|
/**
|
|
* Returns pointer to the first green component in the gamma ramp.
|
|
**/
|
|
const uint16_t *green() const;
|
|
|
|
/**
|
|
* Returns pointer to the first blue component in the gamma ramp.
|
|
*
|
|
* The returned pointer can be used for altering the blue component
|
|
* in the gamma ramp.
|
|
**/
|
|
uint16_t *blue();
|
|
|
|
/**
|
|
* Returns pointer to the first blue component in the gamma ramp.
|
|
**/
|
|
const uint16_t *blue() const;
|
|
|
|
private:
|
|
QVector<uint16_t> m_table;
|
|
uint32_t m_size;
|
|
};
|
|
|
|
/**
|
|
* Generic output representation.
|
|
**/
|
|
class KWIN_EXPORT AbstractOutput : public QObject
|
|
{
|
|
Q_OBJECT
|
|
|
|
public:
|
|
explicit AbstractOutput(QObject *parent = nullptr);
|
|
~AbstractOutput() override;
|
|
|
|
/**
|
|
* Returns the human readable name of this output.
|
|
**/
|
|
virtual QString name() const = 0;
|
|
|
|
/**
|
|
* Returns geometry of this output in device independent pixels.
|
|
**/
|
|
virtual QRect geometry() const = 0;
|
|
|
|
/**
|
|
* Returns the approximate vertical refresh rate of this output, in mHz.
|
|
**/
|
|
virtual int refreshRate() const = 0;
|
|
|
|
/**
|
|
* Returns whether this output is connected through an internal connector,
|
|
* e.g. LVDS, or eDP.
|
|
*
|
|
* Default implementation returns @c false.
|
|
**/
|
|
virtual bool isInternal() const;
|
|
|
|
/**
|
|
* Returns the ratio between physical pixels and logical pixels.
|
|
*
|
|
* Default implementation returns 1.
|
|
**/
|
|
virtual qreal scale() const;
|
|
|
|
/**
|
|
* Returns the physical size of this output, in millimeters.
|
|
*
|
|
* Default implementation returns an invalid QSize.
|
|
**/
|
|
virtual QSize physicalSize() const;
|
|
|
|
/**
|
|
* Returns the orientation of this output.
|
|
*
|
|
* Default implementation returns Qt::PrimaryOrientation.
|
|
**/
|
|
virtual Qt::ScreenOrientation orientation() const;
|
|
|
|
/**
|
|
* Returns the size of the gamma lookup table.
|
|
*
|
|
* Default implementation returns 0.
|
|
**/
|
|
virtual int gammaRampSize() const;
|
|
|
|
/**
|
|
* Sets the gamma ramp of this output.
|
|
*
|
|
* Returns @c true if the gamma ramp was successfully set.
|
|
**/
|
|
virtual bool setGammaRamp(const GammaRamp &gamma);
|
|
|
|
private:
|
|
Q_DISABLE_COPY(AbstractOutput)
|
|
};
|
|
|
|
} // namespace KWin
|
|
|
|
#endif
|