The cl-gbm Reference Manual

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

The cl-gbm Reference Manual

This is the cl-gbm Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Aug 15 03:39:27 2022 GMT+0.

Table of Contents


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.


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

2.1 cl-gbm

Common Lisp wrapper for libgbm

Author

Malcolm Still

License

BSD 3-Clause

Dependency

cffi (system).

Source

cl-gbm.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-gbm/cl-gbm.asd

Source

cl-gbm.asd.

Parent Component

cl-gbm (system).

ASDF Systems

cl-gbm.


3.1.2 cl-gbm/package.lisp

Source

cl-gbm.asd.

Parent Component

cl-gbm (system).

Packages

gbm.


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

3.1.3 cl-gbm/cl-gbm.lisp

Dependency

package.lisp (file).

Source

cl-gbm.asd.

Parent Component

cl-gbm (system).

Public Interface

4 Packages

Packages are listed by definition order.


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

4.1 gbm

Source

package.lisp.

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

5 Definitions

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


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

5.1 Public Interface


5.1.1 Ordinary functions

Function: bo-get-handle (bo)
Package

gbm.

Source

cl-gbm.lisp.

Function: bo-get-stride (bo)
Package

gbm.

Source

cl-gbm.lisp.

Function: create-device (fd)
Package

gbm.

Source

cl-gbm.lisp.

Function: device-destroy (device)
Package

gbm.

Source

cl-gbm.lisp.

Function: surface-create (device width height format flags)
Package

gbm.

Source

cl-gbm.lisp.

Function: surface-destroy (surface)
Package

gbm.

Source

cl-gbm.lisp.

Function: surface-lock-front-buffer (surface)
Package

gbm.

Source

cl-gbm.lisp.

Function: surface-release-buffer (surface bo)
Package

gbm.

Source

cl-gbm.lisp.


Appendix A Indexes


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

A.1 Concepts


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

A.3 Variables