HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
OCIO_NAMESPACE::SystemMonitors Class Referenceabstract

#include <OpenColorIO.h>

Public Member Functions

 SystemMonitors (const SystemMonitors &)=delete
 
SystemMonitorsoperator= (const SystemMonitors &)=delete
 
virtual bool isSupported () const noexcept=0
 
virtual size_t getNumMonitors () const noexcept=0
 Get the number of active monitors reported by the operating system. More...
 
virtual const char * getMonitorName (size_t idx) const =0
 Get the monitor profile name. More...
 
virtual const char * getProfileFilepath (size_t idx) const =0
 Get the ICC profile path associated to the monitor. More...
 

Static Public Member Functions

static ConstSystemMonitorsRcPtr Get () noexcept
 Get the existing instance. More...
 

Protected Member Functions

 SystemMonitors ()=default
 
virtual ~SystemMonitors ()=default
 

Detailed Description

Provides access to the ICC monitor profile provided by the operating system for each active display.

Definition at line 3788 of file OpenColorIO.h.

Constructor & Destructor Documentation

OCIO_NAMESPACE::SystemMonitors::SystemMonitors ( const SystemMonitors )
delete
OCIO_NAMESPACE::SystemMonitors::SystemMonitors ( )
protecteddefault
virtual OCIO_NAMESPACE::SystemMonitors::~SystemMonitors ( )
protectedvirtualdefault

Member Function Documentation

static ConstSystemMonitorsRcPtr OCIO_NAMESPACE::SystemMonitors::Get ( )
staticnoexcept

Get the existing instance.

virtual const char* OCIO_NAMESPACE::SystemMonitors::getMonitorName ( size_t  idx) const
pure virtual

Get the monitor profile name.

Get the string describing the monitor. It is used as an argument to instantiateDisplay. It may also be used in a UI to ask a user which of several monitors they want to instantiate a display for.

virtual size_t OCIO_NAMESPACE::SystemMonitors::getNumMonitors ( ) const
pure virtualnoexcept

Get the number of active monitors reported by the operating system.

Methods to access some information of the attached and active monitors.

virtual const char* OCIO_NAMESPACE::SystemMonitors::getProfileFilepath ( size_t  idx) const
pure virtual

Get the ICC profile path associated to the monitor.

virtual bool OCIO_NAMESPACE::SystemMonitors::isSupported ( ) const
pure virtualnoexcept

True if the OS is able to provide ICC profiles for the attached monitors (macOS, Windows) and false otherwise.

SystemMonitors& OCIO_NAMESPACE::SystemMonitors::operator= ( const SystemMonitors )
delete

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