The cl-drm Reference Manual

Table of Contents

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

The cl-drm Reference Manual

This is the cl-drm Reference Manual, generated automatically by Declt version 2.3 "Robert April" on Wed Mar 14 03:14:53 2018 GMT+0.


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

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)

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

2 Systems

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


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

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

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

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 files   [Contents][Index]

3.1.1 cl-drm.asd

Location

cl-drm.asd

Systems

cl-drm (system)


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

3.1.2 cl-drm/package.lisp

Parent

cl-drm (system)

Location

package.lisp

Packages

drm


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

3.1.3 cl-drm/cl-drm.lisp

Dependency

package.lisp (file)

Parent

cl-drm (system)

Location

cl-drm.lisp

Exported Definitions
Internal Definitions

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

4 Packages

Packages are listed by definition order.


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

4.1 drm

Source

package.lisp (file)

Use List
Exported Definitions
Internal Definitions

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

5 Definitions

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


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

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

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)


Previous: , Up: Exported definitions   [Contents][Index]

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)


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

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

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)


Previous: , Up: Internal definitions   [Contents][Index]

5.2.2 Classes

Class: display-config ()
Package

drm

Source

cl-drm.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
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)

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

Appendix A Indexes


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

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section

C
cl-drm.asd: The cl-drm<dot>asd file
cl-drm/cl-drm.lisp: The cl-drm/cl-drm<dot>lisp file
cl-drm/package.lisp: The cl-drm/package<dot>lisp file

F
File, Lisp, cl-drm.asd: The cl-drm<dot>asd file
File, Lisp, cl-drm/cl-drm.lisp: The cl-drm/cl-drm<dot>lisp file
File, Lisp, cl-drm/package.lisp: The cl-drm/package<dot>lisp file

L
Lisp File, cl-drm.asd: The cl-drm<dot>asd file
Lisp File, cl-drm/cl-drm.lisp: The cl-drm/cl-drm<dot>lisp file
Lisp File, cl-drm/package.lisp: The cl-drm/package<dot>lisp file

Jump to:   C   F   L  

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

A.2 Functions

Jump to:   (  
C   F   G   H   M  
Index Entry  Section

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

C
connector-id: Exported generic functions
connector-id: Exported generic functions
crtc: Exported generic functions
crtc: Exported generic functions

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

G
Generic Function, (setf connector-id): Exported generic functions
Generic Function, (setf crtc): Exported generic functions
Generic Function, (setf mode-info): Exported generic functions
Generic Function, connector-id: Exported generic functions
Generic Function, crtc: Exported generic functions
Generic Function, mode-info: Exported generic functions
get-modes: Internal functions

H
handle-event: Exported functions

M
Method, (setf connector-id): Exported generic functions
Method, (setf crtc): Exported generic functions
Method, (setf mode-info): Exported generic functions
Method, connector-id: Exported generic functions
Method, crtc: Exported generic functions
Method, mode-info: Exported generic functions
mode-add-framebuffer: Exported functions
mode-free-connector: Internal functions
mode-free-crtc: Exported functions
mode-free-encoder: Internal functions
mode-free-resources: Internal functions
mode-get-connector: Internal functions
mode-get-crtc: Internal functions
mode-get-encoder: Internal functions
mode-get-resources: Internal functions
mode-info: Exported generic functions
mode-info: Exported generic functions
mode-page-flip: Exported functions
mode-remove-framebuffer: Exported functions
mode-set-crtc: Exported 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: Internal classes
crtc: Internal classes

M
mode-info: Internal classes

S
Slot, connector-id: Internal classes
Slot, crtc: Internal classes
Slot, mode-info: Internal classes

Jump to:   C   M   S  

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

A.4 Data types

Jump to:   C   D   E   M   P   S  
Index Entry  Section

C
cl-drm: The cl-drm system
Class, display-config: Internal classes
Class, event-context-tclass: Internal classes
Class, mode-connector-tclass: Internal classes
Class, mode-crtc-tclass: Internal classes
Class, mode-encoder-tclass: Internal classes
Class, mode-mode-info-tclass: Internal classes
Class, mode-res-tclass: Internal classes

D
display-config: Internal classes
drm: The drm package

E
event-context-tclass: Internal classes

M
mode-connector-tclass: Internal classes
mode-crtc-tclass: Internal classes
mode-encoder-tclass: Internal classes
mode-mode-info-tclass: Internal classes
mode-res-tclass: Internal classes

P
Package, drm: The drm package

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

Jump to:   C   D   E   M   P   S