Cl-Monitors

About cl-monitors

This is a small wrapper library around libmonitors, providing independent monitor resolution detection and change support.

How To

Precompiled versions of the underlying library are included in this. If you want to build it manually however, refer to the libmonitors README.

Load the system through ASDF or Quicklisp and initialise it:

(ql:quickload :cl-monitors)
(cl-monitors:init)

Now you can retrieve a list of the monitors on your system:

(cl-monitors:detect)

You can inspect the available video modes for each of them too:

(mapcar #'cl-monitors:modes *)

And even switch the mode:

(cl-monitors:make-current (second (first *)))

Though you probably want to switch back again to your preferred resolution:

(cl-monitors:make-current (first (first **)))

Once you're all done, don't forget to clean up again after yourself:

(cl-monitors:deinit)

And that's all there is to it. Well-- almost all. You can query information from the monitor and mode objects as well of course. For this, see width, height, refresh, current-p, mode, name, and primary-p.

Package Index

CL-MONITORS-CFFI (ORG.SHIRAKUMO.FRAF.MONITORS.CFFI)

special

`STATIC`

Variable containing a pathname to the static directory.

class

`MODE-STRUCT`

CL type for the C mode struct.

See MODE-MONITOR
See MODE-WIDTH
See MODE-HEIGHT
See MODE-REFRESH
See MODE-DATA

class

`MONITOR-STRUCT`

CL type for the C monitor struct.

See MONITOR-NAME
See MONITOR-PRIMARY
See MONITOR-WIDTH
See MONITOR-HEIGHT
See MONITOR-MODE-COUNT
See MONITOR-CURRENT-MODE
See MONITOR-MODES
See MONITOR-DATA
See MONITORS-FREE-MONITOR

accessor (

`MODE-DATA`

POINTER-TO-MODE-STRUCT)

Reads the pointer to the system-dependant data struct of the mode.

You should not need this for anything.

See MODE-STRUCT

accessor (

`MODE-HEIGHT`

POINTER-TO-MODE-STRUCT)

Reads the mode's height in pixels.

See MODE-STRUCT

accessor (

`MODE-MONITOR`

POINTER-TO-MODE-STRUCT)

Reads the pointer to the monitor struct this mode originated from.

See MODE-STRUCT

accessor (

`MODE-REFRESH`

POINTER-TO-MODE-STRUCT)

Reads the mode's refresh rate in Herz.

See MODE-STRUCT

accessor (

`MODE-WIDTH`

POINTER-TO-MODE-STRUCT)

Reads the mode's width in pixels.

See MODE-STRUCT

accessor (

`MONITOR-CURRENT-MODE`

POINTER-TO-MONITOR-STRUCT)

Reads the pointer to the current mode of the monitor.

See MONITOR-STRUCT

accessor (

`MONITOR-DATA`

POINTER-TO-MONITOR-STRUCT)

Reads the pointer to the system-dependant data struct of the monitor.

You should not need this for anything.

See MONITOR-STRUCT

accessor (

`MONITOR-HEIGHT`

POINTER-TO-MONITOR-STRUCT)

Reads the monitor's physical height in millimetres.

See MONITOR-STRUCT

accessor (

`MONITOR-MODE-COUNT`

POINTER-TO-MONITOR-STRUCT)

Reads the count for how many mode structs there are in the mode field of the monitor.

See MONITOR-MODES
See MONITOR-STRUCT

accessor (

`MONITOR-MODES`

POINTER-TO-MONITOR-STRUCT)

Reads the pointer to the packed mode struct array of the monitor.

See MONITOR-MODE-COUNT
See MONITOR-STRUCT

accessor (

`MONITOR-NAME`

POINTER-TO-MONITOR-STRUCT)

Reads the monitor's name string.

See MONITOR-STRUCT

accessor (

`MONITOR-PRIMARY`

POINTER-TO-MONITOR-STRUCT)

Reads whether the monitor is the primary monitor of the system.

See MONITOR-STRUCT

accessor (

`MONITOR-WIDTH`

POINTER-TO-MONITOR-STRUCT)

Reads the monitor's physical width in millimetres.

See MONITOR-STRUCT

function (

`MONITORS-DEINIT`

)

Cleans up the monitors library. You should call this once you are done with everything.

function (

`MONITORS-DETECT`

COUNT MONITORS)

Detects the monitors and their modes on the system.

You need to pass this two "empty" pointers. The first will be set to
reference an int for the number of monitors that were detected, and the
second to an array of pointers to monitor structs.

If NIL is returned, the detection failed and the two pointers you passed will not have changed.

See MONITOR-STRUCT

function (

`MONITORS-FREE-MONITOR`

MONITOR)

Frees a monitor struct.

See MONITOR-STRUCT

function (

`MONITORS-FREE-MONITORS`

COUNT MONITORS)

Frees an array of pointers to monitor objects, including the monitors referenced by it.

See MONITORS-FREE-MONITOR

function (

`MONITORS-INIT`

)

Initializes the monitors library. You should call this before anything.

If NIL is returned, the initialisation failed and other library calls
will most likely too.

function (

`MONITORS-MAKE-MODE-CURRENT`

MODE)

Attempts to make the given mode the current mode on its monitor.

If NIL is returned, the mode change failed. Otherwise the monitor's
current mode is updated to reflect the newly chose none.

See MODE-STRUCT
See MONITOR-CURRENT-MODE

CL-MONITORS (ORG.SHIRAKUMO.FRAF.MONITORS)

class

`MODE`

Class representing a possible display mode of a monitor.

See MONITOR
See WIDTH
See HEIGHT
See REFRESH
See CURRENT-P

class

`MONITOR`

Class representing a physical monitor on the system.

See MODES
See MODE
See NAME
See PRIMARY-P
See WIDTH
See HEIGHT

condition

`DETECTION-FAILED-ERROR`

Condition for when the monitor detection fails.

See DETECT
See MONITOR-CONDITION

condition

`INITIALIZATION-FAILED-ERROR`

Condition for when the monitor initialization fails.

See INIT
See MONITOR-CONDITION

condition

`MODE-SWITCH-FAILED-ERROR`

Condition for when the mode switch call fails.

See MODE
See MONITOR-CONDITION

condition

`MONITOR-CONDITION`

Base condition class for conditions relating to this library.

accessor (

`MODE`

CONDITION)

Returns the current mode of the monitor.

SETFable. When set with a suitable mode, it will attempt to switch
the current mode of the monitor to the new one. 
Signals a MODE-SWITCH-FAILED-ERROR on failure.

See MODE
See MONITOR

function (

`DEINIT`

)

Cleans up the library.

You should call this once you are done with everything.

function (

`DETECT`

)

Detects the monitors and modes on the system.

Returns a list of monitors on the system.
Signals a DETECTION-FAILED-ERROR on failured.

See MONITOR

function (

`INIT`

)

Initializes the library.

You should call this before any other function to the library is called.
Signals an INITIALIZATION-FAILED-ERROR on failure.

function (

`MAKE-CURRENT`

MODE)

Attempts to make the passed mode the current one.

This is equivalent to doing (SETF (MODE (MONITOR mode)) mode).

See MODE

generic (

`CURRENT-P`

MODE)

Returns whether the mode is the current mode of the monitor.

See MODE

generic (

`HEIGHT`

MODE)

Returns the height.

For a mode, this is in pixels.
For a monitor, this is in physical millimetres.

See MODE
See MONITOR

generic (

`MODES`

OBJECT)

Returns the list of possible modes the monitor can assume.

A pox upon those that modify this list.

See MONITOR

generic (

`MONITOR`

OBJECT)

Returns the monitor the mode belongs to.

See MONITOR
See MODE

generic (

`NAME`

MONITOR)

Returns the monitor's name on the system.

See MONITOR

generic (

`PRIMARY-P`

MONITOR)

Returns whether the monitor is the system's primary monitor.

See MONITOR

generic (

`REFRESH`

MODE)

Returns the mode's refresh rate in Herz.

See MODE

generic (

`WIDTH`

MODE)

Returns the width.

For a mode, this is in pixels.
For a monitor, this is in physical millimetres.

See MODE
See MONITOR

About cl-monitors

How To

Copyright

Package Index

CL-MONITORS-CFFI (ORG.SHIRAKUMO.FRAF.MONITORS.CFFI)

CL-MONITORS (ORG.SHIRAKUMO.FRAF.MONITORS)