diff options
Diffstat (limited to 'docs/html/class_screen_panel.html')
| -rw-r--r-- | docs/html/class_screen_panel.html | 508 |
1 files changed, 508 insertions, 0 deletions
diff --git a/docs/html/class_screen_panel.html b/docs/html/class_screen_panel.html new file mode 100644 index 0000000..cc72a9f --- /dev/null +++ b/docs/html/class_screen_panel.html @@ -0,0 +1,508 @@ +<!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/xhtml;charset=UTF-8"/> +<title>Rally X: ScreenPanel Class Reference</title> + +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> + +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="search/search.js"></script> +<script type="text/javascript"> + $(document).ready(function() { searchBox.OnSelectItem(0); }); +</script> + +</head> +<body> +<div id="top"><!-- do not remove this div! --> + + +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + + <td id="projectlogo"><img alt="Logo" src="car.PNG"/></td> + + + <td style="padding-left: 0.5em;"> + <div id="projectname">Rally X + + </div> + <div id="projectbrief">ELEN3009 Project by Justin Wernick and David Schneider</div> + </td> + + + + </tr> + </tbody> +</table> +</div> + +<!-- Generated by Doxygen 1.7.5.1 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> + <div id="navrow1" class="tabs"> + <ul class="tablist"> + <li><a href="index.html"><span>Main Page</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + <li> + <div id="MSearchBox" class="MSearchBoxInactive"> + <span class="left"> + <img id="MSearchSelect" src="search/mag_sel.png" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + alt=""/> + <input type="text" id="MSearchField" value="Search" accesskey="S" + onfocus="searchBox.OnSearchFieldFocus(true)" + onblur="searchBox.OnSearchFieldFocus(false)" + onkeyup="searchBox.OnSearchFieldChange(event)"/> + </span><span class="right"> + <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> + </span> + </div> + </li> + </ul> + </div> + <div id="navrow2" class="tabs2"> + <ul class="tablist"> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="classes.html"><span>Class Index</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> +</div> +<div class="header"> + <div class="summary"> +<a href="#pub-methods">Public Member Functions</a> | +<a href="#pro-attribs">Protected Attributes</a> | +<a href="#pro-static-attribs">Static Protected Attributes</a> | +<a href="#pri-methods">Private Member Functions</a> | +<a href="#pri-attribs">Private Attributes</a> </div> + <div class="headertitle"> +<div class="title">ScreenPanel Class Reference</div> </div> +</div> +<div class="contents"> +<!-- doxytag: class="ScreenPanel" --> +<p>Parent class for panels that are drawn on the screen. + <a href="class_screen_panel.html#details">More...</a></p> + +<p><code>#include <<a class="el" href="_screen_panel_8h_source.html">ScreenPanel.h</a>></code></p> +<div class="dynheader"> +Inheritance diagram for ScreenPanel:</div> +<div class="dyncontent"> + <div class="center"> + <img src="class_screen_panel.png" usemap="#ScreenPanel_map" alt=""/> + <map id="ScreenPanel_map" name="ScreenPanel_map"> +<area href="class_game_panel.html" title="ScreenPanel to be drawn on the screen to draw the area where the game takes place." alt="GamePanel" shape="rect" coords="0,56,85,80"/> +<area href="class_info_panel.html" title="ScreenPanel to be drawn on the screen to give the player information." alt="InfoPanel" shape="rect" coords="95,56,180,80"/> +</map> + </div></div> + +<p><a href="class_screen_panel-members.html">List of all members.</a></p> +<table class="memberdecls"> +<tr><td colspan="2"><h2><a name="pub-methods"></a> +Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_screen_panel.html#a8c13559489444ea8131066fa5b884645">ScreenPanel</a> (ALLEGRO_BITMAP *back, ALLEGRO_BITMAP *front, int x, int y, int width, int height)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a <a class="el" href="class_screen_panel.html" title="Parent class for panels that are drawn on the screen.">ScreenPanel</a> from the given back and front buffers. <a href="#a8c13559489444ea8131066fa5b884645"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_screen_panel.html#a843296c130c75beb41ada9ba3eddd457">~ScreenPanel</a> ()</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor to ensure that sub-bitmap memory is deallocated. <a href="#a843296c130c75beb41ada9ba3eddd457"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_screen_panel.html#ab4299f065cdf3e344c3b32b484136ada">draw</a> (const <a class="el" href="class_maze.html">Maze</a> &maze, const list< <a class="el" href="class_player_car.html">PlayerCar</a> > &players, const list< <a class="el" href="class_enemy_car.html">EnemyCar</a> > &enemies, const list< <a class="el" href="class_checkpoint.html">Checkpoint</a> > &checkpoints, const list< <a class="el" href="class_rock.html">Rock</a> > &rocks, const list< <a class="el" href="class_smokescreen.html">Smokescreen</a> > &smokescreens, const list< <a class="el" href="class_destroyed_object_popup.html">DestroyedObjectPopup</a> > &popups)=0</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Pure virtual method for drawing a collection of objects onto the panel. <a href="#ab4299f065cdf3e344c3b32b484136ada"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_screen_panel.html#ab701d3888b13463d200be112f0eb4d82">flip</a> ()</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Swaps the front and back buffers. <a href="#ab701d3888b13463d200be112f0eb4d82"></a><br/></td></tr> +<tr><td colspan="2"><h2><a name="pro-attribs"></a> +Protected Attributes</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">ALLEGRO_BITMAP * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_screen_panel.html#a1a3ec8e60be5d5cede210171bda33468">_back</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">The back buffer. Only the back buffer can be drawn to. <a href="#a1a3ec8e60be5d5cede210171bda33468"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_screen_panel.html#afbbcad2a101b95869dcdef9bf0898f65">_width</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">The width of the sub-bitmaps being drawn to in pixels. <a href="#afbbcad2a101b95869dcdef9bf0898f65"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_screen_panel.html#a4f6dd5c7ca10d51bface7b1ddedc236c">_height</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">The height of the sub-bitmaps being drawn to in pixels. <a href="#a4f6dd5c7ca10d51bface7b1ddedc236c"></a><br/></td></tr> +<tr><td colspan="2"><h2><a name="pro-static-attribs"></a> +Static Protected Attributes</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">static const ALLEGRO_COLOR </td><td class="memItemRight" valign="bottom"><a class="el" href="class_screen_panel.html#a1cc6ea44035f47d77d24b4cee9dc9d85">BLANK</a> = al_map_rgb(0,0,0)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Colour used to clear the screen at the beginning of drawing operations. <a href="#a1cc6ea44035f47d77d24b4cee9dc9d85"></a><br/></td></tr> +<tr><td colspan="2"><h2><a name="pri-methods"></a> +Private Member Functions</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_screen_panel.html#a60c670cbb4930adcb77dc3002fdeb4df">ScreenPanel</a> (const <a class="el" href="class_screen_panel.html">ScreenPanel</a> &ref)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor not implemented, ScreenPanels should not be copied. <a href="#a60c670cbb4930adcb77dc3002fdeb4df"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_screen_panel.html">ScreenPanel</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_screen_panel.html#a896035d9c68aecd6ca802e2223d26ec5">operator=</a> (const <a class="el" href="class_screen_panel.html">ScreenPanel</a> &rhs)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Assignment operator not implemented, ScreenPanels should not be copied. <a href="#a896035d9c68aecd6ca802e2223d26ec5"></a><br/></td></tr> +<tr><td colspan="2"><h2><a name="pri-attribs"></a> +Private Attributes</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_allegro_init.html">AllegroInit</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_screen_panel.html#a3877f04c03866e35588f0b753ee7c485">_allegro</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Handles dependencies on Allegro being initialised. <a href="#a3877f04c03866e35588f0b753ee7c485"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">ALLEGRO_BITMAP * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_screen_panel.html#a0a3232c41ca107b2cceee73aa0e0d7fe">_front</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">The front buffer, that is currently being shown on the screen. <a href="#a0a3232c41ca107b2cceee73aa0e0d7fe"></a><br/></td></tr> +</table> +<hr/><a name="details" id="details"></a><h2>Detailed Description</h2> +<div class="textblock"><p>Parent class for panels that are drawn on the screen. </p> +<p>Panels are given a sub-bitmap of the <a class="el" href="class_screen.html" title="Class for creating a window on the screen.">Screen</a> bitmap, which they draw their panel specific outputs on. The <a class="el" href="class_screen_panel.html" title="Parent class for panels that are drawn on the screen.">ScreenPanel</a> class is subclassed to give specific drawing functions, like drawing the <a class="el" href="class_maze.html" title="A rectangular 2D boolean array, representing where cars can drive and where they cannot.">Maze</a> and GameObjects on the screen.</p> +<p>When the object is created, the back bitmap and front bitmap should correspond to the back and front buffers of the display respectively. This should be kept in sync by calling flip every time the display is flipped.</p> +<dl class="author"><dt><b>Author:</b></dt><dd>Justin Wernick </dd> +<dd> +David Schneider </dd></dl> + +<p>Definition at line <a class="el" href="_screen_panel_8h_source.html#l00029">29</a> of file <a class="el" href="_screen_panel_8h_source.html">ScreenPanel.h</a>.</p> +</div><hr/><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" id="a8c13559489444ea8131066fa5b884645"></a><!-- doxytag: member="ScreenPanel::ScreenPanel" ref="a8c13559489444ea8131066fa5b884645" args="(ALLEGRO_BITMAP *back, ALLEGRO_BITMAP *front, int x, int y, int width, int height)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">ScreenPanel::ScreenPanel </td> + <td>(</td> + <td class="paramtype">ALLEGRO_BITMAP * </td> + <td class="paramname"><em>back</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">ALLEGRO_BITMAP * </td> + <td class="paramname"><em>front</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>x</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>y</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>width</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>height</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Creates a <a class="el" href="class_screen_panel.html" title="Parent class for panels that are drawn on the screen.">ScreenPanel</a> from the given back and front buffers. </p> +<p>The sub-bitmaps that <a class="el" href="class_screen_panel.html" title="Parent class for panels that are drawn on the screen.">ScreenPanel</a> uses are created from a rectangular region on back and front that has its top left corner at the coordinate x,y, is width long in the x direction, and height long in the y direction.</p> +<dl><dt><b>Parameters:</b></dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">back</td><td>The current back buffer of the display being sub-bitmapped. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">front</td><td>The current front buffer (image currently being displayed) of the display being sub-bitmapped. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">x</td><td>The x coordinate of the left side of the sub-bitmap in pixels. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">y</td><td>The x coordinate of the top of the sub-bitmap in pixels. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">width</td><td>The length in the x direction of the new sub-bitmap in pixels. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">height</td><td>The length in the y direction of the new sub-bitmap in pixels. </td></tr> + </table> + </dd> +</dl> + +<p>Definition at line <a class="el" href="_screen_panel_8cpp_source.html#l00005">5</a> of file <a class="el" href="_screen_panel_8cpp_source.html">ScreenPanel.cpp</a>.</p> + +</div> +</div> +<a class="anchor" id="a843296c130c75beb41ada9ba3eddd457"></a><!-- doxytag: member="ScreenPanel::~ScreenPanel" ref="a843296c130c75beb41ada9ba3eddd457" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">ScreenPanel::~ScreenPanel </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td><code> [virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Destructor to ensure that sub-bitmap memory is deallocated. </p> + +<p>Definition at line <a class="el" href="_screen_panel_8cpp_source.html#l00013">13</a> of file <a class="el" href="_screen_panel_8cpp_source.html">ScreenPanel.cpp</a>.</p> + +</div> +</div> +<a class="anchor" id="a60c670cbb4930adcb77dc3002fdeb4df"></a><!-- doxytag: member="ScreenPanel::ScreenPanel" ref="a60c670cbb4930adcb77dc3002fdeb4df" args="(const ScreenPanel &ref)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">ScreenPanel::ScreenPanel </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="class_screen_panel.html">ScreenPanel</a> & </td> + <td class="paramname"><em>ref</em></td><td>)</td> + <td><code> [private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Copy constructor not implemented, ScreenPanels should not be copied. </p> + +</div> +</div> +<hr/><h2>Member Function Documentation</h2> +<a class="anchor" id="ab4299f065cdf3e344c3b32b484136ada"></a><!-- doxytag: member="ScreenPanel::draw" ref="ab4299f065cdf3e344c3b32b484136ada" args="(const Maze &maze, const list< PlayerCar > &players, const list< EnemyCar > &enemies, const list< Checkpoint > &checkpoints, const list< Rock > &rocks, const list< Smokescreen > &smokescreens, const list< DestroyedObjectPopup > &popups)=0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void ScreenPanel::draw </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="class_maze.html">Maze</a> & </td> + <td class="paramname"><em>maze</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const list< <a class="el" href="class_player_car.html">PlayerCar</a> > & </td> + <td class="paramname"><em>players</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const list< <a class="el" href="class_enemy_car.html">EnemyCar</a> > & </td> + <td class="paramname"><em>enemies</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const list< <a class="el" href="class_checkpoint.html">Checkpoint</a> > & </td> + <td class="paramname"><em>checkpoints</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const list< <a class="el" href="class_rock.html">Rock</a> > & </td> + <td class="paramname"><em>rocks</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const list< <a class="el" href="class_smokescreen.html">Smokescreen</a> > & </td> + <td class="paramname"><em>smokescreens</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const list< <a class="el" href="class_destroyed_object_popup.html">DestroyedObjectPopup</a> > & </td> + <td class="paramname"><em>popups</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td><code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Pure virtual method for drawing a collection of objects onto the panel. </p> +<p>Implementations do not need to draw all of the objects if it is not neccesary for the type of panel, but the interface accepts all of them to be general.</p> +<dl><dt><b>Parameters:</b></dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">maze</td><td>The <a class="el" href="class_maze.html" title="A rectangular 2D boolean array, representing where cars can drive and where they cannot.">Maze</a> that all of the objects are in. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">players</td><td>The list of PlayerCars to be drawn. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">enemies</td><td>The list of EnemyCars to be drawn. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">checkpoints</td><td>The list of Checkpoints to be drawn. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">rocks</td><td>The list of Rocks to be drawn. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">smokescreens</td><td>The list of Smokescreens to be drawn. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">popups</td><td>The list of DestroyedObjectPopups to be drawn. </td></tr> + </table> + </dd> +</dl> + +<p>Implemented in <a class="el" href="class_info_panel.html#aa9628c14e08ac6573e0191d9d4afa227">InfoPanel</a>, and <a class="el" href="class_game_panel.html#ab093fb770fa8b46ee863947259c72abd">GamePanel</a>.</p> + +</div> +</div> +<a class="anchor" id="ab701d3888b13463d200be112f0eb4d82"></a><!-- doxytag: member="ScreenPanel::flip" ref="ab701d3888b13463d200be112f0eb4d82" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void ScreenPanel::flip </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td><code> [virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Swaps the front and back buffers. </p> +<p>This function should be called every time the display is flipped. </p> + +<p>Definition at line <a class="el" href="_screen_panel_8cpp_source.html#l00019">19</a> of file <a class="el" href="_screen_panel_8cpp_source.html">ScreenPanel.cpp</a>.</p> + +</div> +</div> +<a class="anchor" id="a896035d9c68aecd6ca802e2223d26ec5"></a><!-- doxytag: member="ScreenPanel::operator=" ref="a896035d9c68aecd6ca802e2223d26ec5" args="(const ScreenPanel &rhs)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="class_screen_panel.html">ScreenPanel</a>& ScreenPanel::operator= </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="class_screen_panel.html">ScreenPanel</a> & </td> + <td class="paramname"><em>rhs</em></td><td>)</td> + <td><code> [private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Assignment operator not implemented, ScreenPanels should not be copied. </p> + +</div> +</div> +<hr/><h2>Member Data Documentation</h2> +<a class="anchor" id="a3877f04c03866e35588f0b753ee7c485"></a><!-- doxytag: member="ScreenPanel::_allegro" ref="a3877f04c03866e35588f0b753ee7c485" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="class_allegro_init.html">AllegroInit</a> <a class="el" href="class_screen_panel.html#a3877f04c03866e35588f0b753ee7c485">ScreenPanel::_allegro</a><code> [private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Handles dependencies on Allegro being initialised. </p> + +<p>Reimplemented in <a class="el" href="class_game_panel.html#a18c100c8d9ae2601a97083485d937418">GamePanel</a>.</p> + +<p>Definition at line <a class="el" href="_screen_panel_8h_source.html#l00093">93</a> of file <a class="el" href="_screen_panel_8h_source.html">ScreenPanel.h</a>.</p> + +</div> +</div> +<a class="anchor" id="a1a3ec8e60be5d5cede210171bda33468"></a><!-- doxytag: member="ScreenPanel::_back" ref="a1a3ec8e60be5d5cede210171bda33468" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">ALLEGRO_BITMAP* <a class="el" href="class_screen_panel.html#a1a3ec8e60be5d5cede210171bda33468">ScreenPanel::_back</a><code> [protected]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>The back buffer. Only the back buffer can be drawn to. </p> + +<p>Definition at line <a class="el" href="_screen_panel_8h_source.html#l00079">79</a> of file <a class="el" href="_screen_panel_8h_source.html">ScreenPanel.h</a>.</p> + +</div> +</div> +<a class="anchor" id="a0a3232c41ca107b2cceee73aa0e0d7fe"></a><!-- doxytag: member="ScreenPanel::_front" ref="a0a3232c41ca107b2cceee73aa0e0d7fe" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">ALLEGRO_BITMAP* <a class="el" href="class_screen_panel.html#a0a3232c41ca107b2cceee73aa0e0d7fe">ScreenPanel::_front</a><code> [private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>The front buffer, that is currently being shown on the screen. </p> + +<p>Definition at line <a class="el" href="_screen_panel_8h_source.html#l00095">95</a> of file <a class="el" href="_screen_panel_8h_source.html">ScreenPanel.h</a>.</p> + +</div> +</div> +<a class="anchor" id="a4f6dd5c7ca10d51bface7b1ddedc236c"></a><!-- doxytag: member="ScreenPanel::_height" ref="a4f6dd5c7ca10d51bface7b1ddedc236c" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int <a class="el" href="class_screen_panel.html#a4f6dd5c7ca10d51bface7b1ddedc236c">ScreenPanel::_height</a><code> [protected]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>The height of the sub-bitmaps being drawn to in pixels. </p> + +<p>Definition at line <a class="el" href="_screen_panel_8h_source.html#l00082">82</a> of file <a class="el" href="_screen_panel_8h_source.html">ScreenPanel.h</a>.</p> + +</div> +</div> +<a class="anchor" id="afbbcad2a101b95869dcdef9bf0898f65"></a><!-- doxytag: member="ScreenPanel::_width" ref="afbbcad2a101b95869dcdef9bf0898f65" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int <a class="el" href="class_screen_panel.html#afbbcad2a101b95869dcdef9bf0898f65">ScreenPanel::_width</a><code> [protected]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>The width of the sub-bitmaps being drawn to in pixels. </p> + +<p>Definition at line <a class="el" href="_screen_panel_8h_source.html#l00081">81</a> of file <a class="el" href="_screen_panel_8h_source.html">ScreenPanel.h</a>.</p> + +</div> +</div> +<a class="anchor" id="a1cc6ea44035f47d77d24b4cee9dc9d85"></a><!-- doxytag: member="ScreenPanel::BLANK" ref="a1cc6ea44035f47d77d24b4cee9dc9d85" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">const ALLEGRO_COLOR <a class="el" href="class_screen_panel.html#a1cc6ea44035f47d77d24b4cee9dc9d85">ScreenPanel::BLANK</a> = al_map_rgb(0,0,0)<code> [static, protected]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Colour used to clear the screen at the beginning of drawing operations. </p> + +<p>Definition at line <a class="el" href="_screen_panel_8h_source.html#l00077">77</a> of file <a class="el" href="_screen_panel_8h_source.html">ScreenPanel.h</a>.</p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following files:<ul> +<li>source/presentation/<a class="el" href="_screen_panel_8h_source.html">ScreenPanel.h</a></li> +<li>source/presentation/<a class="el" href="_screen_panel_8cpp_source.html">ScreenPanel.cpp</a></li> +</ul> +</div> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a></div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + + + +<hr class="footer"/><address class="footer"><small> +Generated on Wed Oct 5 2011 20:08:31 for Rally X by  <a href="http://www.doxygen.org/index.html"> +<img class="footer" src="doxygen.png" alt="doxygen"/> +</a> 1.7.5.1 +</small></address> + +</body> +</html> |