From 44440d6ee1f94a2f634b47a24259aa6fc448fc5d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kat=20March=C3=A1n?= Date: Tue, 3 Aug 2010 01:50:16 -0500 Subject: [PATCH] New README --- README | 12 ------------ README.TOO | 18 ------------------ README.mkdn | 48 ++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 48 insertions(+), 30 deletions(-) delete mode 100644 README delete mode 100644 README.TOO create mode 100644 README.mkdn diff --git a/README b/README deleted file mode 100644 index 468c78e..0000000 --- a/README +++ /dev/null @@ -1,12 +0,0 @@ -cl-openal is a series of (largely untested) semi-lispy bindings to the OpenAL library. AL, ALC, and -ALUT all have bindings written for them. The bindings follow basically a translation of naming -schemes, and work mostly the same way. Enums are usually just :keywords with AL_/ALC_/ALUT_ removed, -camelCaps are rewritten in a lispier-style, isSuchAndSuch -> such-and-such-p; isSuch -> suchp, etc. -There are some convenient additions, though, such as being able to pass lists into functions instead -of having to allocate foreign objects (and receive lists from some functions that would require -pointers). Things should be pretty clear by just looking at packages.lisp, or the source files. -Actual documentation will come eventually. These are very new, so use them at your own risk. - -cl-openal depends on CFFI to load. You'll also need to have openal and alut installed in your -system, and accessible to lisp. - diff --git a/README.TOO b/README.TOO deleted file mode 100644 index af4eba2..0000000 --- a/README.TOO +++ /dev/null @@ -1,18 +0,0 @@ -(OpenAL Programming Guide says that buffers can not be destroyed -while they are queued. Sources, on the other hand, can be destroyed -while buffers are queued on them. - -For this reason it seems a good idea to do: - - (with-buffers .... - (with-sources ... - (queueing code))) - -instead of - (with-sources .... - (with-buffers ... - (queueing code))) - - -Same goes for WITH-SOURCES which you want to wrap in WITH-CONTEXT. - diff --git a/README.mkdn b/README.mkdn new file mode 100644 index 0000000..9929c39 --- /dev/null +++ b/README.mkdn @@ -0,0 +1,48 @@ +About +----- + +cl-openal is a series of semi-lispy public domain bindings to the OpenAL API. It includes direct +CFFI bindings, as well as varying levels of lispy wrappings around AL, ALC, and ALUT. + +The translation from the C bindings to lispy bindings is pretty straightforward, and follows +cl-opengl's example, in spirit. + +Loading +------- + +cl-openal depends on CFFI to load. It's split into three separate systems: cl-openal for the basic +OpenAL bindings, cl-alc for ALC, and cl-alut for ALUT. If you need anything from ALC or ALUT, you'll +have to specifically load them. + +In order to use cl-openal and cl-alc, you'll need to have OpenAL installed on your system, or +available as a shared library/.dll. Additionally, an implementation of ALUT needs to be available in +order to use cl-alut (such as freealut). + +cl-openal should run on all major platforms, including Linux, the BSDs, OSX, and Windows. It should +be usable by any Common Lisp implementation supported by CFFI. + +Support +------- + +If you have any questions, you may contact me at . Patches or similar +always welcome! + +Extra Notes +----------- + +The OpenAL Programming Guide says that buffers can not be destroyed while they are queued. Sources, +on the other hand, can be destroyed while buffers are queued on them. + +For this reason it's probably a good idea to do: + + (with-buffers ... + (with-sources ... + (queueing code))) + +instead of + + (with-sources ... + (with-buffers ... + (queueing code))) + +Same goes for WITH-SOURCES which you want to wrap in WITH-CONTEXT.