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.

1 Introduction
2 Systems
- 2.1 cl-gbm
3 Files
- 3.1 Lisp
4 Packages
- 4.1 gbm
5 Definitions
- 5.1 Public Interface
  - 5.1.1 Ordinary functions
Appendix A Indexes

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.

cl-gbm

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

package.lisp (file).
cl-gbm.lisp (file).

3 Files

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

Lisp

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.

3.1.3 `cl-gbm/cl-gbm.lisp`

Dependency

package.lisp (file).

Source

cl-gbm.asd.

Parent Component

cl-gbm (system).

Public Interface

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.

gbm

4.1 `gbm`

Source

package.lisp.

Use List

cffi.
common-lisp.

Public Interface

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.

Public Interface

5.1 Public Interface

Ordinary functions

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

Concepts
Functions
Variables
Data types

A.1 Concepts

A.2 Functions

Jump to:	B C D F S

	Index Entry	Section

B
	`bo-get-handle`:	Public ordinary functions
	`bo-get-stride`:	Public ordinary functions

C
	`create-device`:	Public ordinary functions

D
	`device-destroy`:	Public ordinary functions

F
	`Function, bo-get-handle`:	Public ordinary functions
	`Function, bo-get-stride`:	Public ordinary functions
	`Function, create-device`:	Public ordinary functions
	`Function, device-destroy`:	Public ordinary functions
	`Function, surface-create`:	Public ordinary functions
	`Function, surface-destroy`:	Public ordinary functions
	`Function, surface-lock-front-buffer`:	Public ordinary functions
	`Function, surface-release-buffer`:	Public ordinary functions

S
	`surface-create`:	Public ordinary functions
	`surface-destroy`:	Public ordinary functions
	`surface-lock-front-buffer`:	Public ordinary functions
	`surface-release-buffer`:	Public ordinary functions

Jump to:	B C D F S

A.3 Variables

A.4 Data types

Jump to:	C F G P S

	Index Entry	Section

C
	`cl-gbm`:	The cl-gbm system
	`cl-gbm.asd`:	The cl-gbm/cl-gbm․asd file
	`cl-gbm.lisp`:	The cl-gbm/cl-gbm․lisp file

F
	`File, cl-gbm.asd`:	The cl-gbm/cl-gbm․asd file
	`File, cl-gbm.lisp`:	The cl-gbm/cl-gbm․lisp file
	`File, package.lisp`:	The cl-gbm/package․lisp file

G
	`gbm`:	The gbm package

P
	`Package, gbm`:	The gbm package
	`package.lisp`:	The cl-gbm/package․lisp file

S
	`System, cl-gbm`:	The cl-gbm system

Jump to:	C F G P S

The cl-gbm Reference Manual

The cl-gbm Reference Manual

Table of Contents

1 Introduction

cl-gbm

Status

Requiremnts

Installation

2 Systems

2.1 cl-gbm

3 Files

3.1 Lisp

3.1.1 cl-gbm/cl-gbm.asd

3.1.2 cl-gbm/package.lisp

3.1.3 cl-gbm/cl-gbm.lisp

4 Packages

4.1 gbm

5 Definitions

5.1 Public Interface

5.1.1 Ordinary functions

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `cl-gbm`

3.1.1 `cl-gbm/cl-gbm.asd`

3.1.2 `cl-gbm/package.lisp`

3.1.3 `cl-gbm/cl-gbm.lisp`

4.1 `gbm`