The cl-gbm Reference Manual

Table of Contents

The cl-gbm Reference Manual

This is the cl-gbm Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Wed Mar 25 17:16:29 2020 GMT+0.

1 Introduction

cl-gbm

LibGBM is an interface to the Linux Generic Buffer Manager (GBM). It can be used in conjunction with EGL and DRM to provide buffers that can be rendered to with OpenGL. cl-gbm is a Common Lisp wrapper for libgbm.

Status

cl-gbm 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-gbm (obiously) requires libgbm. It is likely that libgbm already exists on your Linux installation if it is recent.

Installation

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

2 Systems

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

2.1 cl-gbm

Author

Malcolm Still

License

BSD 3-Clause

Description

Common Lisp wrapper for libgbm

Dependency

cffi

Source

cl-gbm.asd (file)

Components

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

Location

cl-gbm.asd

Systems

cl-gbm (system)

3.1.2 cl-gbm/package.lisp

Parent

cl-gbm (system)

Location

package.lisp

Packages

gbm

3.1.3 cl-gbm/cl-gbm.lisp

Dependency

package.lisp (file)

Parent

cl-gbm (system)

Location

cl-gbm.lisp

Exported Definitions

• bo-get-handle (function)
• bo-get-stride (function)
• create-device (function)
• device-destroy (function)
• surface-create (function)
• surface-destroy (function)
• surface-lock-front-buffer (function)
• surface-release-buffer (function)

4 Packages

Packages are listed by definition order.

4.1 gbm

Source

package.lisp (file)

Use List

• cffi
• common-lisp

Exported Definitions

• bo-get-handle (function)
• bo-get-stride (function)
• create-device (function)
• device-destroy (function)
• surface-create (function)
• surface-destroy (function)
• surface-lock-front-buffer (function)
• surface-release-buffer (function)

5 Definitions

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

5.1 Exported definitions

5.1.1 Functions

Function: bo-get-handle BO

Package

gbm

Source

cl-gbm.lisp (file)

Function: bo-get-stride BO

Package

gbm

Source

cl-gbm.lisp (file)

Function: create-device FD

Package

gbm

Source

cl-gbm.lisp (file)

Function: device-destroy DEVICE

Package

gbm

Source

cl-gbm.lisp (file)

Function: surface-create DEVICE WIDTH HEIGHT FORMAT FLAGS

Package

gbm

Source

cl-gbm.lisp (file)

Function: surface-destroy SURFACE

Package

gbm

Source

cl-gbm.lisp (file)

Function: surface-lock-front-buffer SURFACE

Package

gbm

Source

cl-gbm.lisp (file)

Function: surface-release-buffer SURFACE BO

Package

gbm

Source

cl-gbm.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types