The cl-drm Reference Manual

Next: , Previous: , Up: (dir)   [Contents][Index]

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.

Table of Contents


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.


Previous: , Up: Systems   [Contents][Index]

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

3 Files

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


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp   [Contents][Index]

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.


Previous: , Up: Lisp   [Contents][Index]

3.1.3 cl-drm/cl-drm.lisp

Dependency

package.lisp (file).

Source

cl-drm.asd.

Parent Component

cl-drm (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

4.1 drm

Source

package.lisp.

Use List
  • cffi.
  • common-lisp.
Public Interface
Internals

5 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Public Interface


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


Next: , Previous: , Up: Internals   [Contents][Index]

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


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts


Next: , Previous: , Up: Indexes   [Contents][Index]

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  

Next: , Previous: , Up: Indexes   [Contents][Index]

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