KisWaylandOutputColorInfo Class Reference

#include <KisWaylandOutputColorInfo.h>

Inheritance diagram for KisWaylandOutputColorInfo:

Public Member Functions
bool	isReady () const override
	KisWaylandOutputColorInfo (QObject *parent=nullptr)
std::optional< KisSurfaceColorimetry::SurfaceDescription >	outputDescription (const QScreen *screen) const override
	~KisWaylandOutputColorInfo () override
Public Member Functions inherited from KisOutputColorInfoInterface
	KisOutputColorInfoInterface (QObject *parent=nullptr)
virtual	~KisOutputColorInfoInterface ()

Private Member Functions
bool	checkIfAllReady () const
void	initScreenConnection (QScreen *screen)
void	reinitialize ()
void	setReadyImpl (bool value)
void	slotScreenAdded (QScreen *screen)
void	slotScreenRemoved (QScreen *screen)

Private Attributes
bool	m_isReady {false}
std::shared_ptr< KisWaylandAPIColorManager >	m_waylandManager
std::unordered_map< const QScreen *, std::unique_ptr< KisWaylandAPIOutput > >	m_waylandOutputs

Additional Inherited Members
Signals inherited from KisOutputColorInfoInterface
void	sigOutputDescriptionChanged (QScreen *screen, const KisSurfaceColorimetry::SurfaceDescription &desc)
void	sigReadyChanged (bool isReady)
Protected Attributes inherited from KisOutputColorInfoInterface
QWindow *	m_window

Detailed Description

Definition at line 16 of file KisWaylandOutputColorInfo.h.

Constructor & Destructor Documentation

KisWaylandOutputColorInfo()

KisWaylandOutputColorInfo::KisWaylandOutputColorInfo

(

QObject *

parent = nullptr

)

Definition at line 24 of file KisWaylandOutputColorInfo.cpp.

    : KisOutputColorInfoInterface(parent)
{
    m_waylandManager = KisWaylandSurfaceColorManager::getOrCreateGlobalWaylandManager();
    connect(m_waylandManager.get(), &KisWaylandAPIColorManager::sigReadyChanged,
            this, &KisWaylandOutputColorInfo::reinitialize);
    reinitialize();
 
    connect(qApp, &QGuiApplication::screenAdded, this, &KisWaylandOutputColorInfo::slotScreenAdded);
    connect(qApp, &QGuiApplication::screenRemoved, this, &KisWaylandOutputColorInfo::slotScreenRemoved);
}

References connect(), KisWaylandSurfaceColorManager::getOrCreateGlobalWaylandManager(), m_waylandManager, reinitialize(), KisWaylandAPIColorManager::sigReadyChanged(), slotScreenAdded(), and slotScreenRemoved().

~KisWaylandOutputColorInfo()

KisWaylandOutputColorInfo::~KisWaylandOutputColorInfo ( )

override

Definition at line 36 of file KisWaylandOutputColorInfo.cpp.

{
}

Member Function Documentation

checkIfAllReady()

bool KisWaylandOutputColorInfo::checkIfAllReady ( ) const

private

Definition at line 48 of file KisWaylandOutputColorInfo.cpp.

{
    if (m_waylandOutputs.empty()) return false;
 
    return std::find_if(m_waylandOutputs.begin(), m_waylandOutputs.end(),
        [] (const auto &it) {
            return !it.second->m_imageDescription->info.isReady();
        }
        ) == m_waylandOutputs.end();
}

References m_waylandOutputs.

initScreenConnection()

void KisWaylandOutputColorInfo::initScreenConnection ( QScreen * screen )

private

Definition at line 75 of file KisWaylandOutputColorInfo.cpp.

{
    auto waylandScreen = screen->nativeInterface<QNativeInterface::QWaylandScreen>();
 
    // the screen may have no wayland screen if it is a fake placeholder screen
    // that was created by Qt while compositor restart
    if (!waylandScreen) return;
 
    ::wl_output *output = waylandScreen->output();
    ::wp_color_management_output_v1 *cmoutput = m_waylandManager->get_output(output);
    Q_ASSERT(cmoutput);
 
    auto outputObject = std::make_unique<KisWaylandAPIOutput>(cmoutput);
    connect(outputObject.get(), &KisWaylandAPIOutput::outputImageDescriptionChanged, outputObject.get(), [this, screen, outputPtr = outputObject.get()]() {
        auto desc = outputPtr->m_imageDescription->info.m_data;
        Q_EMIT sigOutputDescriptionChanged(screen, desc.toSurfaceDescription());
 
        setReadyImpl(checkIfAllReady());
    });
 
    m_waylandOutputs.insert_or_assign(screen, std::move(outputObject));
}

References connect(), m_waylandManager, m_waylandOutputs, and KisWaylandAPIOutput::outputImageDescriptionChanged().

isReady()

bool KisWaylandOutputColorInfo::isReady ( ) const

overridevirtual

Returns

true when the interface is considered as "fully initialized", i.e. when all screen descriptions are ready.

Implements KisOutputColorInfoInterface.

Definition at line 120 of file KisWaylandOutputColorInfo.cpp.

{
    return m_isReady;
}

References m_isReady.

outputDescription()

std::optional< KisSurfaceColorimetry::SurfaceDescription > KisWaylandOutputColorInfo::outputDescription ( const QScreen * screen ) const

overridevirtual

Returns

a color space description for the specified screen

When isReady() is set to false may or may not return std::nullopt, wait for sigReadyChanged() to make sure all screens are initialized.

Implements KisOutputColorInfoInterface.

Definition at line 125 of file KisWaylandOutputColorInfo.cpp.

{
    auto it = m_waylandOutputs.find(screen);
    if (it == m_waylandOutputs.end()) return std::nullopt;
 
    const auto &info = it->second->m_imageDescription->info;
 
    if (!info.isReady()) {
        return std::nullopt;
    }
 
    return info.m_data.toSurfaceDescription();
}

References m_waylandOutputs.

reinitialize()

void KisWaylandOutputColorInfo::reinitialize ( )

private

Definition at line 59 of file KisWaylandOutputColorInfo.cpp.

{
    m_waylandOutputs.clear();
 
    if (!m_waylandManager->isReady()) {
        setReadyImpl(false);
        return;
    }
 
    for (QScreen *screen : qApp->screens()) {
        initScreenConnection(screen);
    }
 
    setReadyImpl(checkIfAllReady());
}

References checkIfAllReady(), initScreenConnection(), m_waylandManager, m_waylandOutputs, and setReadyImpl().

setReadyImpl()

void KisWaylandOutputColorInfo::setReadyImpl ( bool value )

private

Definition at line 40 of file KisWaylandOutputColorInfo.cpp.

{
    if (value == m_isReady) return;
 
    m_isReady = value;
    Q_EMIT sigReadyChanged(m_isReady);
}

References m_isReady, KisOutputColorInfoInterface::sigReadyChanged(), and value().

slotScreenAdded()

void KisWaylandOutputColorInfo::slotScreenAdded ( QScreen * screen )

private

Definition at line 98 of file KisWaylandOutputColorInfo.cpp.

{
    if (!m_waylandManager->isActive()) {
        return;
    }
 
    initScreenConnection(screen);
 
    setReadyImpl(checkIfAllReady());
}

References checkIfAllReady(), initScreenConnection(), m_waylandManager, and setReadyImpl().

slotScreenRemoved()

void KisWaylandOutputColorInfo::slotScreenRemoved ( QScreen * screen )

private

Definition at line 109 of file KisWaylandOutputColorInfo.cpp.

{
    if (!m_waylandManager->isActive()) {
        return;
    }
 
    m_waylandOutputs.erase(screen);
 
    setReadyImpl(checkIfAllReady());
}

References checkIfAllReady(), m_waylandManager, m_waylandOutputs, and setReadyImpl().

Member Data Documentation

m_isReady

bool KisWaylandOutputColorInfo::m_isReady {false}

private

Definition at line 38 of file KisWaylandOutputColorInfo.h.

{false};

m_waylandManager

std::shared_ptr<KisWaylandAPIColorManager> KisWaylandOutputColorInfo::m_waylandManager

private

Definition at line 36 of file KisWaylandOutputColorInfo.h.

m_waylandOutputs

std::unordered_map<const QScreen*, std::unique_ptr<KisWaylandAPIOutput> > KisWaylandOutputColorInfo::m_waylandOutputs

private

Definition at line 37 of file KisWaylandOutputColorInfo.h.

---

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

• plugins/platforms/wayland/waylandcolormanagement/KisWaylandOutputColorInfo.h
• plugins/platforms/wayland/waylandcolormanagement/KisWaylandOutputColorInfo.cpp