871 lines
33 KiB
HTML
871 lines
33 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
|
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
|
|
<title>ZE::ZImage class Reference</title>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css">
|
|
</head><body>
|
|
<!-- Generated by Doxygen 1.3-rc1 -->
|
|
<center>
|
|
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="namespacemembers.html">Namespace Members</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </center>
|
|
<hr><h1>ZE::ZImage Class Reference</h1><code>#include <<a class="el" href="ZE__ZImage_8h-source.html">ZE_ZImage.h</a>></code>
|
|
<p>
|
|
Inherits <a class="el" href="classZE_1_1ZObject.html">ZE::ZObject</a>.
|
|
<p>
|
|
<a href="classZE_1_1ZImage-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
|
|
<a class="el" href="classZE_1_1ZImage.html">ZImage</a> image drawing class, class wraps common features of SDL_Surface. Inherited from <a class="el" href="classZE_1_1ZObject.html">ZObject</a>.
|
|
<p>
|
|
<table border=0 cellpadding=0 cellspacing=0>
|
|
<tr><td></td></tr>
|
|
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
|
|
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classZE_1_1ZImage.html#a0">ZImage</a> ()</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Default Constructor.</em> <a href="#a0"></a><em></em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classZE_1_1ZImage.html#a1">ZImage</a> (string filename)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Constructor to Construct from File.</em> <a href="#a1"></a><em></em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classZE_1_1ZImage.html#a2">ZImage</a> (SDL_Surface *surface)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Constructor to Construct from SDL_Surface*.</em> <a href="#a2"></a><em></em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classZE_1_1ZImage.html#a3">ZImage</a> (SDL_Surface *img, Sint16 x, Sint16 y, Sint16 w, Sint16 h)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Constructor to Construct from part of an SDL_Surface*.</em> <a href="#a3"></a><em></em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classZE_1_1ZImage.html#a4">~ZImage</a> ()</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Destructor, frees memory.</em> <a href="#a4"></a><em></em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classZE_1_1ZImage.html#a5">Open</a> (string filename)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Opens a file.</em> <a href="#a5"></a><em></em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classZE_1_1ZImage.html#a6">OpenFromImage</a> (SDL_Surface *img, Sint16 x, Sint16 y, Sint16 w, Sint16 h)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Cuts part of an existing image to create the new image.</em> <a href="#a6"></a><em></em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classZE_1_1ZImage.html#a7">Attach</a> (SDL_Surface *surface)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Attach an existing surface to class.</em> <a href="#a7"></a><em></em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classZE_1_1ZImage.html#a8">Release</a> ()</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Releases image.</em> <a href="#a8"></a><em></em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classZE_1_1ZImage.html#a9">SetColorKey</a> (Uint8 red, Uint8 green, Uint8 blue)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Set Color Key (transparent color) of Image.</em> <a href="#a9"></a><em></em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classZE_1_1ZImage.html#a10">Flip</a> (bool horizontal, bool vertical)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Flip image over one or both axes.</em> <a href="#a10"></a><em></em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classZE_1_1ZImage.html#a11">Stretch</a> (float xFactor, float yFactor)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Stretch the image by a certain X and Y factor.</em> <a href="#a11"></a><em></em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classZE_1_1ZImage.html#a12">Resize</a> (unsigned int width, unsigned int height)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Resizes an image, stretching to new size.</em> <a href="#a12"></a><em></em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classZE_1_1ZImage.html#a13">Bind</a> ()</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>OpenGL related bind call.</em> <a href="#a13"></a><em></em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classZE_1_1ZImage.html#a14">Draw</a> (float x, float y)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Draw Image to Screen.</em> <a href="#a14"></a><em></em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classZE_1_1ZImage.html#a15">DrawRotated</a> (int x, int y, float angle)</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Draw Image rotated to screen.</em> <a href="#a15"></a><em></em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classZE_1_1ZImage.html#a16">IsLoaded</a> ()</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Check if file is loaded.</em> <a href="#a16"></a><em></em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>SDL_Surface * </td><td valign=bottom><a class="el" href="classZE_1_1ZImage.html#a17">Surface</a> ()</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Get SDL_Surface. Get SDL_Surface pointer to actual image data.</em> <a href="#a17"></a><em></em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classZE_1_1ZImage.html#a18">Width</a> ()</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Get Width.</em> <a href="#a18"></a><em></em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classZE_1_1ZImage.html#a19">Height</a> ()</td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Get Height.</em> <a href="#a19"></a><em></em></font><br><br></td></tr>
|
|
<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="n0" doxytag="ZE::ZImage::rTexMinX"></a>
|
|
GLfloat </td><td valign=bottom><a class="el" href="classZE_1_1ZImage.html#n0">rTexMinX</a></td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Texture lower X, used internally for flip.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="n1" doxytag="ZE::ZImage::rTexMinY"></a>
|
|
GLfloat </td><td valign=bottom><a class="el" href="classZE_1_1ZImage.html#n1">rTexMinY</a></td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Texture lower Y, used internally for flip.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="n2" doxytag="ZE::ZImage::rTexMaxX"></a>
|
|
GLfloat </td><td valign=bottom><a class="el" href="classZE_1_1ZImage.html#n2">rTexMaxX</a></td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Texture X width ratio, used internally by OpenGL.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="n3" doxytag="ZE::ZImage::rTexMaxY"></a>
|
|
GLfloat </td><td valign=bottom><a class="el" href="classZE_1_1ZImage.html#n3">rTexMaxY</a></td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Texture Y width ratio, used internally by OpenGL.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="n4" doxytag="ZE::ZImage::rImage"></a>
|
|
SDL_Surface * </td><td valign=bottom><a class="el" href="classZE_1_1ZImage.html#n4">rImage</a></td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Stored texture for future use.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="n5" doxytag="ZE::ZImage::rTexID"></a>
|
|
unsigned int </td><td valign=bottom><a class="el" href="classZE_1_1ZImage.html#n5">rTexID</a></td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Texture ID for OpenGL.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="n6" doxytag="ZE::ZImage::rWidth"></a>
|
|
unsigned int </td><td valign=bottom><a class="el" href="classZE_1_1ZImage.html#n6">rWidth</a></td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Current draw width of Texture.</em></font><br><br></td></tr>
|
|
<tr><td nowrap align=right valign=top><a name="n7" doxytag="ZE::ZImage::rHeight"></a>
|
|
unsigned int </td><td valign=bottom><a class="el" href="classZE_1_1ZImage.html#n7">rHeight</a></td></tr>
|
|
<tr><td> </td><td><font size=-1><em>Current draw height of Texture.</em></font><br><br></td></tr>
|
|
</table>
|
|
<hr><h2>Constructor & Destructor Documentation</h2>
|
|
<a name="a0" doxytag="ZE::ZImage::ZImage"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> ZE::ZImage::ZImage </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
|
<td class="md" valign="top">) </td>
|
|
<td class="md" nowrap></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Default Constructor, initializes variables. </td>
|
|
</tr>
|
|
</table>
|
|
<a name="a1" doxytag="ZE::ZImage::ZImage"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> ZE::ZImage::ZImage </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">string </td>
|
|
<td class="mdname1" valign="top" nowrap> <em>filename</em> </td>
|
|
<td class="md" valign="top">) </td>
|
|
<td class="md" nowrap></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Constructor is same as calling <a class="el" href="classZE_1_1ZImage.html#a5">ZImage::Open()</a> on passed filename. <dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign=top><em>filename</em> </td><td>File to open as rImage. </td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a name="a2" doxytag="ZE::ZImage::ZImage"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> ZE::ZImage::ZImage </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">SDL_Surface * </td>
|
|
<td class="mdname1" valign="top" nowrap> <em>surface</em> </td>
|
|
<td class="md" valign="top">) </td>
|
|
<td class="md" nowrap></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Constructor is same as calling <a class="el" href="classZE_1_1ZImage.html#a7">ZImage::Attach()</a> on passed SDL_Surface*. <dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign=top><em>surface</em> </td><td>SDL_Surface* to use as rImage. </td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a name="a3" doxytag="ZE::ZImage::ZImage"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> ZE::ZImage::ZImage </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">SDL_Surface * </td>
|
|
<td class="mdname" nowrap> <em>img</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap>Sint16 </td>
|
|
<td class="mdname" nowrap> <em>x</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap>Sint16 </td>
|
|
<td class="mdname" nowrap> <em>y</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap>Sint16 </td>
|
|
<td class="mdname" nowrap> <em>w</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap>Sint16 </td>
|
|
<td class="mdname" nowrap> <em>h</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Constructor is same as calling <a class="el" href="classZE_1_1ZImage.html#a6">ZImage::OpenFromImage</a>.
|
|
<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign=top><em>img</em> </td><td>Image to take new image from. </td></tr>
|
|
<tr><td valign=top><em>x</em> </td><td>X Coordinate in source of top left corner. </td></tr>
|
|
<tr><td valign=top><em>y</em> </td><td>Y Coordinate in source of top left corner. </td></tr>
|
|
<tr><td valign=top><em>w</em> </td><td>Width of new image. </td></tr>
|
|
<tr><td valign=top><em>h</em> </td><td>Height of new image. </td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a name="a4" doxytag="ZE::ZImage::~ZImage"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> ZE::ZImage::~ZImage </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
|
<td class="md" valign="top">) </td>
|
|
<td class="md" nowrap></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Destructor calls <a class="el" href="classZE_1_1ZImage.html#a8">ZImage::Release()</a>. </td>
|
|
</tr>
|
|
</table>
|
|
<hr><h2>Member Function Documentation</h2>
|
|
<a name="a5" doxytag="ZE::ZImage::Open"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> void ZE::ZImage::Open </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">string </td>
|
|
<td class="mdname1" valign="top" nowrap> <em>filename</em> </td>
|
|
<td class="md" valign="top">) </td>
|
|
<td class="md" nowrap></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Open a file using <a class="el" href="classZE_1_1ZEngine.html">ZEngine</a>. Loads into rImage member of class. <dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign=top><em>filename</em> </td><td>File to open as rImage. </td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a name="a6" doxytag="ZE::ZImage::OpenFromImage"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> void ZE::ZImage::OpenFromImage </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">SDL_Surface * </td>
|
|
<td class="mdname" nowrap> <em>img</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap>Sint16 </td>
|
|
<td class="mdname" nowrap> <em>x</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap>Sint16 </td>
|
|
<td class="mdname" nowrap> <em>y</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap>Sint16 </td>
|
|
<td class="mdname" nowrap> <em>w</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap>Sint16 </td>
|
|
<td class="mdname" nowrap> <em>h</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Cut part of an SDL_Surface to create a new Image.
|
|
<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign=top><em>img</em> </td><td>Image to take new image from. </td></tr>
|
|
<tr><td valign=top><em>x</em> </td><td>X Coordinate in source of top left corner. </td></tr>
|
|
<tr><td valign=top><em>y</em> </td><td>Y Coordinate in source of top left corner. </td></tr>
|
|
<tr><td valign=top><em>w</em> </td><td>Width of new image. </td></tr>
|
|
<tr><td valign=top><em>h</em> </td><td>Height of new image. </td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a name="a7" doxytag="ZE::ZImage::Attach"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> void ZE::ZImage::Attach </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">SDL_Surface * </td>
|
|
<td class="mdname1" valign="top" nowrap> <em>surface</em> </td>
|
|
<td class="md" valign="top">) </td>
|
|
<td class="md" nowrap></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Attach a pointer to instance of <a class="el" href="classZE_1_1ZImage.html">ZImage</a>. (NOTE: Should not be used on a surface that is owned elsewhere.) <dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign=top><em>surface</em> </td><td>SDL_Surface* to use as rImage. </td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a name="a8" doxytag="ZE::ZImage::Release"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> void ZE::ZImage::Release </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
|
<td class="md" valign="top">) </td>
|
|
<td class="md" nowrap></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Frees memory via call to SDL_FreeSurface for the image. </td>
|
|
</tr>
|
|
</table>
|
|
<a name="a9" doxytag="ZE::ZImage::SetColorKey"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> void ZE::ZImage::SetColorKey </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">Uint8 </td>
|
|
<td class="mdname" nowrap> <em>red</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap>Uint8 </td>
|
|
<td class="mdname" nowrap> <em>green</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap>Uint8 </td>
|
|
<td class="mdname" nowrap> <em>blue</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Set color which will not be drawn in image. <dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign=top><em>red</em> </td><td>Red component of colorkey (0-255). </td></tr>
|
|
<tr><td valign=top><em>green</em> </td><td>Green component of colorkey (0-255). </td></tr>
|
|
<tr><td valign=top><em>blue</em> </td><td>Blue component of colorkey (0-255). </td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a name="a10" doxytag="ZE::ZImage::Flip"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> void ZE::ZImage::Flip </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">bool </td>
|
|
<td class="mdname" nowrap> <em>horizontal</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap>bool </td>
|
|
<td class="mdname" nowrap> <em>vertical</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Flip image vertical and/or horizontal. <dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign=top><em>horizontal</em> </td><td>Boolean, true will flip image horizontally. </td></tr>
|
|
<tr><td valign=top><em>vertical</em> </td><td>Boolean, true will flip image vertically. </td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a name="a11" doxytag="ZE::ZImage::Stretch"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> void ZE::ZImage::Stretch </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">float </td>
|
|
<td class="mdname" nowrap> <em>xFactor</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap>float </td>
|
|
<td class="mdname" nowrap> <em>yFactor</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Stretch image using a factor to multiply width and height by. <dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign=top><em>xFactor</em> </td><td>Stretch factor for width. [newWidth = oldWidth * xStretch] </td></tr>
|
|
<tr><td valign=top><em>yFactor</em> </td><td>Stretch factor for height. [newHeight = oldHeight * yStretch] </td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a name="a12" doxytag="ZE::ZImage::Resize"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> void ZE::ZImage::Resize </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">unsigned int </td>
|
|
<td class="mdname" nowrap> <em>width</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap>unsigned int </td>
|
|
<td class="mdname" nowrap> <em>height</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Stretch image to new width and height. <dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign=top><em>width</em> </td><td>New width to stretch image to. </td></tr>
|
|
<tr><td valign=top><em>height</em> </td><td>New height to stretch image to. </td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a name="a13" doxytag="ZE::ZImage::Bind"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> void ZE::ZImage::Bind </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
|
<td class="md" valign="top">) </td>
|
|
<td class="md" nowrap></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
OpenGL related bind call, only available in case you want to bind image in 3D. Draw uses this but the average user should never need to call this. </td>
|
|
</tr>
|
|
</table>
|
|
<a name="a14" doxytag="ZE::ZImage::Draw"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> void ZE::ZImage::Draw </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">float </td>
|
|
<td class="mdname" nowrap> <em>x</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap>float </td>
|
|
<td class="mdname" nowrap> <em>y</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Draw Image to screen at specified location. <dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign=top><em>x</em> </td><td>X coord to draw Image to. </td></tr>
|
|
<tr><td valign=top><em>y</em> </td><td>Y coord to draw Image to. </td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a name="a15" doxytag="ZE::ZImage::DrawRotated"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> void ZE::ZImage::DrawRotated </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">int </td>
|
|
<td class="mdname" nowrap> <em>x</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap>int </td>
|
|
<td class="mdname" nowrap> <em>y</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td class="md" nowrap>float </td>
|
|
<td class="mdname" nowrap> <em>angle</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Image is rotated about it's own center by specified angle, then drawn to screen. <dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign=top><em>x</em> </td><td>X coord to draw Image to. </td></tr>
|
|
<tr><td valign=top><em>y</em> </td><td>Y coord to draw Image to. </td></tr>
|
|
<tr><td valign=top><em>angle</em> </td><td>Angle in degrees to rotate image. </td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a name="a16" doxytag="ZE::ZImage::IsLoaded"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> bool ZE::ZImage::IsLoaded </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
|
<td class="md" valign="top">) </td>
|
|
<td class="md" nowrap></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Check if file is loaded and pointer to data is non-NULL. <dl compact><dt><b>Returns:</b></dt><dd>Loaded or Unloaded state of data. </dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a name="a17" doxytag="ZE::ZImage::Surface"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> SDL_Surface * ZE::ZImage::Surface </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
|
<td class="md" valign="top">) </td>
|
|
<td class="md" nowrap></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>SDL_Surface* of rImage. </dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a name="a18" doxytag="ZE::ZImage::Width"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> int ZE::ZImage::Width </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
|
<td class="md" valign="top">) </td>
|
|
<td class="md" nowrap></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Get Current Width of Image. <dl compact><dt><b>Returns:</b></dt><dd>Image Width. </dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a name="a19" doxytag="ZE::ZImage::Height"></a><p>
|
|
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"> int ZE::ZImage::Height </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
|
<td class="md" valign="top">) </td>
|
|
<td class="md" nowrap></td>
|
|
</tr>
|
|
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing=5 cellpadding=0 border=0>
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Get Current Height of Image. <dl compact><dt><b>Returns:</b></dt><dd>Image Height. </dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<hr>The documentation for this class was generated from the following files:<ul>
|
|
<li>/home/James/ZEngine-dev/include/<a class="el" href="ZE__ZImage_8h-source.html">ZE_ZImage.h</a><li>/home/James/ZEngine-dev/src/<a class="el" href="ZE__ZImage_8cpp.html">ZE_ZImage.cpp</a></ul>
|
|
<hr><address style="align: right;"><small>Generated on Wed Dec 4 19:01:31 2002 for ZEngine by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img src="doxygen.png" alt="doxygen" align="middle" border=0
|
|
width=110 height=53></a>1.3-rc1 </small></address>
|
|
</body>
|
|
</html>
|