The cepl.drm-gbm Reference Manual

Table of Contents

The cepl.drm-gbm Reference Manual

This is the cepl.drm-gbm Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 11:57:12 2020 GMT+0.

1 Introduction

cepl.drm-gbm

This package lets the Linux framebuffer (via DRM/GBM) act as a host for cepl

2 Systems

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

2.1 cepl.drm-gbm

Author

Malcolm Still <malcolm.still@gmail.com>

License

BSD 3-Clause

Description

DRM/GBM host for cepl

Dependencies

• cepl
• osicat
• cl-drm
• cl-gbm
• cl-egl

Source

cepl.drm-gbm.asd (file)

Components

• package.lisp (file)
• cepl.drm-gbm.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 cepl.drm-gbm.asd

Location

cepl.drm-gbm.asd

Systems

cepl.drm-gbm (system)

3.1.2 cepl.drm-gbm/package.lisp

Parent

cepl.drm-gbm (system)

Location

package.lisp

Packages

cepl.drm-gbm

3.1.3 cepl.drm-gbm/cepl.drm-gbm.lisp

Dependency

package.lisp (file)

Parent

cepl.drm-gbm (system)

Location

cepl.drm-gbm.lisp

Internal Definitions

• *drm-gbm* (special variable)
• *initd* (special variable)
• bind-wayland-display (method)
• (setf bind-wayland-display) (method)
• collect-drm-gbm-events (function)
• connector-id (method)
• (setf connector-id) (method)
• crtc (method)
• (setf crtc) (method)
• display-config (method)
• (setf display-config) (method)
• drm-gbm (class)
• drm-gbm-api (class)
• drm-gbm-destroy-surface (function)
• drm-gbm-init (function)
• drm-gbm-make-context (function)
• drm-gbm-make-surface (function)
• drm-gbm-shutdown (function)
• drm-gbm-swap (function)
• drm-gbm-win-size (function)
• egl-context (method)
• (setf egl-context) (method)
• egl-display (method)
• (setf egl-display) (method)
• egl-surface (method)
• (setf egl-surface) (method)
• fd (method)
• (setf fd) (method)
• gbm-device (method)
• (setf gbm-device) (method)
• gbm-surface (method)
• (setf gbm-surface) (method)
• get-egl-context (function)
• get-egl-display (function)
• height (method)
• (setf height) (method)
• make-shared-drm-gbm-context (function)
• mode-info (method)
• (setf mode-info) (method)
• page-flip (function)
• page-flip-scheduled? (method)
• (setf page-flip-scheduled?) (method)
• previous-bo (method)
• (setf previous-bo) (method)
• previous-fb (method)
• (setf previous-fb) (method)
• query-wayland-buffer (method)
• (setf query-wayland-buffer) (method)
• set-primary-thread-and-run (method)
• width (method)
• (setf width) (method)

4 Packages

Packages are listed by definition order.

4.1 cepl.drm-gbm

Source

package.lisp (file)

Use List

• cepl.host
• cffi
• common-lisp

Internal Definitions

• *drm-gbm* (special variable)
• *initd* (special variable)
• bind-wayland-display (generic function)
• bind-wayland-display (method)
• (setf bind-wayland-display) (method)
• (setf bind-wayland-display) (generic function)
• collect-drm-gbm-events (function)
• 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)
• display-config (generic function)
• display-config (method)
• (setf display-config) (method)
• (setf display-config) (generic function)
• drm-gbm (class)
• drm-gbm-api (class)
• drm-gbm-destroy-surface (function)
• drm-gbm-init (function)
• drm-gbm-make-context (function)
• drm-gbm-make-surface (function)
• drm-gbm-shutdown (function)
• drm-gbm-swap (function)
• drm-gbm-win-size (function)
• egl-context (generic function)
• egl-context (method)
• (setf egl-context) (method)
• (setf egl-context) (generic function)
• egl-display (generic function)
• egl-display (method)
• (setf egl-display) (method)
• (setf egl-display) (generic function)
• egl-surface (generic function)
• egl-surface (method)
• (setf egl-surface) (method)
• (setf egl-surface) (generic function)
• fd (generic function)
• fd (method)
• (setf fd) (method)
• (setf fd) (generic function)
• gbm-device (generic function)
• gbm-device (method)
• (setf gbm-device) (method)
• (setf gbm-device) (generic function)
• gbm-surface (generic function)
• gbm-surface (method)
• (setf gbm-surface) (method)
• (setf gbm-surface) (generic function)
• get-egl-context (function)
• get-egl-display (function)
• height (generic function)
• height (method)
• (setf height) (method)
• (setf height) (generic function)
• make-shared-drm-gbm-context (function)
• mode-info (generic function)
• mode-info (method)
• (setf mode-info) (method)
• (setf mode-info) (generic function)
• page-flip (function)
• page-flip-scheduled? (generic function)
• page-flip-scheduled? (method)
• (setf page-flip-scheduled?) (method)
• (setf page-flip-scheduled?) (generic function)
• previous-bo (generic function)
• previous-bo (method)
• (setf previous-bo) (method)
• (setf previous-bo) (generic function)
• previous-fb (generic function)
• previous-fb (method)
• (setf previous-fb) (method)
• (setf previous-fb) (generic function)
• query-wayland-buffer (generic function)
• query-wayland-buffer (method)
• (setf query-wayland-buffer) (method)
• (setf query-wayland-buffer) (generic function)
• set-primary-thread-and-run (generic function)
• set-primary-thread-and-run (method)
• width (generic function)
• width (method)
• (setf width) (method)
• (setf width) (generic function)

5 Definitions

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

5.1 Internal definitions

5.1.1 Special variables

Special Variable: *drm-gbm*

Package

cepl.drm-gbm

Source

cepl.drm-gbm.lisp (file)

Special Variable: *initd*

Package

cepl.drm-gbm

Source

cepl.drm-gbm.lisp (file)

5.1.2 Functions

Function: collect-drm-gbm-events DRM-GBM &optional TPREF

Package

cepl.drm-gbm

Source

cepl.drm-gbm.lisp (file)

Function: drm-gbm-destroy-surface SURFACE

Package

cepl.drm-gbm

Source

cepl.drm-gbm.lisp (file)

Function: drm-gbm-init ()

Package

cepl.drm-gbm

Source

cepl.drm-gbm.lisp (file)

Function: drm-gbm-make-context SURFACE VERSION DOUBLE-BUFFER ALPHA-SIZE DEPTH-SIZE STENCIL-SIZE BUFFER-SIZE RED-SIZE GREEN-SIZE BLUE-SIZE

Package

cepl.drm-gbm

Source

cepl.drm-gbm.lisp (file)

Function: drm-gbm-make-surface WIDTH HEIGHT TITLE FULLSCREEN NO-FRAME ALPHA-SIZE DEPTH-SIZE STENCIL-SIZE RED-SIZE GREEN-SIZE BLUE-SIZE BUFFER-SIZE DOUBLE-BUFFER HIDDEN RESIZABLE

Initializes the backend and returns a list containing: (context window)

Package

cepl.drm-gbm

Source

cepl.drm-gbm.lisp (file)

Function: drm-gbm-shutdown ()

Package

cepl.drm-gbm

Source

cepl.drm-gbm.lisp (file)

Function: drm-gbm-swap DRM-GBM

Package

cepl.drm-gbm

Source

cepl.drm-gbm.lisp (file)

Function: drm-gbm-win-size DRM-GBM

Package

cepl.drm-gbm

Source

cepl.drm-gbm.lisp (file)

Function: get-egl-context ()

Package

cepl.drm-gbm

Source

cepl.drm-gbm.lisp (file)

Function: get-egl-display ()

Package

cepl.drm-gbm

Source

cepl.drm-gbm.lisp (file)

Function: make-shared-drm-gbm-context CURRENT-GL-CONTEXT SURFACE VERSION DOUBLE-BUFFER ALPHA-SIZE DEPTH-SIZE STENCIL-SIZE BUFFER-SIZE RED-SIZE GREEN-SIZE BLUE-SIZE

Package

cepl.drm-gbm

Source

cepl.drm-gbm.lisp (file)

Function: page-flip DRM-GBM

Package

cepl.drm-gbm

Source

cepl.drm-gbm.lisp (file)

5.1.3 Generic functions

Generic Function: bind-wayland-display OBJECT

Generic Function: (setf bind-wayland-display) NEW-VALUE OBJECT

Package

cepl.drm-gbm

Methods

Method: bind-wayland-display (DRM-GBM drm-gbm)

automatically generated reader method

Source

cepl.drm-gbm.lisp (file)

Method: (setf bind-wayland-display) NEW-VALUE (DRM-GBM drm-gbm)

automatically generated writer method

Source

cepl.drm-gbm.lisp (file)

Generic Function: connector-id OBJECT

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

Package

cepl.drm-gbm

Methods

Method: connector-id (DRM-GBM drm-gbm)

automatically generated reader method

Source

cepl.drm-gbm.lisp (file)

Method: (setf connector-id) NEW-VALUE (DRM-GBM drm-gbm)

automatically generated writer method

Source

cepl.drm-gbm.lisp (file)

Generic Function: crtc OBJECT

Generic Function: (setf crtc) NEW-VALUE OBJECT

Package

cepl.drm-gbm

Methods

Method: crtc (DRM-GBM drm-gbm)

automatically generated reader method

Source

cepl.drm-gbm.lisp (file)

Method: (setf crtc) NEW-VALUE (DRM-GBM drm-gbm)

automatically generated writer method

Source

cepl.drm-gbm.lisp (file)

Generic Function: display-config OBJECT

Generic Function: (setf display-config) NEW-VALUE OBJECT

Package

cepl.drm-gbm

Methods

Method: display-config (DRM-GBM drm-gbm)

automatically generated reader method

Source

cepl.drm-gbm.lisp (file)

Method: (setf display-config) NEW-VALUE (DRM-GBM drm-gbm)

automatically generated writer method

Source

cepl.drm-gbm.lisp (file)

Generic Function: egl-context OBJECT

Generic Function: (setf egl-context) NEW-VALUE OBJECT

Package

cepl.drm-gbm

Methods

Method: egl-context (DRM-GBM drm-gbm)

automatically generated reader method

Source

cepl.drm-gbm.lisp (file)

Method: (setf egl-context) NEW-VALUE (DRM-GBM drm-gbm)

automatically generated writer method

Source

cepl.drm-gbm.lisp (file)

Generic Function: egl-display OBJECT

Generic Function: (setf egl-display) NEW-VALUE OBJECT

Package

cepl.drm-gbm

Methods

Method: egl-display (DRM-GBM drm-gbm)

automatically generated reader method

Source

cepl.drm-gbm.lisp (file)

Method: (setf egl-display) NEW-VALUE (DRM-GBM drm-gbm)

automatically generated writer method

Source

cepl.drm-gbm.lisp (file)

Generic Function: egl-surface OBJECT

Generic Function: (setf egl-surface) NEW-VALUE OBJECT

Package

cepl.drm-gbm

Methods

Method: egl-surface (DRM-GBM drm-gbm)

automatically generated reader method

Source

cepl.drm-gbm.lisp (file)

Method: (setf egl-surface) NEW-VALUE (DRM-GBM drm-gbm)

automatically generated writer method

Source

cepl.drm-gbm.lisp (file)

Generic Function: fd OBJECT

Generic Function: (setf fd) NEW-VALUE OBJECT

Package

cepl.drm-gbm

Methods

Method: fd (DRM-GBM drm-gbm)

automatically generated reader method

Source

cepl.drm-gbm.lisp (file)

Method: (setf fd) NEW-VALUE (DRM-GBM drm-gbm)

automatically generated writer method

Source

cepl.drm-gbm.lisp (file)

Generic Function: gbm-device OBJECT

Generic Function: (setf gbm-device) NEW-VALUE OBJECT

Package

cepl.drm-gbm

Methods

Method: gbm-device (DRM-GBM drm-gbm)

automatically generated reader method

Source

cepl.drm-gbm.lisp (file)

Method: (setf gbm-device) NEW-VALUE (DRM-GBM drm-gbm)

automatically generated writer method

Source

cepl.drm-gbm.lisp (file)

Generic Function: gbm-surface OBJECT

Generic Function: (setf gbm-surface) NEW-VALUE OBJECT

Package

cepl.drm-gbm

Methods

Method: gbm-surface (DRM-GBM drm-gbm)

automatically generated reader method

Source

cepl.drm-gbm.lisp (file)

Method: (setf gbm-surface) NEW-VALUE (DRM-GBM drm-gbm)

automatically generated writer method

Source

cepl.drm-gbm.lisp (file)

Generic Function: height OBJECT

Generic Function: (setf height) NEW-VALUE OBJECT

Package

cepl.drm-gbm

Methods

Method: height (DRM-GBM drm-gbm)

automatically generated reader method

Source

cepl.drm-gbm.lisp (file)

Method: (setf height) NEW-VALUE (DRM-GBM drm-gbm)

automatically generated writer method

Source

cepl.drm-gbm.lisp (file)

Generic Function: mode-info OBJECT

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

Package

cepl.drm-gbm

Methods

Method: mode-info (DRM-GBM drm-gbm)

automatically generated reader method

Source

cepl.drm-gbm.lisp (file)

Method: (setf mode-info) NEW-VALUE (DRM-GBM drm-gbm)

automatically generated writer method

Source

cepl.drm-gbm.lisp (file)

Generic Function: page-flip-scheduled? OBJECT

Generic Function: (setf page-flip-scheduled?) NEW-VALUE OBJECT

Package

cepl.drm-gbm

Methods

Method: page-flip-scheduled? (DRM-GBM drm-gbm)

automatically generated reader method

Source

cepl.drm-gbm.lisp (file)

Method: (setf page-flip-scheduled?) NEW-VALUE (DRM-GBM drm-gbm)

automatically generated writer method

Source

cepl.drm-gbm.lisp (file)

Generic Function: previous-bo OBJECT

Generic Function: (setf previous-bo) NEW-VALUE OBJECT

Package

cepl.drm-gbm

Methods

Method: previous-bo (DRM-GBM drm-gbm)

automatically generated reader method

Source

cepl.drm-gbm.lisp (file)

Method: (setf previous-bo) NEW-VALUE (DRM-GBM drm-gbm)

automatically generated writer method

Source

cepl.drm-gbm.lisp (file)

Generic Function: previous-fb OBJECT

Generic Function: (setf previous-fb) NEW-VALUE OBJECT

Package

cepl.drm-gbm

Methods

Method: previous-fb (DRM-GBM drm-gbm)

automatically generated reader method

Source

cepl.drm-gbm.lisp (file)

Method: (setf previous-fb) NEW-VALUE (DRM-GBM drm-gbm)

automatically generated writer method

Source

cepl.drm-gbm.lisp (file)

Generic Function: query-wayland-buffer OBJECT

Generic Function: (setf query-wayland-buffer) NEW-VALUE OBJECT

Package

cepl.drm-gbm

Methods

Method: query-wayland-buffer (DRM-GBM drm-gbm)

automatically generated reader method

Source

cepl.drm-gbm.lisp (file)

Method: (setf query-wayland-buffer) NEW-VALUE (DRM-GBM drm-gbm)

automatically generated writer method

Source

cepl.drm-gbm.lisp (file)

Generic Function: set-primary-thread-and-run FUNC &rest ARGS

Package

cepl.drm-gbm

Methods

Method: set-primary-thread-and-run FUNC &rest ARGS

Source

cepl.drm-gbm.lisp (file)

Generic Function: width OBJECT

Generic Function: (setf width) NEW-VALUE OBJECT

Package

cepl.drm-gbm

Methods

Method: width (DRM-GBM drm-gbm)

automatically generated reader method

Source

cepl.drm-gbm.lisp (file)

Method: (setf width) NEW-VALUE (DRM-GBM drm-gbm)

automatically generated writer method

Source

cepl.drm-gbm.lisp (file)

5.1.4 Classes

Class: drm-gbm ()

Package

cepl.drm-gbm

Source

cepl.drm-gbm.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• query-wayland-buffer (method)
• query-wayland-buffer (method)
• bind-wayland-display (method)
• bind-wayland-display (method)
• egl-context (method)
• egl-context (method)
• egl-surface (method)
• egl-surface (method)
• egl-display (method)
• egl-display (method)
• previous-bo (method)
• previous-bo (method)
• gbm-surface (method)
• gbm-surface (method)
• gbm-device (method)
• gbm-device (method)
• page-flip-scheduled? (method)
• page-flip-scheduled? (method)
• previous-fb (method)
• previous-fb (method)
• height (method)
• height (method)
• width (method)
• width (method)
• crtc (method)
• crtc (method)
• connector-id (method)
• connector-id (method)
• mode-info (method)
• mode-info (method)
• display-config (method)
• display-config (method)
• fd (method)
• fd (method)

Direct slots

Slot: fd

Initargs

:fd

Readers

fd (generic function)

Writers

(setf fd) (generic function)

Slot: display-config

Initargs

:display-config

Readers

display-config (generic function)

Writers

(setf display-config) (generic function)

Slot: mode-info

Initargs

:mode-info

Readers

mode-info (generic function)

Writers

(setf mode-info) (generic function)

Slot: connector-id

Initargs

:connector-id

Readers

connector-id (generic function)

Writers

(setf connector-id) (generic function)

Slot: crtc

Initargs

:crtc

Readers

crtc (generic function)

Writers

(setf crtc) (generic function)

Slot: width

Initargs

:width

Readers

width (generic function)

Writers

(setf width) (generic function)

Slot: height

Initargs

:height

Readers

height (generic function)

Writers

(setf height) (generic function)

Slot: previous-fb

Initargs

:previous-fb

Readers

previous-fb (generic function)

Writers

(setf previous-fb) (generic function)

Slot: page-flip-scheduled?

Initargs

:page-flip-scheduled?

Readers

page-flip-scheduled? (generic function)

Writers

(setf page-flip-scheduled?) (generic function)

Slot: gbm-device

Initargs

:gbm-device

Readers

gbm-device (generic function)

Writers

(setf gbm-device) (generic function)

Slot: gbm-surface

Initargs

:gbm-surface

Readers

gbm-surface (generic function)

Writers

(setf gbm-surface) (generic function)

Slot: previous-bo

Initargs

:previous-bo

Readers

previous-bo (generic function)

Writers

(setf previous-bo) (generic function)

Slot: egl-display

Initargs

:egl-display

Readers

egl-display (generic function)

Writers

(setf egl-display) (generic function)

Slot: egl-surface

Initargs

:egl-surface

Readers

egl-surface (generic function)

Writers

(setf egl-surface) (generic function)

Slot: egl-context

Initargs

:egl-context

Readers

egl-context (generic function)

Writers

(setf egl-context) (generic function)

Slot: bind-wayland-display

Initargs

:bind-wayland-display

Readers

bind-wayland-display (generic function)

Writers

(setf bind-wayland-display) (generic function)

Slot: query-wayland-buffer

Initargs

:query-wayland-buffer

Readers

query-wayland-buffer (generic function)

Writers

(setf query-wayland-buffer) (generic function)

Class: drm-gbm-api ()

Package

cepl.drm-gbm

Source

cepl.drm-gbm.lisp (file)

Direct superclasses

api-2 (class)

Direct slots

Slot: supports-multiple-contexts-p

Slot: supports-multiple-surfaces-p

Slot: init-function

Initform

(function cepl.drm-gbm::drm-gbm-init)

Slot: shutdown-function

Initform

(function cepl.drm-gbm::drm-gbm-shutdown)

Slot: make-surface-function

Initform

(function cepl.drm-gbm::drm-gbm-make-surface)

Slot: destroy-surface-function

Initform

(function cepl.drm-gbm::drm-gbm-destroy-surface)

Slot: make-context-function

Initform

(function cepl.drm-gbm::drm-gbm-make-context)

Slot: step-function

Initform

(function cepl.drm-gbm::collect-drm-gbm-events)

Slot: register-event-callback-function

Initform

(lambda (cepl.drm-gbm::fn))

Slot: swap-function

Initform

(function cepl.drm-gbm::drm-gbm-swap)

Slot: surface-size-function

Initform

(lambda (cepl.drm-gbm::surface) (list (cepl.drm-gbm::width cepl.drm-gbm::*drm-gbm*) (cepl.drm-gbm::height cepl.drm-gbm::*drm-gbm*)))

Slot: make-context-current-function

Initform

(lambda (cepl.drm-gbm::gl-context cepl.drm-gbm::surface))

Slot: set-surface-size-function

Initform

(lambda (cepl.drm-gbm::surface cepl.drm-gbm::width cepl.drm-gbm::height))

Slot: surface-fullscreen-p-function

Initform

(lambda (cepl.drm-gbm::surface) t)

Slot: set-surface-fullscreen-function

Initform

(lambda (cepl.drm-gbm::surface))

Slot: surface-title-function

Initform

(lambda (cepl.drm-gbm::surface) "linux drm/kms")

Slot: set-surface-title-function

Initform

(lambda (cepl.drm-gbm::surface cepl.drm-gbm::title))

Slot: make-gl-context-shared-with-current-context-function

Initform

(function cepl.drm-gbm::make-shared-drm-gbm-context)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types