source: project/wiki/eggref/5/allegro @ 37246

Last change on this file since 37246 was 37246, checked in by svnwiki, 7 months ago

Anonymous wiki edit for IP [69.172.150.121]:

File size: 4.0 KB
Line 
1[[tags: allegro game]]
2
3== allegro
4
5[[http://alleg.sourceforge.net/readme.html|Allegro 5.0 bindings for Chicken.]]
6
7[[toc:]]
8
9== Author
10
11Dan Leslie (dan@ironoxide.ca)
12
13== Subpages
14
15The allegro docs are divided up into pages by category.
16
17* [[/eggref/5/allegro/audio|audio]]
18* [[/eggref/5/allegro/bitmap|bitmap]]
19* [[/eggref/5/allegro/color|color]]
20* [[/eggref/5/allegro/config|config]]
21* [[/eggref/5/allegro/debugging|debugging]]
22* [[/eggref/5/allegro/display|display]]
23* [[/eggref/5/allegro/drawing|drawing]]
24* [[/eggref/5/allegro/events|events]]
25* [[/eggref/5/allegro/file|file]]
26* [[/eggref/5/allegro/font|font]]
27* [[/eggref/5/allegro/input|input]]
28* [[/eggref/5/allegro/math|math]]
29* [[/eggref/5/allegro/memory|memory]]
30* [[/eggref/5/allegro/system|system]]
31
32== Repository
33
34The main repository can be found on [[https://github.com/dleslie/allegro-egg|GitHub]].
35
36== Supported Versions
37
38Allegro versions 5.0.x up to 5.2.x are supported.
39
40Future version support will likely be added in the future. Patches are welcome!
41
42== Examples
43
44A growing number of examples can be found on [[https://github.com/dleslie/allegro-examples|GitHub]].
45
46Please contribute!
47
48== Windows Extras
49
50Since 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.
51The only extra step you'll need to do, after installing the prebuilt Allegro bins to your MingW32 directory should be:
52
53<enscript hilight="bash">
54# cd /MingW/lib
55# cp liballegro-INSTALLED_VERSION-monolith-md.a liballegro.a
56</enscript>
57
58Assuming, of course, that you've installed MingW32 to C:\Mingw
59
60== Naming Key
61
62In general, the naming is fairly indicative of the function's behaviour.
63
64The gist is something like this:
65
66; make-type : Constructs a type (Not always available)
67; make-type* : Constructs a type, returning a value which must be manually destructed
68; free-type! : Manually destructs a type (Not available for internally managed types)
69; type-noun : Accessor for value "noun" on a specific type
70; type-noun-set! : Mutator for value "noun" on a specific type
71; type-verb : Method which requires a specific type to operate
72; type-verb! : Method which modifies an object of a specific type
73; verbage : Function which operates on the global state
74; verbage* : Function which operates on the global state, but also returns a value which must be manually destructed
75
76If a function begins with a type name then you can be assured that the first parameter will be an object of that specific type.
77
78== License
79
80 Copyright 2012-2019 Daniel J. Leslie. All rights reserved.
81 
82 Redistribution and use in source and binary forms, with or without modification, are
83permitted provided that the following conditions are met:
84
85   1. Redistributions of source code must retain the above copyright notice, this list of
86      conditions and the following disclaimer.
87
88   2. Redistributions in binary form must reproduce the above copyright notice, this list
89      of conditions and the following disclaimer in the documentation and/or other materials
90      provided with the distribution.
91
92 THIS SOFTWARE IS PROVIDED BY DANIEL J. LESLIE ''AS IS'' AND ANY EXPRESS OR IMPLIED
93 WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
94 FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL DANIEL J. LESLIE OR
95 CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
96 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
97 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
98 ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
99 NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
100 ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
101
102 The views and conclusions contained in the software and documentation are those of the
103 authors and should not be interpreted as representing official policies, either expressed
104 or implied, of Daniel J. Leslie.
Note: See TracBrowser for help on using the repository browser.