The cl-drm Reference Manual

Table of Contents

The cl-drm Reference Manual

This is the cl-drm Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Thu Mar 11 12:01:04 2021 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.

2.1 cl-drm

Author

Malcolm Still

License

BSD 3-Clause

Description

Common Lisp bindings for libdrm

Dependency

cffi

Source

cl-drm.asd (file)

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.

3.1 Lisp

3.1.1 cl-drm.asd

Location

cl-drm.asd

Systems

cl-drm (system)

3.1.2 cl-drm/package.lisp

Parent

cl-drm (system)

Location

package.lisp

Packages

drm

3.1.3 cl-drm/cl-drm.lisp

Dependency

package.lisp (file)

Parent

cl-drm (system)

Location

cl-drm.lisp

Exported Definitions

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

Internal Definitions

• 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.

4.1 drm

Source

package.lisp (file)

Use List

• cffi
• common-lisp

Exported Definitions

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

Internal Definitions

• 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.

5.1 Exported definitions

5.1.1 Functions

Function: find-display-configuration FD

Package

drm

Source

cl-drm.lisp (file)

Function: handle-event FD EVENT-CONTEXT

Package

drm

Source

cl-drm.lisp (file)

Function: mode-add-framebuffer FD WIDTH HEIGHT DEPTH BPP PITCH BO-HANDLE BUF-ID

Package

drm

Source

cl-drm.lisp (file)

Function: mode-free-crtc CRTC

Package

drm

Source

cl-drm.lisp (file)

Function: mode-page-flip FD CRTC-ID FB-ID FLAGS USER-DATA

Package

drm

Source

cl-drm.lisp (file)

Function: mode-remove-framebuffer FD BUFFER-ID

Package

drm

Source

cl-drm.lisp (file)

Function: mode-set-crtc FD CRTC-ID BUFFER-ID X Y CONNECTORS COUNT MODE

Package

drm

Source

cl-drm.lisp (file)

5.1.2 Generic functions

Generic Function: connector-id OBJECT

Generic Function: (setf connector-id) NEW-VALUE OBJECT

Package

drm

Methods

Method: connector-id (DISPLAY-CONFIG display-config)

automatically generated reader method

Source

cl-drm.lisp (file)

Method: (setf connector-id) NEW-VALUE (DISPLAY-CONFIG display-config)

automatically generated writer method

Source

cl-drm.lisp (file)

Generic Function: crtc OBJECT

Generic Function: (setf crtc) NEW-VALUE OBJECT

Package

drm

Methods

Method: crtc (DISPLAY-CONFIG display-config)

automatically generated reader method

Source

cl-drm.lisp (file)

Method: (setf crtc) NEW-VALUE (DISPLAY-CONFIG display-config)

automatically generated writer method

Source

cl-drm.lisp (file)

Generic Function: mode-info OBJECT

Generic Function: (setf mode-info) NEW-VALUE OBJECT

Package

drm

Methods

Method: mode-info (DISPLAY-CONFIG display-config)

automatically generated reader method

Source

cl-drm.lisp (file)

Method: (setf mode-info) NEW-VALUE (DISPLAY-CONFIG display-config)

automatically generated writer method

Source

cl-drm.lisp (file)

5.2 Internal definitions

5.2.1 Functions

Function: find-connectors FD RESOURCES

Package

drm

Source

cl-drm.lisp (file)

Function: find-encoder FD CONNECTOR

Package

drm

Source

cl-drm.lisp (file)

Function: first-connected CONNECTORS

Package

drm

Source

cl-drm.lisp (file)

Function: get-modes CONNECTOR

Package

drm

Source

cl-drm.lisp (file)

Function: mode-free-connector CONNECTOR

Package

drm

Source

cl-drm.lisp (file)

Function: mode-free-encoder ENCODER

Package

drm

Source

cl-drm.lisp (file)

Function: mode-free-resources RESOURCES

Package

drm

Source

cl-drm.lisp (file)

Function: mode-get-connector FD CONNECTOR-ID

Package

drm

Source

cl-drm.lisp (file)

Function: mode-get-crtc FD CRTC-ID

Package

drm

Source

cl-drm.lisp (file)

Function: mode-get-encoder FD ENCODER-ID

Package

drm

Source

cl-drm.lisp (file)

Function: mode-get-resources FD

Package

drm

Source

cl-drm.lisp (file)

5.2.2 Classes

Class: display-config ()

Package

drm

Source

cl-drm.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• crtc (method)
• crtc (method)
• mode-info (method)
• mode-info (method)
• connector-id (method)
• connector-id (method)

Direct slots

Slot: connector-id

Initargs

:connector-id

Readers

connector-id (generic function)

Writers

(setf connector-id) (generic function)

Slot: mode-info

Initargs

:mode-info

Readers

mode-info (generic function)

Writers

(setf mode-info) (generic function)

Slot: crtc

Initargs

:crtc

Readers

crtc (generic function)

Writers

(setf crtc) (generic function)

Class: event-context-tclass ()

Package

drm

Source

cl-drm.lisp (file)

Direct superclasses

• translatable-foreign-type (class)
• foreign-struct-type (class)

Class: mode-connector-tclass ()

Package

drm

Source

cl-drm.lisp (file)

Direct superclasses

• translatable-foreign-type (class)
• foreign-struct-type (class)

Class: mode-crtc-tclass ()

Package

drm

Source

cl-drm.lisp (file)

Direct superclasses

• translatable-foreign-type (class)
• foreign-struct-type (class)

Class: mode-encoder-tclass ()

Package

drm

Source

cl-drm.lisp (file)

Direct superclasses

• translatable-foreign-type (class)
• foreign-struct-type (class)

Class: mode-mode-info-tclass ()

Package

drm

Source

cl-drm.lisp (file)

Direct superclasses

• translatable-foreign-type (class)
• foreign-struct-type (class)

Class: mode-res-tclass ()

Package

drm

Source

cl-drm.lisp (file)

Direct superclasses

• translatable-foreign-type (class)
• foreign-struct-type (class)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types