Dan Leslie (email@example.com)
The allegro docs are divided up into pages by category.
Due to personal time constraints I have not fully tested these bindings, yet. If you discover any bugs, or even if you believe that some bindings could have a better implementation then please contact me with details.
And yes, the Egg does take a bloody long time to compile.
I have limited time these days. If you could undertake any of the following it would be greatly appreciated:
1. Submit issues you discover to the GitHub issue tracker 2. Submit feature requests to the GitHub issue tracker 3. Correct any errors you discover in this documentation page 4. Add documentation where it is lacking 5. Send me an email if you find this egg useful!
The main repository can be found on [https://github.com/dleslie/allegro-egg|GitHub].
Allegro versions 5.0.x up to 5.0.6 are supported. All 5.0.x versions should work, but features added post-5.0.6 will not be available.
Future version support will likely be added in the future. Patches are welcome!
A growing number of examples can be found on [https://github.com/dleslie/allegro-examples|GitHub].
Since building all your packages on windows is a bit of a pain in the ass I've written the Egg with the assumption that you're using the pre-built Allegro libraries. The only extra step you'll need to do, after installing the prebuilt Allegro bins to your MingW32 directory should be:
# cd /MingW/lib # cp liballegro-INSTALLED_VERSION-monolith-md.a liballegro.a
Assuming, of course, that you've installed MingW32 to C:\Mingw
In general, the naming is fairly indicative of the function's behaviour.
The gist is something like this:
- Constructs a type (Not always available)
- Constructs a type, returning a value which must be manually destructed
- Manually destructs a type (Not available for internally managed types)
- Accessor for value "noun" on a specific type
- Mutator for value "noun" on a specific type
- Method which requires a specific type to operate
- Method which modifies an object of a specific type
- Function which operates on the global state
- Function which operates on the global state, but also returns a value which must be manually destructed
If a function begins with a type name then you can be assured that the first parameter will be an object of that specific type.
Copyright 2012 Daniel J. Leslie. All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY DANIEL J. LESLIE AS IS AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL DANIEL J. LESLIE OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
The views and conclusions contained in the software and documentation are those of the authors and should not be interpreted as representing official policies, either expressed or implied, of Daniel J. Leslie.