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

The cl-egl Reference Manual

This is the cl-egl Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Tue Jul 15 03:48:35 2025 GMT+0.

Table of Contents

Next: Systems, Previous: The cl-egl Reference Manual, Up: The cl-egl Reference Manual [Contents][Index]

1 Introduction

Next: Files, Previous: Introduction, Up: The cl-egl Reference Manual [Contents][Index]

2 Systems

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

cl-egl

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

2.1 `cl-egl`

Common Lisp wrapper for libEGL

Author

Malcolm Still

License

BSD 3-Clause

Dependency

cffi (system).

Source

Child Components

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

Next: Packages, Previous: Systems, Up: The cl-egl Reference Manual [Contents][Index]

3 Files

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

Lisp

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

3.1 Lisp

cl-egl/cl-egl.asd
cl-egl/package.lisp
cl-egl/cl-egl.lisp

Next: cl-egl/package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

3.1.1 `cl-egl/cl-egl.asd`

Source: cl-egl.asd.
Parent Component: cl-egl (system).
ASDF Systems: cl-egl.

Next: cl-egl/cl-egl.lisp, Previous: cl-egl/cl-egl.asd, Up: Lisp [Contents][Index]

3.1.2 `cl-egl/package.lisp`

Source: cl-egl.asd.
Parent Component: cl-egl (system).
Packages: egl.

Previous: cl-egl/package.lisp, Up: Lisp [Contents][Index]

3.1.3 `cl-egl/cl-egl.lisp`

Dependency

package.lisp (file).

Source

Parent Component

cl-egl (system).

Public Interface

bind-api (function).
bind-wayland-display (function).
choose-config (function).
create-context (function).
create-image (function).
create-window-surface (function).
destroy-context (function).
destroy-image (function).
destroy-surface (function).
get-display (function).
get-proc-address (function).
image-target-texture-2does (function).
init-egl-wayland (function).
initialize (function).
make-current (function).
query-wayland-buffer (function).
swap-buffers (function).
terminate (function).

Internals

*bind-wayland-display* (special variable).
*image-target-texture-2does* (special variable).
*query-wayland-buffer* (special variable).
eglbindapi (function).
eglchooseconfig (function).
eglcreatecontext (function).
eglinitialize (function).
get-error (function).

Next: Definitions, Previous: Files, Up: The cl-egl Reference Manual [Contents][Index]

4 Packages

Packages are listed by definition order.

egl

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

4.1 `egl`

Source

package.lisp.

Use List

cffi.
common-lisp.

Public Interface

bind-api (function).
bind-wayland-display (function).
choose-config (function).
create-context (function).
create-image (function).
create-window-surface (function).
destroy-context (function).
destroy-image (function).
destroy-surface (function).
get-display (function).
get-proc-address (function).
image-target-texture-2does (function).
init-egl-wayland (function).
initialize (function).
make-current (function).
query-wayland-buffer (function).
swap-buffers (function).
terminate (function).

Internals

*bind-wayland-display* (special variable).
*image-target-texture-2does* (special variable).
*query-wayland-buffer* (special variable).
eglbindapi (function).
eglchooseconfig (function).
eglcreatecontext (function).
eglinitialize (function).
get-error (function).

Next: Indexes, Previous: Packages, Up: The cl-egl Reference Manual [Contents][Index]

5 Definitions

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

Public Interface
Internals

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

5.1 Public Interface

Ordinary functions

Previous: Public Interface, Up: Public Interface [Contents][Index]

5.1.1 Ordinary functions

Function: bind-api (api) ¶

Package: egl.
Source: cl-egl.lisp.

Function: bind-wayland-display (egl-display wl-display) ¶

Package: egl.
Source: cl-egl.lisp.

Function: choose-config (display config-size &rest config-attribs) ¶

Package: egl.
Source: cl-egl.lisp.

Function: create-context (display config share-context &rest attribs) ¶

Package: egl.
Source: cl-egl.lisp.

Function: create-image (display context target buffer attrib-list) ¶

Package: egl.
Source: cl-egl.lisp.

Function: create-window-surface (display config win attrib-list) ¶

Package: egl.
Source: cl-egl.lisp.

Function: destroy-context (display context) ¶

Package: egl.
Source: cl-egl.lisp.

Function: destroy-image (display image) ¶

Package: egl.
Source: cl-egl.lisp.

Function: destroy-surface (display surface) ¶

Package: egl.
Source: cl-egl.lisp.

Function: get-display (display-id) ¶

Package: egl.
Source: cl-egl.lisp.

Function: get-proc-address (name) ¶

Package: egl.
Source: cl-egl.lisp.

Function: image-target-texture-2does (attribute egl-image) ¶

Package: egl.
Source: cl-egl.lisp.

Function: init-egl-wayland () ¶

Package: egl.
Source: cl-egl.lisp.

Function: initialize (display) ¶

Package: egl.
Source: cl-egl.lisp.

Function: make-current (display draw read context) ¶

Package: egl.
Source: cl-egl.lisp.

Function: query-wayland-buffer (egl-display buffer attribute value) ¶

Package: egl.
Source: cl-egl.lisp.

Function: swap-buffers (display surface) ¶

Package: egl.
Source: cl-egl.lisp.

Function: terminate (display) ¶

Package: egl.
Source: cl-egl.lisp.

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

5.2 Internals

Special variables
Ordinary functions

Next: Ordinary functions, Previous: Internals, Up: Internals [Contents][Index]

5.2.1 Special variables

Special Variable: *bind-wayland-display* ¶

Package: egl.
Source: cl-egl.lisp.

Special Variable: *image-target-texture-2does* ¶

Package: egl.
Source: cl-egl.lisp.

Special Variable: *query-wayland-buffer* ¶

Package: egl.
Source: cl-egl.lisp.

Previous: Special variables, Up: Internals [Contents][Index]

5.2.2 Ordinary functions

Function: eglbindapi (api) ¶

Package: egl.
Source: cl-egl.lisp.

Function: eglchooseconfig (display attrib-list configs config-size num-config) ¶

Package: egl.
Source: cl-egl.lisp.

Function: eglcreatecontext (display config share-context attrib-list) ¶

Package: egl.
Source: cl-egl.lisp.

Function: eglinitialize (display major minor) ¶

Package: egl.
Source: cl-egl.lisp.

Function: get-error () ¶

Package: egl.
Source: cl-egl.lisp.

Previous: Definitions, Up: The cl-egl Reference Manual [Contents][Index]

Appendix A Indexes

Concepts
Functions
Variables
Data types

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

A.1 Concepts

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

A.2 Functions

Jump to:	B C D E F G I M Q S T

	Index Entry		Section

B
	`bind-api`:		Public ordinary functions
	`bind-wayland-display`:		Public ordinary functions

C
	`choose-config`:		Public ordinary functions
	`create-context`:		Public ordinary functions
	`create-image`:		Public ordinary functions
	`create-window-surface`:		Public ordinary functions

D
	`destroy-context`:		Public ordinary functions
	`destroy-image`:		Public ordinary functions
	`destroy-surface`:		Public ordinary functions

E
	`eglbindapi`:		Private ordinary functions
	`eglchooseconfig`:		Private ordinary functions
	`eglcreatecontext`:		Private ordinary functions
	`eglinitialize`:		Private ordinary functions

F
	`Function, bind-api`:		Public ordinary functions
	`Function, bind-wayland-display`:		Public ordinary functions
	`Function, choose-config`:		Public ordinary functions
	`Function, create-context`:		Public ordinary functions
	`Function, create-image`:		Public ordinary functions
	`Function, create-window-surface`:		Public ordinary functions
	`Function, destroy-context`:		Public ordinary functions
	`Function, destroy-image`:		Public ordinary functions
	`Function, destroy-surface`:		Public ordinary functions
	`Function, eglbindapi`:		Private ordinary functions
	`Function, eglchooseconfig`:		Private ordinary functions
	`Function, eglcreatecontext`:		Private ordinary functions
	`Function, eglinitialize`:		Private ordinary functions
	`Function, get-display`:		Public ordinary functions
	`Function, get-error`:		Private ordinary functions
	`Function, get-proc-address`:		Public ordinary functions
	`Function, image-target-texture-2does`:		Public ordinary functions
	`Function, init-egl-wayland`:		Public ordinary functions
	`Function, initialize`:		Public ordinary functions
	`Function, make-current`:		Public ordinary functions
	`Function, query-wayland-buffer`:		Public ordinary functions
	`Function, swap-buffers`:		Public ordinary functions
	`Function, terminate`:		Public ordinary functions

G
	`get-display`:		Public ordinary functions
	`get-error`:		Private ordinary functions
	`get-proc-address`:		Public ordinary functions

I
	`image-target-texture-2does`:		Public ordinary functions
	`init-egl-wayland`:		Public ordinary functions
	`initialize`:		Public ordinary functions

M
	`make-current`:		Public ordinary functions

Q
	`query-wayland-buffer`:		Public ordinary functions

S
	`swap-buffers`:		Public ordinary functions

T
	`terminate`:		Public ordinary functions

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

A.3 Variables

Jump to:	* S

	Index Entry		Section

*
	`bind-wayland-display`:		Private special variables
	`image-target-texture-2does`:		Private special variables
	`query-wayland-buffer`:		Private special variables

S
	`Special Variable, bind-wayland-display`:		Private special variables
	`Special Variable, image-target-texture-2does`:		Private special variables
	`Special Variable, query-wayland-buffer`:		Private special variables

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

A.4 Data types

Jump to:	C E F P S

	Index Entry		Section

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

E
	`egl`:		The egl package

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

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

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