This is the cl-monitors Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon May 15 04:07:27 2023 GMT+0.
The main system appears first, followed by any subsystem dependency.
cl-monitorsBindings to libmonitors, allowing the handling of monitors querying and resolution changing.
Nicolas Hafner <shinmera@tymoon.eu>
Nicolas Hafner <shinmera@tymoon.eu>
(GIT https://github.com/Shirakumo/cl-monitors.git)
zlib
1.0.0
cffi (system).
trivial-features (system).
trivial-garbage (system).
documentation-utils (system).
package.lisp (file).
low-level.lisp (file).
wrapper.lisp (file).
documentation.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
cl-monitors/cl-monitors.asdcl-monitors/package.lispcl-monitors/low-level.lispcl-monitors/wrapper.lispcl-monitors/documentation.lispcl-monitors/low-level.lisppackage.lisp (file).
cl-monitors (system).
*static* (special variable).
mode-data (function).
(setf mode-data) (function).
mode-height (function).
(setf mode-height) (function).
mode-monitor (function).
(setf mode-monitor) (function).
mode-refresh (function).
(setf mode-refresh) (function).
mode-struct (class).
mode-width (function).
(setf mode-width) (function).
monitor-current-mode (function).
(setf monitor-current-mode) (function).
monitor-data (function).
(setf monitor-data) (function).
monitor-height (function).
(setf monitor-height) (function).
monitor-mode-count (function).
(setf monitor-mode-count) (function).
monitor-modes (function).
(setf monitor-modes) (function).
monitor-name (function).
(setf monitor-name) (function).
monitor-primary (function).
(setf monitor-primary) (function).
monitor-struct (class).
monitor-width (function).
(setf monitor-width) (function).
monitors-deinit (function).
monitors-detect (function).
monitors-free-monitor (function).
monitors-free-monitors (function).
monitors-init (function).
monitors-make-mode-current (function).
*here* (special variable).
cl-monitors/wrapper.lisplow-level.lisp (file).
cl-monitors (system).
current-p (method).
deinit (function).
detect (function).
detection-failed-error (condition).
height (method).
height (method).
init (function).
initialization-failed-error (condition).
initialize-instance (method).
make-current (function).
mode (reader method).
mode (reader method).
(setf mode) (method).
mode (class).
mode-switch-failed-error (condition).
modes (reader method).
monitor (reader method).
monitor (class).
monitor-condition (condition).
name (method).
primary-p (method).
print-object (method).
print-object (method).
refresh (method).
width (method).
width (method).
define-foreign-reader (macro).
foreign-object (class).
pointer (reader method).
cl-monitors/documentation.lispwrapper.lisp (file).
cl-monitors (system).
Packages are listed by definition order.
cl-monitorsorg.shirakumo.fraf.monitors
cl-monitors-cffi.
common-lisp.
current-p (generic function).
deinit (function).
detect (function).
detection-failed-error (condition).
height (generic function).
init (function).
initialization-failed-error (condition).
make-current (function).
mode (generic reader).
(setf mode) (generic function).
mode (class).
mode-switch-failed-error (condition).
modes (generic reader).
monitor (generic reader).
monitor (class).
monitor-condition (condition).
name (generic function).
primary-p (generic function).
refresh (generic function).
width (generic function).
define-foreign-reader (macro).
foreign-object (class).
pointer (generic reader).
cl-monitors-cffiorg.shirakumo.fraf.monitors.cffi
cffi.
common-lisp.
*static* (special variable).
mode-data (function).
(setf mode-data) (function).
mode-height (function).
(setf mode-height) (function).
mode-monitor (function).
(setf mode-monitor) (function).
mode-refresh (function).
(setf mode-refresh) (function).
mode-struct (class).
mode-width (function).
(setf mode-width) (function).
monitor-current-mode (function).
(setf monitor-current-mode) (function).
monitor-data (function).
(setf monitor-data) (function).
monitor-height (function).
(setf monitor-height) (function).
monitor-mode-count (function).
(setf monitor-mode-count) (function).
monitor-modes (function).
(setf monitor-modes) (function).
monitor-name (function).
(setf monitor-name) (function).
monitor-primary (function).
(setf monitor-primary) (function).
monitor-struct (class).
monitor-width (function).
(setf monitor-width) (function).
monitors-deinit (function).
monitors-detect (function).
monitors-free-monitor (function).
monitors-free-monitors (function).
monitors-init (function).
monitors-make-mode-current (function).
*here* (special variable).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Variable containing a pathname to the static directory.
Cleans up the library.
You should call this once you are done with everything.
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
Initializes the library.
You should call this before any other function to the library is called. Signals an INITIALIZATION-FAILED-ERROR on failure.
Attempts to make the passed mode the current one.
This is equivalent to doing (SETF (MODE (MONITOR mode)) mode).
See MODE
Reads the pointer to the system-dependant data struct of the mode.
You should not need this for anything.
See MODE-STRUCT
Reads the mode’s height in pixels.
See MODE-STRUCT
Reads the pointer to the monitor struct this mode originated from.
See MODE-STRUCT
Reads the mode’s refresh rate in Herz.
See MODE-STRUCT
Reads the mode’s width in pixels.
See MODE-STRUCT
Reads the pointer to the current mode of the monitor.
See MONITOR-STRUCT
Reads the pointer to the system-dependant data struct of the monitor.
You should not need this for anything.
See MONITOR-STRUCT
Reads the monitor’s physical height in millimetres.
See 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
Reads the pointer to the packed mode struct array of the monitor.
See MONITOR-MODE-COUNT
See MONITOR-STRUCT
Reads the monitor’s name string.
See MONITOR-STRUCT
Reads whether the monitor is the primary monitor of the system.
See MONITOR-STRUCT
Reads the monitor’s physical width in millimetres.
See MONITOR-STRUCT
Cleans up the monitors library. You should call this once you are done with everything.
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
Frees a monitor struct.
See MONITOR-STRUCT
Frees an array of pointers to monitor objects, including the monitors referenced by it.
See MONITORS-FREE-MONITOR
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.
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
Returns whether the mode is the current mode of the monitor.
See MODE
Returns the height.
For a mode, this is in pixels.
For a monitor, this is in physical millimetres.
See MODE
See MONITOR
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
Returns the list of possible modes the monitor can assume.
A pox upon those that modify this list.
See MONITOR
Returns the monitor the mode belongs to.
See MONITOR
See MODE
Returns the monitor’s name on the system.
See MONITOR
Returns whether the monitor is the system’s primary monitor.
See MONITOR
Returns the mode’s refresh rate in Herz.
See MODE
Returns the width.
For a mode, this is in pixels.
For a monitor, this is in physical millimetres.
See MODE
See MONITOR
Condition for when the monitor detection fails.
See DETECT
See MONITOR-CONDITION
error.
monitor-condition.
Condition for when the monitor initialization fails.
See INIT
See MONITOR-CONDITION
error.
monitor-condition.
Condition for when the mode switch call fails.
See MODE
See MONITOR-CONDITION
error.
monitor-condition.
mode.
Base condition class for conditions relating to this library.
condition.
Class representing a possible display mode of a monitor.
See MONITOR
See WIDTH
See HEIGHT
See REFRESH
See CURRENT-P
| Initarg | Value |
|---|---|
:monitor | (error monitor required.) |
CL type for the C mode struct.
See MODE-MONITOR
See MODE-WIDTH
See MODE-HEIGHT
See MODE-REFRESH
See MODE-DATA
foreign-struct-type.
translatable-foreign-type.
Class representing a physical monitor on the system.
See MODES
See MODE
See NAME
See PRIMARY-P
See WIDTH
See HEIGHT
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
foreign-struct-type.
translatable-foreign-type.
foreign-object)) ¶automatically generated reader method
| Jump to: | (
C D F G H I M N P R W |
|---|
| Jump to: | (
C D F G H I M N P R W |
|---|
| Jump to: | *
M P S |
|---|
| Jump to: | *
M P S |
|---|
| Jump to: | C D F I L M P S W |
|---|
| Jump to: | C D F I L M P S W |
|---|