source: OGRE/trunk/ogrenew/Docs/api/html/classOgre_1_1ILUtil.html @ 657

Revision 657, 9.7 KB checked in by mattausch, 18 years ago (diff)

added ogre dependencies and patched ogre sources
Line 
1<html>
2<head>
3<title>Ogre::ILUtil class Reference - OGRE Documentation</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
4<link type="text/css" rel="stylesheet" href="style.css">
5</head>
6
7<body>
8<!-- Generated by Doxygen 1.3.6 -->
9<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a></div>
10<h1>Ogre::ILUtil Class Reference</h1><code>#include &lt;<a class="el" href="OgreILUtil_8h-source.html">OgreILUtil.h</a>&gt;</code>
11<p>
12<a href="classOgre_1_1ILUtil-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
13<tr><td></td></tr>
14<tr><td colspan=2><br><h2>Static Public Member Functions</h2></td></tr>
15<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a667">PixelFormat</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ILUtil.html#Ogre_1_1ILUtile0">ilFormat2OgreFormat</a> (int ImageFormat, int ImageType)</td></tr>
16
17<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get OGRE format to which a given IL format can be most optimally converted.  <a href="#Ogre_1_1ILUtile0"></a><br><br></td></tr>
18<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="structOgre_1_1ILUtil_1_1ILFormat.html">ILFormat</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ILUtil.html#Ogre_1_1ILUtile1">OgreFormat2ilFormat</a> (<a class="el" href="namespaceOgre.html#a667">PixelFormat</a> format)</td></tr>
19
20<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get IL format that matches a given OGRE format exactly in memory.  <a href="#Ogre_1_1ILUtile1"></a><br><br></td></tr>
21<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ILUtil.html#Ogre_1_1ILUtile2">toOgre</a> (const <a class="el" href="classOgre_1_1PixelBox.html">PixelBox</a> &amp;dst)</td></tr>
22
23<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Convert current IL image to an OGRE format.  <a href="#Ogre_1_1ILUtile2"></a><br><br></td></tr>
24<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ILUtil.html#Ogre_1_1ILUtile3">fromOgre</a> (const <a class="el" href="classOgre_1_1PixelBox.html">PixelBox</a> &amp;src)</td></tr>
25
26<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Convert an OGRE format image to current IL image.  <a href="#Ogre_1_1ILUtile3"></a><br><br></td></tr>
27</table>
28<hr><h2>Member Function Documentation</h2>
29<a class="anchor" name="Ogre_1_1ILUtile3" doxytag="Ogre::ILUtil::fromOgre" ></a><p>
30<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
31  <tr>
32    <td class="mdRow">
33      <table cellpadding="0" cellspacing="0" border="0">
34        <tr>
35          <td class="md" nowrap valign="top"> void Ogre::ILUtil::fromOgre </td>
36          <td class="md" valign="top">(&nbsp;</td>
37          <td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1PixelBox.html">PixelBox</a> &amp;&nbsp;</td>
38          <td class="mdname1" valign="top" nowrap> <em>src</em>          </td>
39          <td class="md" valign="top">&nbsp;)&nbsp;</td>
40          <td class="md" nowrap><code> [static]</code></td>
41        </tr>
42
43      </table>
44    </td>
45  </tr>
46</table>
47<table cellspacing=5 cellpadding=0 border=0>
48  <tr>
49    <td>
50      &nbsp;
51    </td>
52    <td>
53
54<p>
55Convert an OGRE format image to current IL image.
56<p>
57<dl compact><dt><b>Parameters:</b></dt><dd>
58  <table border="0" cellspacing="2" cellpadding="0">
59    <tr><td valign=top><em>src</em>&nbsp;</td><td>Pixelbox; encapsulates source pointer, width, height, depth and format </td></tr>
60  </table>
61</dl>
62    </td>
63  </tr>
64</table>
65<a class="anchor" name="Ogre_1_1ILUtile0" doxytag="Ogre::ILUtil::ilFormat2OgreFormat" ></a><p>
66<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
67  <tr>
68    <td class="mdRow">
69      <table cellpadding="0" cellspacing="0" border="0">
70        <tr>
71          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a667">PixelFormat</a> Ogre::ILUtil::ilFormat2OgreFormat </td>
72          <td class="md" valign="top">(&nbsp;</td>
73          <td class="md" nowrap valign="top">int&nbsp;</td>
74          <td class="mdname" nowrap> <em>ImageFormat</em>, </td>
75        </tr>
76        <tr>
77          <td class="md" nowrap align="right"></td>
78          <td></td>
79          <td class="md" nowrap>int&nbsp;</td>
80          <td class="mdname" nowrap> <em>ImageType</em></td>
81        </tr>
82        <tr>
83          <td></td>
84          <td class="md">)&nbsp;</td>
85          <td class="md" colspan="2"><code> [static]</code></td>
86        </tr>
87
88      </table>
89    </td>
90  </tr>
91</table>
92<table cellspacing=5 cellpadding=0 border=0>
93  <tr>
94    <td>
95      &nbsp;
96    </td>
97    <td>
98
99<p>
100Get OGRE format to which a given IL format can be most optimally converted.
101<p>
102    </td>
103  </tr>
104</table>
105<a class="anchor" name="Ogre_1_1ILUtile1" doxytag="Ogre::ILUtil::OgreFormat2ilFormat" ></a><p>
106<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
107  <tr>
108    <td class="mdRow">
109      <table cellpadding="0" cellspacing="0" border="0">
110        <tr>
111          <td class="md" nowrap valign="top"> <a class="el" href="structOgre_1_1ILUtil_1_1ILFormat.html">ILFormat</a> Ogre::ILUtil::OgreFormat2ilFormat </td>
112          <td class="md" valign="top">(&nbsp;</td>
113          <td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a667">PixelFormat</a>&nbsp;</td>
114          <td class="mdname1" valign="top" nowrap> <em>format</em>          </td>
115          <td class="md" valign="top">&nbsp;)&nbsp;</td>
116          <td class="md" nowrap><code> [static]</code></td>
117        </tr>
118
119      </table>
120    </td>
121  </tr>
122</table>
123<table cellspacing=5 cellpadding=0 border=0>
124  <tr>
125    <td>
126      &nbsp;
127    </td>
128    <td>
129
130<p>
131Get IL format that matches a given OGRE format exactly in memory.
132<p>
133<dl compact><dt><b>Remarks:</b></dt><dd>Returns an invalid <a class="el" href="structOgre_1_1ILUtil_1_1ILFormat.html">ILFormat</a> (.isValid()==false) when there is no IL format that matches this. </dd></dl>
134    </td>
135  </tr>
136</table>
137<a class="anchor" name="Ogre_1_1ILUtile2" doxytag="Ogre::ILUtil::toOgre" ></a><p>
138<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
139  <tr>
140    <td class="mdRow">
141      <table cellpadding="0" cellspacing="0" border="0">
142        <tr>
143          <td class="md" nowrap valign="top"> void Ogre::ILUtil::toOgre </td>
144          <td class="md" valign="top">(&nbsp;</td>
145          <td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1PixelBox.html">PixelBox</a> &amp;&nbsp;</td>
146          <td class="mdname1" valign="top" nowrap> <em>dst</em>          </td>
147          <td class="md" valign="top">&nbsp;)&nbsp;</td>
148          <td class="md" nowrap><code> [static]</code></td>
149        </tr>
150
151      </table>
152    </td>
153  </tr>
154</table>
155<table cellspacing=5 cellpadding=0 border=0>
156  <tr>
157    <td>
158      &nbsp;
159    </td>
160    <td>
161
162<p>
163Convert current IL image to an OGRE format.
164<p>
165The size of the target will be PixelUtil::getNumElemBytes(fmt) * ilGetInteger( IL_IMAGE_WIDTH ) * ilGetInteger( IL_IMAGE_HEIGHT ) * ilGetInteger( IL_IMAGE_DEPTH ) The IL image type must be IL(_UNSIGNED_)BYTE or IL_FLOAT. The IL image format must be IL_RGBA, IL_BGRA, IL_RGB, IL_BGR, IL_LUMINANCE or IL_LUMINANCE_ALPHA<p>
166<dl compact><dt><b>Parameters:</b></dt><dd>
167  <table border="0" cellspacing="2" cellpadding="0">
168    <tr><td valign=top><em>tar</em>&nbsp;</td><td>Target pointer </td></tr>
169    <tr><td valign=top><em>ogrefmt</em>&nbsp;</td><td><a class="el" href="namespaceOgre.html">Ogre</a> pixel format to employ </td></tr>
170  </table>
171</dl>
172    </td>
173  </tr>
174</table>
175<hr>The documentation for this class was generated from the following file:<ul>
176<li><a class="el" href="OgreILUtil_8h-source.html">OgreILUtil.h</a></ul>
177<hr>
178<p>
179Copyright &copy; 2000-2005 by The OGRE Team<br />
180<!--Creative Commons License--><a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/"><img alt="Creative Commons License" border="0" src="http://creativecommons.org/images/public/somerights20.png"/></a><br/>
181This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/">Creative Commons Attribution-ShareAlike 2.5 License</a>.<br/>
182                <!--/Creative Commons License--><!-- <rdf:RDF xmlns="http://web.resource.org/cc/" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
183                <Work rdf:about="">
184                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
185        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
186                </Work>
187                <License rdf:about="http://creativecommons.org/licenses/by-sa/2.5/"><permits rdf:resource="http://web.resource.org/cc/Reproduction"/><permits rdf:resource="http://web.resource.org/cc/Distribution"/><requires rdf:resource="http://web.resource.org/cc/Notice"/><requires rdf:resource="http://web.resource.org/cc/Attribution"/><permits rdf:resource="http://web.resource.org/cc/DerivativeWorks"/><requires rdf:resource="http://web.resource.org/cc/ShareAlike"/></License></rdf:RDF> -->
188
189Last modified Sun Feb 12 13:00:48 2006
190</p>
191</body>
192</html>
Note: See TracBrowser for help on using the repository browser.