The cl-drm Reference Manual

This is the cl-drm Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed Jun 15 03:39:00 2022 GMT+0.

1 Introduction

cl-drm

LibDRM is an interface to the Linux Direct Rendering Manager (DRM). LibDRM provides a user-space API for mode setting. cl-drm is a Common Lisp wrapper for librdrm.

Status

cl-drm is being developed primarily in support of ulubis and is therefor feature incomplete. Pull requests adding more of the API are more than welcome.

Requiremnts

cl-drm (obiously) requires libdrm. It is likely that libdrm already exists on your Linux installation if it is recent.

Installation

CL-USER> (ql:quickload :cl-drm)

2 Systems

The main system appears first, followed by any subsystem dependency.

cl-drm

2.1 `cl-drm`

Common Lisp bindings for libdrm

Author

Malcolm Still

License

BSD 3-Clause

Dependency

cffi (system).

Source

cl-drm.asd.

Child Components

package.lisp (file).
cl-drm.lisp (file).

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.

Lisp

3.1.1 `cl-drm/cl-drm.asd`

Source: cl-drm.asd.
Parent Component: cl-drm (system).
ASDF Systems: cl-drm.

3.1.2 `cl-drm/package.lisp`

Source: cl-drm.asd.
Parent Component: cl-drm (system).
Packages: drm.

3.1.3 `cl-drm/cl-drm.lisp`

Dependency

package.lisp (file).

Source

cl-drm.asd.

Parent Component

cl-drm (system).

Public Interface

connector-id (reader method).
(setf connector-id) (writer method).
crtc (reader method).
(setf crtc) (writer method).
find-display-configuration (function).
handle-event (function).
mode-add-framebuffer (function).
mode-free-crtc (function).
mode-info (reader method).
(setf mode-info) (writer method).
mode-page-flip (function).
mode-remove-framebuffer (function).
mode-set-crtc (function).

Internals

display-config (class).
event-context-tclass (class).
find-connectors (function).
find-encoder (function).
first-connected (function).
get-modes (function).
mode-connector-tclass (class).
mode-crtc-tclass (class).
mode-encoder-tclass (class).
mode-free-connector (function).
mode-free-encoder (function).
mode-free-resources (function).
mode-get-connector (function).
mode-get-crtc (function).
mode-get-encoder (function).
mode-get-resources (function).
mode-mode-info-tclass (class).
mode-res-tclass (class).

4 Packages

Packages are listed by definition order.

drm

4.1 `drm`

Source

package.lisp.

Use List

cffi.
common-lisp.

Public Interface

connector-id (generic reader).
(setf connector-id) (generic writer).
crtc (generic reader).
(setf crtc) (generic writer).
find-display-configuration (function).
handle-event (function).
mode-add-framebuffer (function).
mode-free-crtc (function).
mode-info (generic reader).
(setf mode-info) (generic writer).
mode-page-flip (function).
mode-remove-framebuffer (function).
mode-set-crtc (function).

Internals

display-config (class).
event-context-tclass (class).
find-connectors (function).
find-encoder (function).
first-connected (function).
get-modes (function).
mode-connector-tclass (class).
mode-crtc-tclass (class).
mode-encoder-tclass (class).
mode-free-connector (function).
mode-free-encoder (function).
mode-free-resources (function).
mode-get-connector (function).
mode-get-crtc (function).
mode-get-encoder (function).
mode-get-resources (function).
mode-mode-info-tclass (class).
mode-res-tclass (class).

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

Public Interface
Internals

5.1 Public Interface

Ordinary functions
Generic functions

5.1.1 Ordinary functions

Function: find-display-configuration (fd) ¶

Package: drm.
Source: cl-drm.lisp.

Function: handle-event (fd event-context) ¶

Package: drm.
Source: cl-drm.lisp.

Function: mode-add-framebuffer (fd width height depth bpp pitch bo-handle buf-id) ¶

Package: drm.
Source: cl-drm.lisp.

Function: mode-free-crtc (crtc) ¶

Package: drm.
Source: cl-drm.lisp.

Function: mode-page-flip (fd crtc-id fb-id flags user-data) ¶

Package: drm.
Source: cl-drm.lisp.

Function: mode-remove-framebuffer (fd buffer-id) ¶

Package: drm.
Source: cl-drm.lisp.

Function: mode-set-crtc (fd crtc-id buffer-id x y connectors count mode) ¶

Package: drm.
Source: cl-drm.lisp.

5.1.2 Generic functions

Generic Reader: connector-id (object) ¶

Package

drm.

Methods

Reader Method: connector-id ((display-config display-config)) ¶

automatically generated reader method

Source: cl-drm.lisp.
Target Slot: connector-id.

Generic Writer: (setf connector-id) (object) ¶

Package

drm.

Methods

Writer Method: (setf connector-id) ((display-config display-config)) ¶

automatically generated writer method

Source: cl-drm.lisp.
Target Slot: connector-id.

Generic Reader: crtc (object) ¶

Package

drm.

Methods

Reader Method: crtc ((display-config display-config)) ¶

automatically generated reader method

Source: cl-drm.lisp.
Target Slot: crtc.

Generic Writer: (setf crtc) (object) ¶

Package

drm.

Methods

Writer Method: (setf crtc) ((display-config display-config)) ¶

automatically generated writer method

Source: cl-drm.lisp.
Target Slot: crtc.

Generic Reader: mode-info (object) ¶

Package

drm.

Methods

Reader Method: mode-info ((display-config display-config)) ¶

automatically generated reader method

Source: cl-drm.lisp.
Target Slot: mode-info.

Generic Writer: (setf mode-info) (object) ¶

Package

drm.

Methods

Writer Method: (setf mode-info) ((display-config display-config)) ¶

automatically generated writer method

Source: cl-drm.lisp.
Target Slot: mode-info.

5.2 Internals

Ordinary functions
Classes

5.2.1 Ordinary functions

Function: find-connectors (fd resources) ¶

Package: drm.
Source: cl-drm.lisp.

Function: find-encoder (fd connector) ¶

Package: drm.
Source: cl-drm.lisp.

Function: first-connected (connectors) ¶

Package: drm.
Source: cl-drm.lisp.

Function: get-modes (connector) ¶

Package: drm.
Source: cl-drm.lisp.

Function: mode-free-connector (connector) ¶

Package: drm.
Source: cl-drm.lisp.

Function: mode-free-encoder (encoder) ¶

Package: drm.
Source: cl-drm.lisp.

Function: mode-free-resources (resources) ¶

Package: drm.
Source: cl-drm.lisp.

Function: mode-get-connector (fd connector-id) ¶

Package: drm.
Source: cl-drm.lisp.

Function: mode-get-crtc (fd crtc-id) ¶

Package: drm.
Source: cl-drm.lisp.

Function: mode-get-encoder (fd encoder-id) ¶

Package: drm.
Source: cl-drm.lisp.

Function: mode-get-resources (fd) ¶

Package: drm.
Source: cl-drm.lisp.

5.2.2 Classes

Class: display-config ¶

Package

drm.

Source

cl-drm.lisp.

Direct methods

(setf connector-id).
connector-id.
(setf crtc).
crtc.
(setf mode-info).
mode-info.

Direct slots

Slot: connector-id ¶

Initargs: :connector-id
Readers: connector-id.
Writers: (setf connector-id).

Slot: mode-info ¶

Initargs: :mode-info
Readers: mode-info.
Writers: (setf mode-info).

Slot: crtc ¶

Initargs: :crtc
Readers: crtc.
Writers: (setf crtc).

Class: event-context-tclass ¶

Package

drm.

Source

cl-drm.lisp.

Direct superclasses

foreign-struct-type.
translatable-foreign-type.

Class: mode-connector-tclass ¶

Package

drm.

Source

cl-drm.lisp.

Direct superclasses

foreign-struct-type.
translatable-foreign-type.

Class: mode-crtc-tclass ¶

Package

drm.

Source

cl-drm.lisp.

Direct superclasses

foreign-struct-type.
translatable-foreign-type.

Class: mode-encoder-tclass ¶

Package

drm.

Source

cl-drm.lisp.

Direct superclasses

foreign-struct-type.
translatable-foreign-type.

Class: mode-mode-info-tclass ¶

Package

drm.

Source

cl-drm.lisp.

Direct superclasses

foreign-struct-type.
translatable-foreign-type.

Class: mode-res-tclass ¶

Package

drm.

Source

cl-drm.lisp.

Direct superclasses

foreign-struct-type.
translatable-foreign-type.

Appendix A Indexes

Concepts
Functions
Variables
Data types

A.1 Concepts

A.2 Functions

Jump to:	( C F G H M

	Index Entry	Section

(
	`(setf connector-id)`:	Public generic functions
	`(setf connector-id)`:	Public generic functions
	`(setf crtc)`:	Public generic functions
	`(setf crtc)`:	Public generic functions
	`(setf mode-info)`:	Public generic functions
	`(setf mode-info)`:	Public generic functions

C
	`connector-id`:	Public generic functions
	`connector-id`:	Public generic functions
	`crtc`:	Public generic functions
	`crtc`:	Public generic functions

F
	`find-connectors`:	Private ordinary functions
	`find-display-configuration`:	Public ordinary functions
	`find-encoder`:	Private ordinary functions
	`first-connected`:	Private ordinary functions
	`Function, find-connectors`:	Private ordinary functions
	`Function, find-display-configuration`:	Public ordinary functions
	`Function, find-encoder`:	Private ordinary functions
	`Function, first-connected`:	Private ordinary functions
	`Function, get-modes`:	Private ordinary functions
	`Function, handle-event`:	Public ordinary functions
	`Function, mode-add-framebuffer`:	Public ordinary functions
	`Function, mode-free-connector`:	Private ordinary functions
	`Function, mode-free-crtc`:	Public ordinary functions
	`Function, mode-free-encoder`:	Private ordinary functions
	`Function, mode-free-resources`:	Private ordinary functions
	`Function, mode-get-connector`:	Private ordinary functions
	`Function, mode-get-crtc`:	Private ordinary functions
	`Function, mode-get-encoder`:	Private ordinary functions
	`Function, mode-get-resources`:	Private ordinary functions
	`Function, mode-page-flip`:	Public ordinary functions
	`Function, mode-remove-framebuffer`:	Public ordinary functions
	`Function, mode-set-crtc`:	Public ordinary functions

G
	`Generic Function, (setf connector-id)`:	Public generic functions
	`Generic Function, (setf crtc)`:	Public generic functions
	`Generic Function, (setf mode-info)`:	Public generic functions
	`Generic Function, connector-id`:	Public generic functions
	`Generic Function, crtc`:	Public generic functions
	`Generic Function, mode-info`:	Public generic functions
	`get-modes`:	Private ordinary functions

H
	`handle-event`:	Public ordinary functions

M
	`Method, (setf connector-id)`:	Public generic functions
	`Method, (setf crtc)`:	Public generic functions
	`Method, (setf mode-info)`:	Public generic functions
	`Method, connector-id`:	Public generic functions
	`Method, crtc`:	Public generic functions
	`Method, mode-info`:	Public generic functions
	`mode-add-framebuffer`:	Public ordinary functions
	`mode-free-connector`:	Private ordinary functions
	`mode-free-crtc`:	Public ordinary functions
	`mode-free-encoder`:	Private ordinary functions
	`mode-free-resources`:	Private ordinary functions
	`mode-get-connector`:	Private ordinary functions
	`mode-get-crtc`:	Private ordinary functions
	`mode-get-encoder`:	Private ordinary functions
	`mode-get-resources`:	Private ordinary functions
	`mode-info`:	Public generic functions
	`mode-info`:	Public generic functions
	`mode-page-flip`:	Public ordinary functions
	`mode-remove-framebuffer`:	Public ordinary functions
	`mode-set-crtc`:	Public ordinary functions

Jump to:	( C F G H M

A.3 Variables

Jump to:	C M S

	Index Entry	Section

C
	`connector-id`:	Private classes
	`crtc`:	Private classes

M
	`mode-info`:	Private classes

S
	`Slot, connector-id`:	Private classes
	`Slot, crtc`:	Private classes
	`Slot, mode-info`:	Private classes

Jump to:	C M S

A.4 Data types

Jump to:	C D E F M P S

	Index Entry	Section

C
	`cl-drm`:	The cl-drm system
	`cl-drm.asd`:	The cl-drm/cl-drm․asd file
	`cl-drm.lisp`:	The cl-drm/cl-drm․lisp file
	`Class, display-config`:	Private classes
	`Class, event-context-tclass`:	Private classes
	`Class, mode-connector-tclass`:	Private classes
	`Class, mode-crtc-tclass`:	Private classes
	`Class, mode-encoder-tclass`:	Private classes
	`Class, mode-mode-info-tclass`:	Private classes
	`Class, mode-res-tclass`:	Private classes

D
	`display-config`:	Private classes
	`drm`:	The drm package

E
	`event-context-tclass`:	Private classes

F
	`File, cl-drm.asd`:	The cl-drm/cl-drm․asd file
	`File, cl-drm.lisp`:	The cl-drm/cl-drm․lisp file
	`File, package.lisp`:	The cl-drm/package․lisp file

M
	`mode-connector-tclass`:	Private classes
	`mode-crtc-tclass`:	Private classes
	`mode-encoder-tclass`:	Private classes
	`mode-mode-info-tclass`:	Private classes
	`mode-res-tclass`:	Private classes

P
	`Package, drm`:	The drm package
	`package.lisp`:	The cl-drm/package․lisp file

S
	`System, cl-drm`:	The cl-drm system

Jump to:	C D E F M P S

The cl-drm Reference Manual

The cl-drm Reference Manual

Table of Contents

1 Introduction

cl-drm

Status

Requiremnts

Installation

2 Systems

2.1 cl-drm

3 Files

3.1 Lisp

3.1.1 cl-drm/cl-drm.asd

3.1.2 cl-drm/package.lisp

3.1.3 cl-drm/cl-drm.lisp

4 Packages

4.1 drm

5 Definitions

5.1 Public Interface

5.1.1 Ordinary functions

5.1.2 Generic functions

5.2 Internals

5.2.1 Ordinary functions

5.2.2 Classes

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `cl-drm`

3.1.1 `cl-drm/cl-drm.asd`

3.1.2 `cl-drm/package.lisp`

3.1.3 `cl-drm/cl-drm.lisp`

4.1 `drm`