doc/allegro.html

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">


<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    
    <title>Graphics and 2D Games programming using RingAllegro &mdash; Ring 1.0 documentation</title>
    
    <link rel="stylesheet" href="_static/classic.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    './',
        VERSION:     '1.0',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </script>
    <script type="text/javascript" src="_static/jquery.js"></script>
    <script type="text/javascript" src="_static/underscore.js"></script>
    <script type="text/javascript" src="_static/doctools.js"></script>
    <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
    <link rel="top" title="Ring 1.0 documentation" href="index.html" />
    <link rel="next" title="Desktop and Mobile development using RingQt" href="qt.html" />
    <link rel="prev" title="Code Generator for wrapping C/C++ Libraries" href="codegenerator.html" /> 
  </head>
  <body role="document">
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="qt.html" title="Desktop and Mobile development using RingQt"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="codegenerator.html" title="Code Generator for wrapping C/C++ Libraries"
             accesskey="P">previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="index.html">Ring 1.0 documentation</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <div class="section" id="graphics-and-2d-games-programming-using-ringallegro">
<h1>Graphics and 2D Games programming using RingAllegro<a class="headerlink" href="#graphics-and-2d-games-programming-using-ringallegro" title="Permalink to this headline">¶</a></h1>
<p>In this chapter we will learn how to use the allegro game programming library
in our Ring applications.</p>
<p>We have the file gamelib.ring that load the DLL library that contains wrappers for the Allegro functions</p>
<div class="highlight-none"><div class="highlight"><pre>Load &quot;allegro.rh&quot;
Loadlib(&quot;ring_allegro.dll&quot;)
</pre></div>
</div>
<p>The file gamelib.ring uses the Load instruction to execute the file allegro.rh which is a ring source
code file contains constants to be used in our programs.
Then using the function LoadLib() we can load the DLL library &#8220;ring_allegro.dll&#8221;.</p>
<p>To write portable code we can change the gamelib.ring to check the platform before
loading the DLL/So file.</p>
<div class="section" id="drawing-animation-and-input">
<span id="index-0"></span><h2>Drawing, Animation and Input<a class="headerlink" href="#drawing-animation-and-input" title="Permalink to this headline">¶</a></h2>
<p>The next example uses the Allegro library for drawing, moving objects on the screen and getting
input from the keyboard and the mouse.</p>
<div class="highlight-none"><div class="highlight"><pre>Load &quot;gamelib.ring&quot;

al_init()
al_init_image_addon()

display = al_create_display(640,480)

al_show_native_message_box(display, &quot;Hello&quot;, &quot;Welcome&quot;,
                        &quot;Using Allegro from the Ring programming language&quot;,
                        &quot;&quot;, 0);

al_clear_to_color(al_map_rgb(0,0,255))

BOUNCER_SIZE = 40
bouncer_x = 10
bouncer_y = 20
bouncer = al_create_bitmap(BOUNCER_SIZE, BOUNCER_SIZE)
al_set_target_bitmap(bouncer)
al_clear_to_color(al_map_rgb(255,0,255))

for x = 1 to 30
        bouncer_x += x
        bouncer_y += x
        al_set_target_bitmap(al_get_backbuffer(display))
        al_clear_to_color(al_map_rgb(0,0,0))
        al_draw_bitmap(bouncer, bouncer_x, bouncer_y, 0)
        al_draw_bitmap(bouncer, 200+bouncer_x,200+ bouncer_y, 0)
        al_flip_display()
        al_rest(0.1)
next

al_clear_to_color(al_map_rgb(255,255,255))
image = al_load_bitmap(&quot;man2.jpg&quot;)
al_draw_bitmap(image,200,200,0)
al_flip_display()
al_rest(2)

event_queue = al_create_event_queue()
al_register_event_source(event_queue, al_get_display_event_source(display))

ev = al_new_allegro_event()
timeout = al_new_allegro_timeout()
al_init_timeout(timeout, 0.06)

FPS = 60
timer = al_create_timer(1.0 / FPS)
al_register_event_source(event_queue, al_get_timer_event_source(timer))
al_start_timer(timer)
redraw = true

SCREEN_W = 640
SCREEN_H = 480
BOUNCER_SIZE = 32
bouncer_x = SCREEN_W / 2.0 - BOUNCER_SIZE / 2.0
bouncer_y = SCREEN_H / 2.0 - BOUNCER_SIZE / 2.0
bouncer_dx = -4.0
bouncer_dy = 4.0

al_install_mouse()
al_register_event_source(event_queue, al_get_mouse_event_source())

al_install_keyboard()
al_register_event_source(event_queue, al_get_keyboard_event_source())

KEY_UP = 1
KEY_DOWN = 2
KEY_LEFT = 3
KEY_RIGHT = 4
Key = [false,false,false,false]

while true
        al_wait_for_event_until(event_queue, ev, timeout)
        switch al_get_allegro_event_type(ev)
        on ALLEGRO_EVENT_DISPLAY_CLOSE
                exit
        on ALLEGRO_EVENT_TIMER

                # Animation
                if bouncer_x &lt; 0 or bouncer_x &gt; SCREEN_W - BOUNCER_SIZE
                        bouncer_dx = -bouncer_dx
                ok

                if bouncer_y &lt; 0 or bouncer_y &gt; SCREEN_H - BOUNCER_SIZE
                        bouncer_dy = -bouncer_dy
                ok

                bouncer_x += bouncer_dx
                bouncer_y += bouncer_dy

                # Keyboard
                if key[KEY_UP] and bouncer_y &gt;= 4.0
                        bouncer_y -= 4.0
                ok
                if key[KEY_DOWN] and bouncer_y &lt;= SCREEN_H - BOUNCER_SIZE - 4.0
                        bouncer_y += 4.0
                ok
                if key[KEY_LEFT] and bouncer_x &gt;= 4.0
                        bouncer_x -= 4.0
                ok
                if key[KEY_RIGHT] and bouncer_x &lt;= SCREEN_W - BOUNCER_SIZE - 4.0
                        bouncer_x += 4.0
                ok

                redraw = true

        on ALLEGRO_EVENT_MOUSE_AXES
                bouncer_x = al_get_allegro_event_mouse_x(ev)
                bouncer_y = al_get_allegro_event_mouse_y(ev)
        on ALLEGRO_EVENT_MOUSE_ENTER_DISPLAY
                bouncer_x = al_get_allegro_event_mouse_x(ev)
                bouncer_y = al_get_allegro_event_mouse_y(ev)
        on ALLEGRO_EVENT_MOUSE_BUTTON_UP
                exit
        on ALLEGRO_EVENT_KEY_DOWN
                switch al_get_allegro_event_keyboard_keycode(ev)
                        on ALLEGRO_KEY_UP
                                key[KEY_UP] = true
                        on ALLEGRO_KEY_DOWN
                                key[KEY_DOWN] = true
                        on ALLEGRO_KEY_LEFT
                                key[KEY_LEFT] = true
                        on ALLEGRO_KEY_RIGHT
                                key[KEY_RIGHT] = true
                off
        on ALLEGRO_EVENT_KEY_UP
                switch al_get_allegro_event_keyboard_keycode(ev)
                        on ALLEGRO_KEY_UP
                                key[KEY_UP] = false
                        on ALLEGRO_KEY_DOWN
                                key[KEY_DOWN] = false
                        on ALLEGRO_KEY_LEFT
                                key[KEY_LEFT] = false
                        on ALLEGRO_KEY_RIGHT
                                key[KEY_RIGHT] = false
                        on ALLEGRO_KEY_ESCAPE
                                exit
                off
        off
        if redraw and al_is_event_queue_empty(event_queue)
                redraw = false
                al_clear_to_color(al_map_rgb(0,0,0))
                al_draw_bitmap(bouncer, bouncer_x, bouncer_y, 0)
                al_flip_display()
        ok
        callgc()
end

al_destroy_timer(timer)
al_destroy_allegro_event(ev)
al_destroy_allegro_timeout(timeout)
al_destroy_event_queue(event_queue)
al_destroy_bitmap(bouncer)
al_destroy_bitmap(image)
al_destroy_display(display)
</pre></div>
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">In the previous example we used the function callgc() which is a Ring function to force calling the Garbage collector inside the While/End loop.</p>
</div>
<p>Program Output:</p>
<p>At first the program display a messagebox</p>
<img alt="Displaying a messagebox from our program" src="_images/ringalleg_shot1.jpg" />
<p>Then we see two rectangles are moving on the screen</p>
<img alt="Animation - Moving two rectangles in the screen" src="_images/ringalleg_shot2.jpg" />
<p>Then we see an image displayed on the screen</p>
<img alt="Displaying an image on the screen" src="_images/ringalleg_shot3.jpg" />
<p>Finally we have one rectangle, and we see it moving all of the time on
the screen but we can control it using the Mouse and/or the Keyborad</p>
<img alt="Animation and Getting Input from keyboard and the mouse to move the object" src="_images/ringalleg_shot4.jpg" />
</div>
<div class="section" id="using-truetype-fonts">
<span id="index-1"></span><h2>Using TrueType Fonts<a class="headerlink" href="#using-truetype-fonts" title="Permalink to this headline">¶</a></h2>
<p>In this example we will see how to use TrueType Fonts <a href="#id1"><span class="problematic" id="id2">*</span></a>.ttf in our Games using Allegro</p>
<div class="highlight-none"><div class="highlight"><pre>Load &quot;gamelib.ring&quot;

al_init()
al_init_font_addon()
al_init_ttf_addon()

display = al_create_display(800,600)

al_clear_to_color(al_map_rgb(0,0,255))
font = al_load_ttf_font(&quot;pirulen.ttf&quot;,14,0 )
al_draw_text(font, al_map_rgb(255,255,255), 10, 10,ALLEGRO_ALIGN_LEFT,
         &quot;Welcome to the Ring programming language&quot;)
al_flip_display()
al_rest(2)

al_destroy_display(display)
</pre></div>
</div>
<p>Screen Shot:</p>
<img alt="Using TrueType Fonts" src="_images/ringalleg_shot5.jpg" />
</div>
<div class="section" id="playing-sound-files">
<span id="index-2"></span><h2>Playing Sound Files<a class="headerlink" href="#playing-sound-files" title="Permalink to this headline">¶</a></h2>
<p>The next example play a sound file</p>
<div class="highlight-none"><div class="highlight"><pre>Load &quot;gamelib.ring&quot;

al_init()
al_install_audio()
al_init_acodec_addon()
al_reserve_samples(1)

sample = al_load_sample( &quot;footstep.wav&quot; )

sampleid = al_new_allegro_sample_id()
al_play_sample(sample, 1.0, 0.0,1.0,ALLEGRO_PLAYMODE_LOOP,sampleid)

display = al_create_display(640,480)
al_clear_to_color(al_map_rgb(0,0,255))
al_flip_display()
al_rest(10)

al_destroy_allegro_sample_id(sampleid)
al_destroy_sample(sample)
al_destroy_display(display)

al_exit()
</pre></div>
</div>
</div>
<div class="section" id="scaling-and-rotating-images">
<span id="index-3"></span><h2>Scaling and Rotating Images<a class="headerlink" href="#scaling-and-rotating-images" title="Permalink to this headline">¶</a></h2>
<p>The next example display and rotate an image</p>
<div class="highlight-none"><div class="highlight"><pre>Load &quot;gamelib.ring&quot;

al_init()
al_init_image_addon()

display = al_create_display(640,480)
al_set_target_bitmap(al_get_backbuffer(display))
al_clear_to_color(al_map_rgb(255,255,255))

image = al_load_bitmap(&quot;man2.jpg&quot;)
al_draw_rotated_bitmap(image,0,0,250,250,150,0)
al_draw_scaled_bitmap(image,0,0,250,250,20,20,400,400,0)

al_flip_display()
al_rest(2)

al_destroy_bitmap(image)
al_destroy_display(display)
</pre></div>
</div>
<p>Screen Shot:</p>
<img alt="Scaling and Rotating Images" src="_images/ringalleg_shot6.jpg" />
</div>
<div class="section" id="display-transparent-image">
<span id="index-4"></span><h2>Display Transparent Image<a class="headerlink" href="#display-transparent-image" title="Permalink to this headline">¶</a></h2>
<p>The next example display image with white background on another image</p>
<div class="highlight-none"><div class="highlight"><pre>Load &quot;gamelib.ring&quot;

al_init()
al_init_image_addon()

display = al_create_display(640,480)
imageback = al_load_bitmap(&quot;palace.jpg&quot;)
al_draw_bitmap(imageback,0,0,0)

image = al_load_bitmap(&quot;man4.png&quot;)
al_convert_mask_to_alpha(image,al_map_rgb(255,255,255))
al_draw_bitmap(image,0,0,0)
al_flip_display()
al_rest(10)

al_destroy_bitmap(image)
al_destroy_display(display)
</pre></div>
</div>
<p>Screen Shot:</p>
<img alt="Transparent Image" src="_images/ringalleg_shot7.jpg" />
</div>
<div class="section" id="using-threads">
<span id="index-5"></span><h2>Using Threads<a class="headerlink" href="#using-threads" title="Permalink to this headline">¶</a></h2>
<p>In this example we will learn how to users threads from the Allegro library</p>
<div class="highlight-none"><div class="highlight"><pre>Load &quot;gamelib.ring&quot;

o1 = new mythreads

Func Main
        al_init()
        for k = 1 to 5
                al_create_thread(&quot;o1.thread1()&quot;)
                al_create_thread(&quot;o1.thread2()&quot;)
                al_create_thread(&quot;o1.thread3()&quot;)
        next
        al_rest(2)

Class Mythreads

        cAppName = &quot;Threads Application&quot;

        Func Thread1
                for x = 1 to 5
                        see x + nl
                next
                See &#39;Thread(1) : Application Name : &#39;  + cAppName + nl

        Func Thread2
                for x = 1 to 5
                        see &#39;*****&#39; + x + nl
                next
                See &#39;Thread(2) : Application Name : &#39;  + cAppName + nl

        Func Thread3
                for x = 1 to 5
                        see &#39;!!!!&#39; + x + nl
                next
                See &#39;Thread(3) : Application Name : &#39;  + cAppName + nl
</pre></div>
</div>
<p>Output:</p>
<div class="highlight-none"><div class="highlight"><pre>1
2
3
4
5
Thread(1) : Application Name : Threads Application
*****1
*****2
*****3
*****4
*****5
Thread(2) : Application Name : Threads Application
!!!!1
!!!!2
!!!!3
!!!!4
!!!!5
Thread(3) : Application Name : Threads Application
1
2
3
4
5
Thread(1) : Application Name : Threads Application
!!!!1
!!!!2
!!!!3
!!!!4
!!!!5
Thread(3) : Application Name : Threads Application
*****1
*****2
*****3
*****4
*****5
Thread(2) : Application Name : Threads Application
*****1
*****2
*****3
*****4
*****5
Thread(2) : Application Name : Threads Application
!!!!1
!!!!2
!!!!3
!!!!4
!!!!5
Thread(3) : Application Name : Threads Application
1
2
3
4
5
Thread(1) : Application Name : Threads Application
*****1
*****2
*****3
*****1
*****4
*****2
!!!!1
*****5
*****3
1
!!!!2
Thread(2) : Application Name : Threads Application
1
*****4
!!!!1
2
!!!!3
!!!!4
*****5
!!!!2
3
2
!!!!5
Thread(2) : Application Name : Threads Application
!!!!3
4
3
Thread(3) : Application Name : Threads Application
!!!!4
5
4
!!!!5
Thread(1) : Application Name : Threads Application
5
Thread(3) : Application Name : Threads Application
Thread(1) : Application Name : Threads Application
</pre></div>
</div>
</div>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
  <h3><a href="index.html">Table Of Contents</a></h3>
  <ul>
<li><a class="reference internal" href="#">Graphics and 2D Games programming using RingAllegro</a><ul>
<li><a class="reference internal" href="#drawing-animation-and-input">Drawing, Animation and Input</a></li>
<li><a class="reference internal" href="#using-truetype-fonts">Using TrueType Fonts</a></li>
<li><a class="reference internal" href="#playing-sound-files">Playing Sound Files</a></li>
<li><a class="reference internal" href="#scaling-and-rotating-images">Scaling and Rotating Images</a></li>
<li><a class="reference internal" href="#display-transparent-image">Display Transparent Image</a></li>
<li><a class="reference internal" href="#using-threads">Using Threads</a></li>
</ul>
</li>
</ul>

  <h4>Previous topic</h4>
  <p class="topless"><a href="codegenerator.html"
                        title="previous chapter">Code Generator for wrapping C/C++ Libraries</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="qt.html"
                        title="next chapter">Desktop and Mobile development using RingQt</a></p>
  <div role="note" aria-label="source link">
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="_sources/allegro.txt"
            rel="nofollow">Show Source</a></li>
    </ul>
   </div>
<div id="searchbox" style="display: none" role="search">
  <h3>Quick search</h3>
    <form class="search" action="search.html" method="get">
      <input type="text" name="q" />
      <input type="submit" value="Go" />
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
    <p class="searchtip" style="font-size: 90%">
    Enter search terms or a module, class or function name.
    </p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="qt.html" title="Desktop and Mobile development using RingQt"
             >next</a> |</li>
        <li class="right" >
          <a href="codegenerator.html" title="Code Generator for wrapping C/C++ Libraries"
             >previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="index.html">Ring 1.0 documentation</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
        &copy; Copyright 2016, Mahmoud Samir Fayed.
      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.1.
    </div>
  </body>
</html>