This is the cl-openal Reference Manual, version 1.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 15:31:53 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
cl-openalCFFI bindings for OpenAL sound system.
Kat Marchán <kzm@sykosomatic.org>
Kat Marchán <kzm@sykosomatic.org>
public domain
1.0
cffi (system).
alexandria (system).
al (module).
Modules are listed depth-first from the system components tree.
cl-openal/alcl-openal (system).
packages.lisp (file).
bindings.lisp (file).
al.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
cl-openal/al/bindings.lisppackages.lisp (file).
al (module).
buffer-3f (function).
buffer-3i (function).
buffer-data (function).
buffer-f (function).
buffer-fv (function).
buffer-i (function).
buffer-iv (function).
delete-buffers (function).
delete-sources (function).
disable (function).
distance-model (function).
doppler-factor (function).
doppler-velocity (function).
enable (function).
ensure-double (class).
ensure-float (class).
ensure-integer (class).
expand-to-foreign (method).
expand-to-foreign (method).
expand-to-foreign (method).
gen-buffers (function).
gen-sources (function).
get-boolean (function).
get-boolean-v (function).
get-buffer-3f (function).
get-buffer-3i (function).
get-buffer-f (function).
get-buffer-fv (function).
get-buffer-i (function).
get-buffer-iv (function).
get-double (function).
get-double-v (function).
get-enum-value (function).
get-error (function).
get-float (function).
get-float-v (function).
get-integer (function).
get-integer-v (function).
get-listener-3f (function).
get-listener-3i (function).
get-listener-f (function).
get-listener-fv (function).
get-listener-i (function).
get-listener-iv (function).
get-proc-address (function).
get-source-3f (function).
get-source-3i (function).
get-source-f (function).
get-source-fv (function).
get-source-i (function).
get-source-iv (function).
get-string (function).
is-buffer (function).
is-enabled (function).
is-extension-present (function).
is-source (function).
listener-3f (function).
listener-3i (function).
listener-f (function).
listener-fv (function).
listener-i (function).
listener-iv (function).
source-3f (function).
source-3i (function).
source-f (function).
source-fv (function).
source-i (function).
source-iv (function).
source-pause (function).
source-pause-v (function).
source-play (function).
source-play-v (function).
source-queue-buffers (function).
source-rewind (function).
source-rewind-v (function).
source-stop (function).
source-stop-v (function).
source-unqueue-buffers (function).
speed-of-sound (function).
translate-to-foreign (method).
translate-to-foreign (method).
translate-to-foreign (method).
cl-openal/al/al.lisppackages.lisp (file).
bindings.lisp (file).
al (module).
*propagate-errors* (special variable).
al-error (condition).
buffer (function).
buffer-data (function).
bufferp (function).
defun-al (macro).
delete-buffer (function).
delete-buffers (function).
delete-source (function).
delete-sources (function).
disable (function).
distance-model (function).
doppler-factor (function).
doppler-velocity (function).
enable (function).
enabledp (function).
extension-present-p (function).
gen-buffer (function).
gen-buffers (function).
gen-source (function).
gen-sources (function).
get-boolean (function).
get-buffer (function).
get-enum-value (function).
get-error (function).
get-integer (function).
get-listener (function).
get-proc-address (function).
get-source (function).
get-string (function).
listener (function).
load-libraries (function).
peek-error (function).
propagate-error (function).
source (function).
source-pause (function).
source-play (function).
source-queue-buffers (function).
source-rewind (function).
source-stop (function).
source-unqueue-buffers (function).
sourcep (function).
speed-of-sound (function).
with-buffer (macro).
with-buffers (macro).
with-source (macro).
with-sources (macro).
*previous-error* (special variable).
clear-error (function).
errcode (reader method).
Packages are listed by definition order.
openal-cffi-bindings%al
cffi.
common-lisp.
buffer-3f (function).
buffer-3i (function).
buffer-data (function).
buffer-f (function).
buffer-fv (function).
buffer-i (function).
buffer-iv (function).
delete-buffers (function).
delete-sources (function).
disable (function).
distance-model (function).
doppler-factor (function).
doppler-velocity (function).
enable (function).
ensure-double (class).
ensure-float (class).
ensure-integer (class).
gen-buffers (function).
gen-sources (function).
get-boolean (function).
get-boolean-v (function).
get-buffer-3f (function).
get-buffer-3i (function).
get-buffer-f (function).
get-buffer-fv (function).
get-buffer-i (function).
get-buffer-iv (function).
get-double (function).
get-double-v (function).
get-enum-value (function).
get-error (function).
get-float (function).
get-float-v (function).
get-integer (function).
get-integer-v (function).
get-listener-3f (function).
get-listener-3i (function).
get-listener-f (function).
get-listener-fv (function).
get-listener-i (function).
get-listener-iv (function).
get-proc-address (function).
get-source-3f (function).
get-source-3i (function).
get-source-f (function).
get-source-fv (function).
get-source-i (function).
get-source-iv (function).
get-string (function).
is-buffer (function).
is-enabled (function).
is-extension-present (function).
is-source (function).
listener-3f (function).
listener-3i (function).
listener-f (function).
listener-fv (function).
listener-i (function).
listener-iv (function).
source-3f (function).
source-3i (function).
source-f (function).
source-fv (function).
source-i (function).
source-iv (function).
source-pause (function).
source-pause-v (function).
source-play (function).
source-play-v (function).
source-queue-buffers (function).
source-rewind (function).
source-rewind-v (function).
source-stop (function).
source-stop-v (function).
source-unqueue-buffers (function).
speed-of-sound (function).
cl-openalal
common-lisp.
*propagate-errors* (special variable).
al-error (condition).
buffer (function).
buffer-data (function).
bufferp (function).
defun-al (macro).
delete-buffer (function).
delete-buffers (function).
delete-source (function).
delete-sources (function).
disable (function).
distance-model (function).
doppler-factor (function).
doppler-velocity (function).
enable (function).
enabledp (function).
extension-present-p (function).
gen-buffer (function).
gen-buffers (function).
gen-source (function).
gen-sources (function).
get-boolean (function).
get-buffer (function).
get-enum-value (function).
get-error (function).
get-integer (function).
get-listener (function).
get-proc-address (function).
get-source (function).
get-string (function).
listener (function).
load-libraries (function).
peek-error (function).
propagate-error (function).
source (function).
source-pause (function).
source-play (function).
source-queue-buffers (function).
source-rewind (function).
source-stop (function).
source-unqueue-buffers (function).
sourcep (function).
speed-of-sound (function).
with-buffer (macro).
with-buffers (macro).
with-source (macro).
with-sources (macro).
*previous-error* (special variable).
clear-error (function).
errcode (generic reader).
Definitions are sorted by export status, category, package, and then by lexicographic order.
If set, PROPAGATE-ERROR will automatically be called after every operation. If NIL, it is the user’s responsibility to call GET-ERROR or PROPAGATE-ERROR
Helper macro to define a function wrapping an OpenAL operation. Functions just like
regular DEFUN, except for OpenAL error management:
* Before BODY, (CLEAR-ERROR) is called, so BODY is guaranteed to execute in a fresh
error context
* Inside BODY, a local macro CHECKPOINT is defined. Calling it will perform error
handling, the precise nature of which depends on the value of *PROPAGATE-ERRORS*:
- If *PROPAGATE-ERRORS* is set (default), (PROPAGATE-ERROR) will be called, and signal
if an error was detected
- If *PROPAGATE-ERRORS* is NIL (legacy behaviour), (PEEK-ERROR) will be called, and if
an error was detected, the function will immediately abort and return NIL
* (CHECKPOINT) should be inserted after every call to underlying OpenAL C functions, and
before any results are consumed. This ensures that no unsafe memory accesses can
happen if the operation failed. A call to CHECKPOINT will be appended at the end of
BODY automatically, so it’s not necessary to add it manually
Get the last AL error. If PEEK-ERROR has been called previously, the stored value will be cleared and returned. Otherwise, ‘alGetError’ will be called. If called between every AL operation, this will have the same effect of clearing the error state as the underlying ‘alGetError’ does. However, to clear the error state no matter what previous operations were performed, even if the user code did not properly inspect it, CLEAR-ERROR is preferable
Peek the current error. If no peek has been performed since last time the error state
was cleared, this call ‘alGetError’ internally, but store it in a location inspected by
GET-ERROR, so that it isn’t cleared until the user has a chance to inspect it. If an error
is already stored, return it immediately without touching the OpenAL error state.
This function should be used by library code to avoid irretrevably clearing the AL error state if operating in *PROPAGATE-ERRORS* NIL mode. End-user code should not be using it unless implementing custom wrappers; see GET-ERROR and CLEAR-ERROR instead
Call GET-ERROR, and if an error is detected, signal it wrapped in AL-ERROR. If OPERATION is provided, it will be included as context in the reported condition
ensure-float)) ¶cffi.
ensure-double)) ¶cffi.
ensure-integer)) ¶cffi.
ensure-float)) ¶cffi.
ensure-double)) ¶cffi.
ensure-integer)) ¶cffi.
enhanced-foreign-type.
| Initarg | Value |
|---|---|
:actual-type | (quote (double)) |
enhanced-foreign-type.
| Initarg | Value |
|---|---|
:actual-type | (quote (float)) |
enhanced-foreign-type.
| Initarg | Value |
|---|---|
:actual-type | (quote (int)) |
Internal: If non-NIL, stores the previous error reported by ‘alGetError’. Needed to implement PEEK-ERROR functionality
Unconditionally clear the previous error state. This guarantees that the effects of previous PEEK-ERROR calls are undone, and that ‘alGetError’ has been called. Returns the result of calling ‘alGetError’
| Jump to: | B C D E F G I L M P S T W |
|---|
| Jump to: | B C D E F G I L M P S T W |
|---|
| Jump to: | %
*
S |
|---|
| Jump to: | %
*
S |
|---|
| Jump to: | A B C E F M O P S |
|---|
| Jump to: | A B C E F M O P S |
|---|