The cl-egl Reference Manual

Table of Contents

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

The cl-egl Reference Manual

This is the cl-egl Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Fri Jun 26 10:10:07 2020 GMT+0.


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

1 Introduction

cl-egl

EGL is a cross-platform between OpenGL / OpenGL ES and native platform windowing systems. On Linux it allows using OpenGL without depending on X. cl-egl is a Common Lisp wrapper for libEGL.

Status

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

Installation

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

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

2 Systems

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


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

2.1 cl-egl

Author

Malcolm Still

License

BSD 3-Clause

Description

Common Lisp wrapper for libEGL

Dependency

cffi

Source

cl-egl.asd (file)

Components

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

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 files   [Contents][Index]

3.1.1 cl-egl.asd

Location

cl-egl.asd

Systems

cl-egl (system)


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

3.1.2 cl-egl/package.lisp

Parent

cl-egl (system)

Location

package.lisp

Packages

egl


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

3.1.3 cl-egl/cl-egl.lisp

Dependency

package.lisp (file)

Parent

cl-egl (system)

Location

cl-egl.lisp

Exported Definitions
Internal Definitions

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

4 Packages

Packages are listed by definition order.


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

4.1 egl

Source

package.lisp (file)

Use List
Exported Definitions
Internal Definitions

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

5 Definitions

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


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

5.1 Exported definitions


Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Functions

Function: bind-api API
Package

egl

Source

cl-egl.lisp (file)

Function: bind-wayland-display EGL-DISPLAY WL-DISPLAY
Package

egl

Source

cl-egl.lisp (file)

Function: choose-config DISPLAY CONFIG-SIZE &rest CONFIG-ATTRIBS
Package

egl

Source

cl-egl.lisp (file)

Function: create-context DISPLAY CONFIG SHARE-CONTEXT &rest ATTRIBS
Package

egl

Source

cl-egl.lisp (file)

Function: create-image DISPLAY CONTEXT TARGET BUFFER ATTRIB-LIST
Package

egl

Source

cl-egl.lisp (file)

Function: create-window-surface DISPLAY CONFIG WIN ATTRIB-LIST
Package

egl

Source

cl-egl.lisp (file)

Function: destroy-context DISPLAY CONTEXT
Package

egl

Source

cl-egl.lisp (file)

Function: destroy-image DISPLAY IMAGE
Package

egl

Source

cl-egl.lisp (file)

Function: destroy-surface DISPLAY SURFACE
Package

egl

Source

cl-egl.lisp (file)

Function: get-display DISPLAY-ID
Package

egl

Source

cl-egl.lisp (file)

Function: get-proc-address NAME
Package

egl

Source

cl-egl.lisp (file)

Function: image-target-texture-2does ATTRIBUTE EGL-IMAGE
Package

egl

Source

cl-egl.lisp (file)

Function: init-egl-wayland ()
Package

egl

Source

cl-egl.lisp (file)

Function: initialize DISPLAY
Package

egl

Source

cl-egl.lisp (file)

Function: make-current DISPLAY DRAW READ CONTEXT
Package

egl

Source

cl-egl.lisp (file)

Function: query-wayland-buffer EGL-DISPLAY BUFFER ATTRIBUTE VALUE
Package

egl

Source

cl-egl.lisp (file)

Function: swap-buffers DISPLAY SURFACE
Package

egl

Source

cl-egl.lisp (file)

Function: terminate DISPLAY
Package

egl

Source

cl-egl.lisp (file)


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

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Special variables

Special Variable: *bind-wayland-display*
Package

egl

Source

cl-egl.lisp (file)

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

egl

Source

cl-egl.lisp (file)

Special Variable: *query-wayland-buffer*
Package

egl

Source

cl-egl.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

5.2.2 Functions

Function: eglbindapi API
Package

egl

Source

cl-egl.lisp (file)

Function: eglchooseconfig DISPLAY ATTRIB-LIST CONFIGS CONFIG-SIZE NUM-CONFIG
Package

egl

Source

cl-egl.lisp (file)

Function: eglcreatecontext DISPLAY CONFIG SHARE-CONTEXT ATTRIB-LIST
Package

egl

Source

cl-egl.lisp (file)

Function: eglinitialize DISPLAY MAJOR MINOR
Package

egl

Source

cl-egl.lisp (file)

Function: get-error ()
Package

egl

Source

cl-egl.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section

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

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

L
Lisp File, cl-egl.asd: The cl-egl․asd file
Lisp File, cl-egl/cl-egl.lisp: The cl-egl/cl-egl․lisp file
Lisp File, cl-egl/package.lisp: The cl-egl/package․lisp file

Jump to:   C   F   L  

Next: , Previous: , 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: Exported functions
bind-wayland-display: Exported functions

C
choose-config: Exported functions
create-context: Exported functions
create-image: Exported functions
create-window-surface: Exported functions

D
destroy-context: Exported functions
destroy-image: Exported functions
destroy-surface: Exported functions

E
eglbindapi: Internal functions
eglchooseconfig: Internal functions
eglcreatecontext: Internal functions
eglinitialize: Internal functions

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

G
get-display: Exported functions
get-error: Internal functions
get-proc-address: Exported functions

I
image-target-texture-2does: Exported functions
init-egl-wayland: Exported functions
initialize: Exported functions

M
make-current: Exported functions

Q
query-wayland-buffer: Exported functions

S
swap-buffers: Exported functions

T
terminate: Exported functions

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

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

A.3 Variables

Jump to:   *  
S  
Index Entry  Section

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

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

Jump to:   *  
S  

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

A.4 Data types

Jump to:   C   E   P   S  
Index Entry  Section

C
cl-egl: The cl-egl system

E
egl: The egl package

P
Package, egl: The egl package

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

Jump to:   C   E   P   S