<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" >
<head><meta content="text/html;charset=&quot;utf-8&quot;" http-equiv="Content-type"/><link href="faldoc.css" rel="stylesheet" type="text/css"/><title> - Class IMAGE</title></head><body class="faldoc"><ul class="navi_top"><li class="top"><a href="index.html">Top: Table of contents</a></li>
<li class="up"><a href="sdl_image.html">Up: Image loading extensions</a></li>
<li class="prev"><a href="sdl_image.html">Previous: Image loading extensions</a></li>
<li class="next"><a href="sdl_mixer.html">SDL AUDIO extensions for the Falco...</a></li>
<li class="clear"></li>
</ul><div id="page_body"><h1><span class="toc_number">16.15.1</span>Class IMAGE</h1><p class="brief">Main SDL IMAGE encapsulation class. </p>
<pre class="prototype">Class IMAGE</pre>
<p>This class is the namespace for IMAGE functions of the SDL module. It contains the extensions provided by Falcon on the sdlimage module. </p>
<table class="members">
<tbody><tr class="member_type"><td class="member_type" colspan="2">Methods</td></tr>
<tr><td><a href="#GetError">GetError</a></td><td>Gets image related error </td></tr>
<tr><td><a href="#Load">Load</a></td><td>Loads an image file based on filename extension </td></tr>
<tr><td><a href="#SetError">SetError</a></td><td>Sets image related error string </td></tr>
<tr><td><a href="#isBMP">isBMP</a></td><td>Checks if an image is in BMP format. </td></tr>
<tr><td><a href="#isGIF">isGIF</a></td><td>Checks if an image is in GIF format. </td></tr>
<tr><td><a href="#isJPG">isJPG</a></td><td>Checks if an image is in JPG format. </td></tr>
<tr><td><a href="#isLBM">isLBM</a></td><td>Checks if an image is in LBM format. </td></tr>
<tr><td><a href="#isPCX">isPCX</a></td><td>Checks if an image is in PCX format. </td></tr>
<tr><td><a href="#isPNG">isPNG</a></td><td>Checks if an image is in PCX format. </td></tr>
<tr><td><a href="#isPNM">isPNM</a></td><td>Checks if an image is in PNM format. </td></tr>
<tr><td><a href="#isTIF">isTIF</a></td><td>Checks if an image is in TIF format. </td></tr>
<tr><td><a href="#isXCF">isXCF</a></td><td>Checks if an image is in XCF format. </td></tr>
<tr><td><a href="#isXPM">isXPM</a></td><td>Checks if an image is in XPM format. </td></tr>
</tbody>
</table>
<h2>Methods</h2><h3><a name="GetError">GetError</a></h3><p class="brief">Gets image related error </p>
<pre class="prototype">IMAGE.GetError()</pre>
<table class="prototype">
<tbody><tr class="return"><td class="name">Return</td><td class="content">Returns a string containing a humam readble version or the reason for the last error that occured </td></tr>
</tbody>
</table>
<p>The current active image error is returned </p>
<h3><a name="Load">Load</a></h3><p class="brief">Loads an image file based on filename extension </p>
<pre class="prototype">IMAGE.Load( file, [type] )</pre>
<table class="prototype">
<tbody><tr class="param"><td class="name">file</td><td class="content"> The name of the file to be loaded, or a Falcon Stream instance pointing at the beginning of the image data. </td></tr>
<tr class="optparam"><td class="name">type</td><td class="content"> A string representing the type of image in the <b>file</b> stream. </td></tr>
<tr class="return"><td class="name">Return</td><td class="content">A new instance of <a href="sdl_SDLSurface.html">SDLSurface</a>. </td></tr>
<tr class="raise"><td class="name">Raise</td><td class="content"><table>
<tbody><tr><td class="name"><a href="sdl_SDLError.html">SDLError</a></td><td class="content"> if the file could not be interpreted as an image. </td></tr>
</tbody>
</table>
</td></tr>
</tbody>
</table>
<p>Load file for use as an image in a new surface. This actually uses the file extension as the type string. This can load all supported image files, provided that the extension is correctly representing the file type. </p>
<p>When a stream is given as <b>file</b> parameter, the <b>type</b> parameter is taken as the format type of the image in the incoming stream. It is just an hint, some common format doesn't require necessarily it. </p>
<p>Currently, the only format which is not automatically recognized is "TGA"; however, providing the hint will result in less guessing and may be necessary if the underlying stream doesn't support seek (i.e. a network stream or the standard input). </p>
<p>Here is a list of the currently recognized strings (case is not important): <ul><li>"TGA" </li><li>"BMP" </li><li>"PNM" </li><li>"XPM" </li><li>"XCF" </li><li>"PCX" </li><li>"GIF" </li><li>"JPG" </li><li>"TIF" </li><li>"LBM" </li><li>"PNG" </li></ul></p>
<h3><a name="SetError">SetError</a></h3><p class="brief">Sets image related error string </p>
<pre class="prototype">IMAGE.SetError()</pre>
<table class="prototype">
<tbody><tr class="return"><td class="name">Return</td><td class="content">Returns a string containing a humam readble version or the reason for the last error that occured </td></tr>
</tbody>
</table>
<p>This function sets the error string which may be fetched with img_GetError (or sdl_GetError). The function accepts a string not longer than 1024 chars in length. </p>
<h3><a name="isBMP">isBMP</a></h3><p class="brief">Checks if an image is in BMP format. </p>
<pre class="prototype">IMAGE.isBMP( file )</pre>
<table class="prototype">
<tbody><tr class="param"><td class="name">file</td><td class="content"> a Falcon Stream instance pointing at the beginning of the image data. </td></tr>
<tr class="return"><td class="name">Return</td><td class="content">True if the stream is stroing a BMP image. </td></tr>
</tbody>
</table>
<p>It may be useful to reset the stream to the current position after calling this function. </p>
<h3><a name="isGIF">isGIF</a></h3><p class="brief">Checks if an image is in GIF format. </p>
<pre class="prototype">IMAGE.isGIF( file )</pre>
<table class="prototype">
<tbody><tr class="param"><td class="name">file</td><td class="content"> a Falcon Stream instance pointing at the beginning of the image data. </td></tr>
<tr class="return"><td class="name">Return</td><td class="content">True if the stream is stroing a GIF image. </td></tr>
</tbody>
</table>
<p>It may be useful to reset the stream to the current position after calling this function. </p>
<h3><a name="isJPG">isJPG</a></h3><p class="brief">Checks if an image is in JPG format. </p>
<pre class="prototype">IMAGE.isJPG( file )</pre>
<table class="prototype">
<tbody><tr class="param"><td class="name">file</td><td class="content"> a Falcon Stream instance pointing at the beginning of the image data. </td></tr>
<tr class="return"><td class="name">Return</td><td class="content">True if the stream is stroing a JPG image. </td></tr>
</tbody>
</table>
<p>It may be useful to reset the stream to the current position after calling this function. </p>
<h3><a name="isLBM">isLBM</a></h3><p class="brief">Checks if an image is in LBM format. </p>
<pre class="prototype">IMAGE.isLBM( file )</pre>
<table class="prototype">
<tbody><tr class="param"><td class="name">file</td><td class="content"> a Falcon Stream instance pointing at the beginning of the image data. </td></tr>
<tr class="return"><td class="name">Return</td><td class="content">True if the stream is stroing a LBM image. </td></tr>
</tbody>
</table>
<p>It may be useful to reset the stream to the current position after calling this function. </p>
<h3><a name="isPCX">isPCX</a></h3><p class="brief">Checks if an image is in PCX format. </p>
<pre class="prototype">IMAGE.isPCX( file )</pre>
<table class="prototype">
<tbody><tr class="param"><td class="name">file</td><td class="content"> a Falcon Stream instance pointing at the beginning of the image data. </td></tr>
<tr class="return"><td class="name">Return</td><td class="content">True if the stream is stroing a PCX image. </td></tr>
</tbody>
</table>
<p>It may be useful to reset the stream to the current position after calling this function. </p>
<h3><a name="isPNG">isPNG</a></h3><p class="brief">Checks if an image is in PCX format. </p>
<pre class="prototype">IMAGE.isPNG( file )</pre>
<table class="prototype">
<tbody><tr class="param"><td class="name">file</td><td class="content"> a Falcon Stream instance pointing at the beginning of the image data. </td></tr>
<tr class="return"><td class="name">Return</td><td class="content">True if the stream is stroing a PCX image. </td></tr>
</tbody>
</table>
<p>It may be useful to reset the stream to the current position after calling this function. </p>
<h3><a name="isPNM">isPNM</a></h3><p class="brief">Checks if an image is in PNM format. </p>
<pre class="prototype">IMAGE.isPNM( file )</pre>
<table class="prototype">
<tbody><tr class="param"><td class="name">file</td><td class="content"> a Falcon Stream instance pointing at the beginning of the image data. </td></tr>
<tr class="return"><td class="name">Return</td><td class="content">True if the stream is stroing a PNM image. </td></tr>
</tbody>
</table>
<p>It may be useful to reset the stream to the current position after calling this function. </p>
<h3><a name="isTIF">isTIF</a></h3><p class="brief">Checks if an image is in TIF format. </p>
<pre class="prototype">IMAGE.isTIF( file )</pre>
<table class="prototype">
<tbody><tr class="param"><td class="name">file</td><td class="content"> a Falcon Stream instance pointing at the beginning of the image data. </td></tr>
<tr class="return"><td class="name">Return</td><td class="content">True if the stream is stroing a TIF image. </td></tr>
</tbody>
</table>
<p>It may be useful to reset the stream to the current position after calling this function. </p>
<h3><a name="isXCF">isXCF</a></h3><p class="brief">Checks if an image is in XCF format. </p>
<pre class="prototype">IMAGE.isXCF( file )</pre>
<table class="prototype">
<tbody><tr class="param"><td class="name">file</td><td class="content"> a Falcon Stream instance pointing at the beginning of the image data. </td></tr>
<tr class="return"><td class="name">Return</td><td class="content">True if the stream is stroing a XCF image. </td></tr>
</tbody>
</table>
<p>It may be useful to reset the stream to the current position after calling this function. </p>
<h3><a name="isXPM">isXPM</a></h3><p class="brief">Checks if an image is in XPM format. </p>
<pre class="prototype">IMAGE.isXPM( file )</pre>
<table class="prototype">
<tbody><tr class="param"><td class="name">file</td><td class="content"> a Falcon Stream instance pointing at the beginning of the image data. </td></tr>
<tr class="return"><td class="name">Return</td><td class="content">True if the stream is stroing a XPM image. </td></tr>
</tbody>
</table>
<p>It may be useful to reset the stream to the current position after calling this function. </p>
</div><ul class="navi_bottom"><li class="top"><a href="index.html">Top: Table of contents</a></li>
<li class="up"><a href="sdl_image.html">Up: Image loading extensions</a></li>
<li class="prev"><a href="sdl_image.html">Previous: Image loading extensions</a></li>
<li class="next"><a href="sdl_mixer.html">SDL AUDIO extensions for the Falco...</a></li>
<li class="clear"></li>
</ul><div class="signature">Made with <a href="faldoc 3.0">http://www.falconpl.org</a></div></body></html>
