zengine/doc/html/classZE_1_1ZImage.html

1249 lines
47 KiB
HTML
Raw Normal View History

2003-01-18 22:54:50 +00:00
<!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-rc2 -->
<center>
2003-04-27 18:54:58 +00:00
<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
2003-01-18 22:54:50 +00:00
<hr><h1>ZE::ZImage Class Reference</h1><code>#include &lt;<a class="el" href="ZE__ZImage_8h-source.html">ZE_ZImage.h</a>&gt;</code>
<p>
<a href="classZE_1_1ZImage-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
2003-04-27 18:54:58 +00:00
<a class="el" href="classZE_1_1ZImage.html">ZImage</a> image drawing class, class wraps common features of SDL_Surface. Inherited from ZObject.
2003-01-18 22:54:50 +00:00
<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>&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZImage.html#a0">ZImage</a> ()</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Default Constructor.</em> <a href="#a0"></a><em></em></font><br><br></td></tr>
2003-01-28 21:33:02 +00:00
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZImage.html#a1">ZImage</a> (const ZImage &amp;rhs)</td></tr>
2003-01-18 22:54:50 +00:00
<tr><td>&nbsp;</td><td><font size=-1><em>Copy constructor for <a class="el" href="classZE_1_1ZImage.html">ZImage</a>.</em> <a href="#a1"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZImage.html#a2">ZImage</a> (string filename)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Constructor to Construct from File.</em> <a href="#a2"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZImage.html#a3">ZImage</a> (SDL_Surface *surface)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Constructor to Construct from SDL_Surface*.</em> <a href="#a3"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZImage.html#a4">ZImage</a> (SDL_Surface *img, Sint16 x, Sint16 y, Sint16 w, Sint16 h)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Constructor to Construct from part of an SDL_Surface*.</em> <a href="#a4"></a><em></em></font><br><br></td></tr>
2003-04-27 18:54:58 +00:00
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZImage.html#a5">ZImage</a> (const ZImage &amp;img, Sint16 x, Sint16 y, Sint16 w, Sint16 h)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Constructor to Construct from part of another <a class="el" href="classZE_1_1ZImage.html">ZImage</a>.</em> <a href="#a5"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZImage.html#a6">~ZImage</a> ()</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Destructor, frees memory.</em> <a href="#a6"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZImage.html#a7">Open</a> (string filename)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Opens a file.</em> <a href="#a7"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZImage.html#a8">OpenFromImage</a> (SDL_Surface *img, Sint16 x, Sint16 y, Sint16 w, Sint16 h)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Cuts part of an existing image to create a new image.</em> <a href="#a8"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZImage.html#a9">OpenFromImage</a> (const ZImage &amp;img, Sint16 x, Sint16 y, Sint16 w, Sint16 h)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Cuts part of an existing <a class="el" href="classZE_1_1ZImage.html">ZImage</a> to create a new image.</em> <a href="#a9"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZImage.html#a10">Attach</a> (SDL_Surface *surface)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Attach an existing surface to class.</em> <a href="#a10"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZImage.html#a11">Reload</a> ()</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Reattach a preloaded texture that has been lost.</em> <a href="#a11"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZImage.html#a12">Release</a> ()</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Releases image.</em> <a href="#a12"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZImage.html#a13">SetAlpha</a> (Uint8 alpha)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Set alpha value (translucency) of image.</em> <a href="#a13"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZImage.html#a14">SetColorKey</a> (Uint8 red, Uint8 green, Uint8 blue)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Set Color Key (transparent color) of image.</em> <a href="#a14"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZImage.html#a15">Flip</a> (bool horizontal, bool vertical)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Flip image over one or both axes.</em> <a href="#a15"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZImage.html#a16">Stretch</a> (float xFactor, float yFactor)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Stretch the image by a certain X and Y factor.</em> <a href="#a16"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZImage.html#a17">Resize</a> (unsigned int width, unsigned int height)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Resizes an image, stretching to new size.</em> <a href="#a17"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZImage.html#a18">Bind</a> () const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>OpenGL related bind call.</em> <a href="#a18"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZImage.html#a19">Draw</a> (int x, int y) const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Draw Image to Screen.</em> <a href="#a19"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZImage.html#a20">Draw</a> (float x, float y) const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Draw Image to Screen.</em> <a href="#a20"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZImage.html#a21">DrawRotated</a> (int x, int y, float angle) const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Draw Image rotated to screen.</em> <a href="#a21"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZImage.html#a22">DrawRotated</a> (float x, float y, float angle) const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Draw Image rotated to screen.</em> <a href="#a22"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>bool&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZImage.html#a23">IsLoaded</a> () const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Check if file is loaded.</em> <a href="#a23"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>SDL_Surface *&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZImage.html#a24">Surface</a> () const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Get SDL_Surface. Get SDL_Surface pointer to actual image data.</em> <a href="#a24"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>int&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZImage.html#a25">Width</a> () const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Get Width.</em> <a href="#a25"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>int&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZImage.html#a26">Height</a> () const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Get Height.</em> <a href="#a26"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>Uint8&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZImage.html#a27">Alpha</a> () const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Get Alpha component.</em> <a href="#a27"></a><em></em></font><br><br></td></tr>
2003-01-18 22:54:50 +00:00
<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
2003-04-27 18:54:58 +00:00
<tr><td nowrap align=right valign=top><a name="n0" doxytag="ZE::ZImage::rEngine"></a>
<a class="el" href="classZE_1_1ZEngine.html">ZEngine</a> *&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZImage.html#n0">rEngine</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Pointer to <a class="el" href="classZE_1_1ZEngine.html">ZEngine</a> Object.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="n1" doxytag="ZE::ZImage::rTexMinX"></a>
GLfloat&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZImage.html#n1">rTexMinX</a></td></tr>
2003-01-18 22:54:50 +00:00
<tr><td>&nbsp;</td><td><font size=-1><em>Texture lower X, used internally for flip.</em></font><br><br></td></tr>
2003-04-27 18:54:58 +00:00
<tr><td nowrap align=right valign=top><a name="n2" doxytag="ZE::ZImage::rTexMinY"></a>
GLfloat&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZImage.html#n2">rTexMinY</a></td></tr>
2003-01-18 22:54:50 +00:00
<tr><td>&nbsp;</td><td><font size=-1><em>Texture lower Y, used internally for flip.</em></font><br><br></td></tr>
2003-04-27 18:54:58 +00:00
<tr><td nowrap align=right valign=top><a name="n3" doxytag="ZE::ZImage::rTexMaxX"></a>
GLfloat&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZImage.html#n3">rTexMaxX</a></td></tr>
2003-01-18 22:54:50 +00:00
<tr><td>&nbsp;</td><td><font size=-1><em>Texture X width ratio, used internally by OpenGL.</em></font><br><br></td></tr>
2003-04-27 18:54:58 +00:00
<tr><td nowrap align=right valign=top><a name="n4" doxytag="ZE::ZImage::rTexMaxY"></a>
GLfloat&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZImage.html#n4">rTexMaxY</a></td></tr>
2003-01-18 22:54:50 +00:00
<tr><td>&nbsp;</td><td><font size=-1><em>Texture Y width ratio, used internally by OpenGL.</em></font><br><br></td></tr>
2003-04-27 18:54:58 +00:00
<tr><td nowrap align=right valign=top><a name="n5" doxytag="ZE::ZImage::rImage"></a>
SDL_Surface *&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZImage.html#n5">rImage</a></td></tr>
2003-01-18 22:54:50 +00:00
<tr><td>&nbsp;</td><td><font size=-1><em>Stored texture for future use.</em></font><br><br></td></tr>
2003-04-27 18:54:58 +00:00
<tr><td nowrap align=right valign=top><a name="n6" doxytag="ZE::ZImage::rTexID"></a>
unsigned int&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZImage.html#n6">rTexID</a></td></tr>
2003-01-18 22:54:50 +00:00
<tr><td>&nbsp;</td><td><font size=-1><em>Texture ID for OpenGL.</em></font><br><br></td></tr>
2003-04-27 18:54:58 +00:00
<tr><td nowrap align=right valign=top><a name="n7" doxytag="ZE::ZImage::rWidth"></a>
unsigned int&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZImage.html#n7">rWidth</a></td></tr>
2003-01-18 22:54:50 +00:00
<tr><td>&nbsp;</td><td><font size=-1><em>Current draw width of Texture.</em></font><br><br></td></tr>
2003-04-27 18:54:58 +00:00
<tr><td nowrap align=right valign=top><a name="n8" doxytag="ZE::ZImage::rHeight"></a>
unsigned int&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZImage.html#n8">rHeight</a></td></tr>
2003-01-18 22:54:50 +00:00
<tr><td>&nbsp;</td><td><font size=-1><em>Current draw height of Texture.</em></font><br><br></td></tr>
2003-04-27 18:54:58 +00:00
<tr><td nowrap align=right valign=top><a name="n9" doxytag="ZE::ZImage::rAlpha"></a>
Uint8&nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZImage.html#n9">rAlpha</a></td></tr>
2003-01-28 21:33:02 +00:00
<tr><td>&nbsp;</td><td><font size=-1><em>Stored alpha value for drawing texture.</em></font><br><br></td></tr>
2003-01-18 22:54:50 +00:00
</table>
<hr><h2>Constructor &amp; 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">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Default Constructor, initializes variables. </td>
</tr>
</table>
2003-01-28 21:33:02 +00:00
<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">(&nbsp;</td>
<td class="md" nowrap valign="top">const ZImage &amp;&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>rhs</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Creates one <a class="el" href="classZE_1_1ZImage.html">ZImage</a> using another. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>rhs</em>&nbsp;</td><td>A previously created <a class="el" href="classZE_1_1ZImage.html">ZImage</a> to copy. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
2003-01-18 22:54:50 +00:00
<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">(&nbsp;</td>
<td class="md" nowrap valign="top">string&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>filename</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
2003-04-27 18:54:58 +00:00
Constructor is same as calling <a class="el" href="classZE_1_1ZImage.html#a7">ZImage::Open()</a> on passed filename. <dl compact><dt><b>Parameters:</b></dt><dd>
2003-01-18 22:54:50 +00:00
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>filename</em>&nbsp;</td><td>File to open 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">(&nbsp;</td>
<td class="md" nowrap valign="top">SDL_Surface *&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>surface</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
2003-04-27 18:54:58 +00:00
Constructor is same as calling <a class="el" href="classZE_1_1ZImage.html#a10">ZImage::Attach()</a> on passed SDL_Surface*. <dl compact><dt><b>Parameters:</b></dt><dd>
2003-01-18 22:54:50 +00:00
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>surface</em>&nbsp;</td><td>SDL_Surface* to use as rImage. </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">(&nbsp;</td>
<td class="md" nowrap valign="top">SDL_Surface *&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>img</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>Sint16&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>x</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>Sint16&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>y</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>Sint16&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>w</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>Sint16&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>h</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
2003-04-27 18:54:58 +00:00
Constructor is same as calling <a class="el" href="classZE_1_1ZImage.html#a8">ZImage::OpenFromImage</a> with an SDL_Surface*.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>img</em>&nbsp;</td><td>Image to take new image from. </td></tr>
<tr><td valign=top><em>x</em>&nbsp;</td><td>X Coordinate in source of top left corner. </td></tr>
<tr><td valign=top><em>y</em>&nbsp;</td><td>Y Coordinate in source of top left corner. </td></tr>
<tr><td valign=top><em>w</em>&nbsp;</td><td>Width of new image. </td></tr>
<tr><td valign=top><em>h</em>&nbsp;</td><td>Height of new image. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a name="a5" 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">(&nbsp;</td>
<td class="md" nowrap valign="top">const ZImage &amp;&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>img</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>Sint16&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>x</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>Sint16&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>y</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>Sint16&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>w</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>Sint16&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>h</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Constructor is same as calling <a class="el" href="classZE_1_1ZImage.html#a8">ZImage::OpenFromImage</a> with a <a class="el" href="classZE_1_1ZImage.html">ZImage</a>.
2003-01-18 22:54:50 +00:00
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>img</em>&nbsp;</td><td>Image to take new image from. </td></tr>
<tr><td valign=top><em>x</em>&nbsp;</td><td>X Coordinate in source of top left corner. </td></tr>
<tr><td valign=top><em>y</em>&nbsp;</td><td>Y Coordinate in source of top left corner. </td></tr>
<tr><td valign=top><em>w</em>&nbsp;</td><td>Width of new image. </td></tr>
<tr><td valign=top><em>h</em>&nbsp;</td><td>Height of new image. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
2003-04-27 18:54:58 +00:00
<a name="a6" doxytag="ZE::ZImage::~ZImage"></a><p>
2003-01-18 22:54:50 +00:00
<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">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
2003-04-27 18:54:58 +00:00
<td class="md" nowrap><code> [virtual]</code></td>
2003-01-18 22:54:50 +00:00
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
2003-04-27 18:54:58 +00:00
Destructor calls <a class="el" href="classZE_1_1ZImage.html#a12">ZImage::Release()</a>. </td>
2003-01-18 22:54:50 +00:00
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
2003-04-27 18:54:58 +00:00
<a name="a7" doxytag="ZE::ZImage::Open"></a><p>
2003-01-18 22:54:50 +00:00
<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">(&nbsp;</td>
<td class="md" nowrap valign="top">string&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>filename</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</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>&nbsp;</td><td>File to open as rImage. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
2003-04-27 18:54:58 +00:00
<a name="a8" doxytag="ZE::ZImage::OpenFromImage"></a><p>
2003-01-18 22:54:50 +00:00
<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">(&nbsp;</td>
<td class="md" nowrap valign="top">SDL_Surface *&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>img</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>Sint16&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>x</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>Sint16&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>y</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>Sint16&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>w</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>Sint16&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>h</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</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">
2003-04-27 18:54:58 +00:00
<tr><td valign=top><em>img</em>&nbsp;</td><td>SDL_Surface* to take new image from. </td></tr>
2003-01-18 22:54:50 +00:00
<tr><td valign=top><em>x</em>&nbsp;</td><td>X Coordinate in source of top left corner. </td></tr>
<tr><td valign=top><em>y</em>&nbsp;</td><td>Y Coordinate in source of top left corner. </td></tr>
<tr><td valign=top><em>w</em>&nbsp;</td><td>Width of new image. </td></tr>
<tr><td valign=top><em>h</em>&nbsp;</td><td>Height of new image. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
2003-04-27 18:54:58 +00:00
<a name="a9" 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">(&nbsp;</td>
<td class="md" nowrap valign="top">const ZImage &amp;&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>img</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>Sint16&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>x</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>Sint16&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>y</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>Sint16&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>w</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>Sint16&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>h</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Cut part of another <a class="el" href="classZE_1_1ZImage.html">ZImage</a> 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>&nbsp;</td><td><a class="el" href="classZE_1_1ZImage.html">ZImage</a> to take new image from. </td></tr>
<tr><td valign=top><em>x</em>&nbsp;</td><td>X Coordinate in source of top left corner. </td></tr>
<tr><td valign=top><em>y</em>&nbsp;</td><td>Y Coordinate in source of top left corner. </td></tr>
<tr><td valign=top><em>w</em>&nbsp;</td><td>Width of new image. </td></tr>
<tr><td valign=top><em>h</em>&nbsp;</td><td>Height of new image. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a name="a10" doxytag="ZE::ZImage::Attach"></a><p>
2003-01-18 22:54:50 +00:00
<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">(&nbsp;</td>
<td class="md" nowrap valign="top">SDL_Surface *&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>surface</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</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>&nbsp;</td><td>SDL_Surface* to use as rImage. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
2003-04-27 18:54:58 +00:00
<a name="a11" doxytag="ZE::ZImage::Reload"></a><p>
2003-01-18 22:54:50 +00:00
<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::Reload </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
2003-01-28 21:33:02 +00:00
Attach loaded textures which have been lost due to loss of focus, should be called when <a class="el" href="classZE_1_1ZEngine.html#a23">ZEngine::ImagesNeedReload</a> is true. </td>
2003-01-18 22:54:50 +00:00
</tr>
</table>
2003-04-27 18:54:58 +00:00
<a name="a12" doxytag="ZE::ZImage::Release"></a><p>
2003-01-18 22:54:50 +00:00
<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">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Frees memory via call to SDL_FreeSurface for the image. </td>
</tr>
</table>
2003-04-27 18:54:58 +00:00
<a name="a13" doxytag="ZE::ZImage::SetAlpha"></a><p>
2003-01-28 21:33:02 +00:00
<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::SetAlpha </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">Uint8&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>alpha</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Set translucency value 0-255 (0 is transparent, 255 = opaque). <dl compact><dt><b>Since:</b></dt><dd>0.8.2 </dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>alpha</em>&nbsp;</td><td>Number 0-255 setting translucency for image. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
2003-04-27 18:54:58 +00:00
<a name="a14" doxytag="ZE::ZImage::SetColorKey"></a><p>
2003-01-18 22:54:50 +00:00
<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">(&nbsp;</td>
<td class="md" nowrap valign="top">Uint8&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>red</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>Uint8&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>green</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>Uint8&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>blue</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</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>&nbsp;</td><td>Red component of colorkey (0-255). </td></tr>
<tr><td valign=top><em>green</em>&nbsp;</td><td>Green component of colorkey (0-255). </td></tr>
<tr><td valign=top><em>blue</em>&nbsp;</td><td>Blue component of colorkey (0-255). </td></tr>
</table>
</dl>
</td>
</tr>
</table>
2003-04-27 18:54:58 +00:00
<a name="a15" doxytag="ZE::ZImage::Flip"></a><p>
2003-01-18 22:54:50 +00:00
<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">(&nbsp;</td>
<td class="md" nowrap valign="top">bool&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>horizontal</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>bool&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>vertical</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</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>&nbsp;</td><td>Boolean, true will flip image horizontally. </td></tr>
<tr><td valign=top><em>vertical</em>&nbsp;</td><td>Boolean, true will flip image vertically. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
2003-04-27 18:54:58 +00:00
<a name="a16" doxytag="ZE::ZImage::Stretch"></a><p>
2003-01-18 22:54:50 +00:00
<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">(&nbsp;</td>
<td class="md" nowrap valign="top">float&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>xFactor</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>float&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>yFactor</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</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>&nbsp;</td><td>Stretch factor for width. [newWidth = oldWidth * xStretch] </td></tr>
<tr><td valign=top><em>yFactor</em>&nbsp;</td><td>Stretch factor for height. [newHeight = oldHeight * yStretch] </td></tr>
</table>
</dl>
</td>
</tr>
</table>
2003-04-27 18:54:58 +00:00
<a name="a17" doxytag="ZE::ZImage::Resize"></a><p>
2003-01-18 22:54:50 +00:00
<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">(&nbsp;</td>
<td class="md" nowrap valign="top">unsigned int&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>width</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>unsigned int&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>height</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</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>&nbsp;</td><td>New width to stretch image to. </td></tr>
<tr><td valign=top><em>height</em>&nbsp;</td><td>New height to stretch image to. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
2003-04-27 18:54:58 +00:00
<a name="a18" doxytag="ZE::ZImage::Bind"></a><p>
2003-01-18 22:54:50 +00:00
<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">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</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>
2003-04-27 18:54:58 +00:00
<a name="a19" 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">(&nbsp;</td>
<td class="md" nowrap valign="top">int&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>x</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>int&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>y</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</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>&nbsp;</td><td>X coord to draw Image to. </td></tr>
<tr><td valign=top><em>y</em>&nbsp;</td><td>Y coord to draw Image to. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a name="a20" doxytag="ZE::ZImage::Draw"></a><p>
2003-01-18 22:54:50 +00:00
<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">(&nbsp;</td>
<td class="md" nowrap valign="top">float&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>x</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>float&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>y</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
2003-04-27 18:54:58 +00:00
Draw Image to screen at specified location. <dl compact><dt><b>Since:</b></dt><dd>0.8.3 </dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
2003-01-18 22:54:50 +00:00
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>x</em>&nbsp;</td><td>X coord to draw Image to. </td></tr>
<tr><td valign=top><em>y</em>&nbsp;</td><td>Y coord to draw Image to. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
2003-04-27 18:54:58 +00:00
<a name="a21" doxytag="ZE::ZImage::DrawRotated"></a><p>
2003-01-18 22:54:50 +00:00
<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">(&nbsp;</td>
<td class="md" nowrap valign="top">int&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>x</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>int&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>y</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>float&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>angle</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</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>&nbsp;</td><td>X coord to draw Image to. </td></tr>
<tr><td valign=top><em>y</em>&nbsp;</td><td>Y coord to draw Image to. </td></tr>
<tr><td valign=top><em>angle</em>&nbsp;</td><td>Angle in degrees to rotate image. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
2003-04-27 18:54:58 +00:00
<a name="a22" 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">(&nbsp;</td>
<td class="md" nowrap valign="top">float&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>x</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>float&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>y</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>float&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>angle</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Image is rotated about it's own center by specified angle, then drawn to screen. <dl compact><dt><b>Since:</b></dt><dd>0.8.3 </dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>x</em>&nbsp;</td><td>X coord to draw Image to. </td></tr>
<tr><td valign=top><em>y</em>&nbsp;</td><td>Y coord to draw Image to. </td></tr>
<tr><td valign=top><em>angle</em>&nbsp;</td><td>Angle in degrees to rotate image. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a name="a23" doxytag="ZE::ZImage::IsLoaded"></a><p>
2003-01-18 22:54:50 +00:00
<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">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Check if surface is a valid GL texture. (does not detect surface loss) <dl compact><dt><b>Returns:</b></dt><dd>Loaded or Unloaded state of data. </dd></dl>
</td>
</tr>
</table>
2003-04-27 18:54:58 +00:00
<a name="a24" doxytag="ZE::ZImage::Surface"></a><p>
2003-01-18 22:54:50 +00:00
<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">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
<dl compact><dt><b>Returns:</b></dt><dd>SDL_Surface* of rImage. </dd></dl>
</td>
</tr>
</table>
2003-04-27 18:54:58 +00:00
<a name="a25" doxytag="ZE::ZImage::Width"></a><p>
2003-01-18 22:54:50 +00:00
<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">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Get Current Width of Image. <dl compact><dt><b>Returns:</b></dt><dd>Image Width. </dd></dl>
</td>
</tr>
</table>
2003-04-27 18:54:58 +00:00
<a name="a26" doxytag="ZE::ZImage::Height"></a><p>
2003-01-18 22:54:50 +00:00
<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">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Get Current Height of Image. <dl compact><dt><b>Returns:</b></dt><dd>Image Height. </dd></dl>
</td>
</tr>
</table>
2003-04-27 18:54:58 +00:00
<a name="a27" doxytag="ZE::ZImage::Alpha"></a><p>
2003-01-28 21:33:02 +00:00
<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"> Uint8 ZE::ZImage::Alpha </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Get current alpha value of image. <dl compact><dt><b>Since:</b></dt><dd>0.8.2 </dd></dl>
<dl compact><dt><b>Returns:</b></dt><dd>Image Alpha. </dd></dl>
</td>
</tr>
</table>
2003-01-18 22:54:50 +00:00
<hr>The documentation for this class was generated from the following files:<ul>
<li>/include/<a class="el" href="ZE__ZImage_8h-source.html">ZE_ZImage.h</a><li>/src/<a class="el" href="ZE__ZImage_8cpp.html">ZE_ZImage.cpp</a></ul>
2003-04-27 22:05:04 +00:00
<hr><address style="align: right;"><small>Generated on Sun Apr 27 17:56:46 2003 for ZEngine by
2003-01-18 22:54:50 +00:00
<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-rc2 </small></address>
</body>
</html>