Files
test2/intern/ghost/intern/GHOST_DisplayManagerX11.hh
2023-06-14 17:42:15 +10:00

71 lines
2.3 KiB
C++

/* SPDX-FileCopyrightText: 2001-2002 NaN Holding BV. All rights reserved.
*
* SPDX-License-Identifier: GPL-2.0-or-later */
/** \file
* \ingroup GHOST
* Declaration of GHOST_DisplayManagerX11 class.
*/
#pragma once
#include "GHOST_DisplayManager.hh"
class GHOST_SystemX11;
/**
* Manages system displays (X11 implementation).
*/
class GHOST_DisplayManagerX11 : public GHOST_DisplayManager {
public:
/**
* Constructor.
*/
GHOST_DisplayManagerX11(GHOST_SystemX11 *system);
/**
* Returns the number of display devices on this system.
* \param numDisplays: The number of displays on this system.
* \return Indication of success.
*/
GHOST_TSuccess getNumDisplays(uint8_t &numDisplays) const;
/**
* Returns the number of display settings for this display device.
* \param display: The index of the display to query with 0 <= display < getNumDisplays().
* \param numSetting: The number of settings of the display device with this index.
* \return Indication of success.
*/
GHOST_TSuccess getNumDisplaySettings(uint8_t display, int32_t &numSettings) const;
/**
* Returns the current setting for this display device.
* \param display: The index of the display to query with 0 <= display < getNumDisplays().
* \param index: The setting index to be returned.
* \param setting: The setting of the display device with this index.
* \return Indication of success.
*/
GHOST_TSuccess getDisplaySetting(uint8_t display,
int32_t index,
GHOST_DisplaySetting &setting) const;
/**
* Returns the current setting for this display device.
* \param display: The index of the display to query with 0 <= display < getNumDisplays().
* \param setting: The current setting of the display device with this index.
* \return Indication of success.
*/
GHOST_TSuccess getCurrentDisplaySetting(uint8_t display, GHOST_DisplaySetting &setting) const;
/**
* Changes the current setting for this display device.
* \param display: The index of the display to query with 0 <= display < getNumDisplays().
* \param setting: The current setting of the display device with this index.
* \return Indication of success.
*/
GHOST_TSuccess setCurrentDisplaySetting(uint8_t display, const GHOST_DisplaySetting &setting);
private:
GHOST_SystemX11 *m_system;
};