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

Revision 657, 11.8 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::ILFormat struct 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::ILFormat Struct Reference</h1>Structure that encapsulates a devIL image format definition. 
11<a href="#_details">More...</a>
12<p>
13<code>#include &lt;<a class="el" href="OgreILUtil_8h-source.html">OgreILUtil.h</a>&gt;</code>
14<p>
15<a href="structOgre_1_1ILUtil_1_1ILFormat-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
16<tr><td></td></tr>
17<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
18<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="structOgre_1_1ILUtil_1_1ILFormat.html#Ogre_1_1ILUtil_1_1ILFormata0">ILFormat</a> ()</td></tr>
19
20<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Construct an invalidated <a class="el" href="structOgre_1_1ILUtil_1_1ILFormat.html">ILFormat</a> structure.  <a href="#Ogre_1_1ILUtil_1_1ILFormata0"></a><br><br></td></tr>
21<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="structOgre_1_1ILUtil_1_1ILFormat.html#Ogre_1_1ILUtil_1_1ILFormata1">ILFormat</a> (int channels, int <a class="el" href="structOgre_1_1ILUtil_1_1ILFormat.html#Ogre_1_1ILUtil_1_1ILFormato1">format</a>, int <a class="el" href="structOgre_1_1ILUtil_1_1ILFormat.html#Ogre_1_1ILUtil_1_1ILFormato2">type</a>=-1)</td></tr>
22
23<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Construct a <a class="el" href="structOgre_1_1ILUtil_1_1ILFormat.html">ILFormat</a> from parameters.  <a href="#Ogre_1_1ILUtil_1_1ILFormata1"></a><br><br></td></tr>
24<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="structOgre_1_1ILUtil_1_1ILFormat.html#Ogre_1_1ILUtil_1_1ILFormata2">isValid</a> ()</td></tr>
25
26<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return wether this structure represents a valid DevIL format.  <a href="#Ogre_1_1ILUtil_1_1ILFormata2"></a><br><br></td></tr>
27<tr><td colspan=2><br><h2>Public Attributes</h2></td></tr>
28<tr><td class="memItemLeft" nowrap align=right valign=top>int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="structOgre_1_1ILUtil_1_1ILFormat.html#Ogre_1_1ILUtil_1_1ILFormato0">numberOfChannels</a></td></tr>
29
30<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Number of channels, usually 3 or 4.  <a href="#Ogre_1_1ILUtil_1_1ILFormato0"></a><br><br></td></tr>
31<tr><td class="memItemLeft" nowrap align=right valign=top>int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="structOgre_1_1ILUtil_1_1ILFormat.html#Ogre_1_1ILUtil_1_1ILFormato1">format</a></td></tr>
32
33<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">IL_RGBA,IL_BGRA,IL_DXTx, ...  <a href="#Ogre_1_1ILUtil_1_1ILFormato1"></a><br><br></td></tr>
34<tr><td class="memItemLeft" nowrap align=right valign=top>int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="structOgre_1_1ILUtil_1_1ILFormat.html#Ogre_1_1ILUtil_1_1ILFormato2">type</a></td></tr>
35
36<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">IL_UNSIGNED_BYTE, IL_UNSIGNED_SHORT, ... may be -1 for compressed formats.  <a href="#Ogre_1_1ILUtil_1_1ILFormato2"></a><br><br></td></tr>
37</table>
38<hr><a name="_details"></a><h2>Detailed Description</h2>
39Structure that encapsulates a devIL image format definition.
40<p>
41
42<p>
43Definition at line <a class="el" href="OgreILUtil_8h-source.html#l00040">40</a> of file <a class="el" href="OgreILUtil_8h-source.html">OgreILUtil.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
44<a class="anchor" name="Ogre_1_1ILUtil_1_1ILFormata0" doxytag="Ogre::ILUtil::ILFormat::ILFormat" ></a><p>
45<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
46  <tr>
47    <td class="mdRow">
48      <table cellpadding="0" cellspacing="0" border="0">
49        <tr>
50          <td class="md" nowrap valign="top"> Ogre::ILUtil::ILFormat::ILFormat </td>
51          <td class="md" valign="top">(&nbsp;</td>
52          <td class="mdname1" valign="top" nowrap>          </td>
53          <td class="md" valign="top">&nbsp;)&nbsp;</td>
54          <td class="md" nowrap></td>
55        </tr>
56
57      </table>
58    </td>
59  </tr>
60</table>
61<table cellspacing=5 cellpadding=0 border=0>
62  <tr>
63    <td>
64      &nbsp;
65    </td>
66    <td>
67
68<p>
69Construct an invalidated <a class="el" href="structOgre_1_1ILUtil_1_1ILFormat.html">ILFormat</a> structure.
70<p>
71
72<p>
73Definition at line <a class="el" href="OgreILUtil_8h-source.html#l00042">42</a> of file <a class="el" href="OgreILUtil_8h-source.html">OgreILUtil.h</a>.    </td>
74  </tr>
75</table>
76<a class="anchor" name="Ogre_1_1ILUtil_1_1ILFormata1" doxytag="Ogre::ILUtil::ILFormat::ILFormat" ></a><p>
77<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
78  <tr>
79    <td class="mdRow">
80      <table cellpadding="0" cellspacing="0" border="0">
81        <tr>
82          <td class="md" nowrap valign="top"> Ogre::ILUtil::ILFormat::ILFormat </td>
83          <td class="md" valign="top">(&nbsp;</td>
84          <td class="md" nowrap valign="top">int&nbsp;</td>
85          <td class="mdname" nowrap> <em>channels</em>, </td>
86        </tr>
87        <tr>
88          <td class="md" nowrap align="right"></td>
89          <td></td>
90          <td class="md" nowrap>int&nbsp;</td>
91          <td class="mdname" nowrap> <em>format</em>, </td>
92        </tr>
93        <tr>
94          <td class="md" nowrap align="right"></td>
95          <td></td>
96          <td class="md" nowrap>int&nbsp;</td>
97          <td class="mdname" nowrap> <em>type</em> = -1</td>
98        </tr>
99        <tr>
100          <td></td>
101          <td class="md">)&nbsp;</td>
102          <td class="md" colspan="2"></td>
103        </tr>
104
105      </table>
106    </td>
107  </tr>
108</table>
109<table cellspacing=5 cellpadding=0 border=0>
110  <tr>
111    <td>
112      &nbsp;
113    </td>
114    <td>
115
116<p>
117Construct a <a class="el" href="structOgre_1_1ILUtil_1_1ILFormat.html">ILFormat</a> from parameters.
118<p>
119
120<p>
121Definition at line <a class="el" href="OgreILUtil_8h-source.html#l00046">46</a> of file <a class="el" href="OgreILUtil_8h-source.html">OgreILUtil.h</a>.    </td>
122  </tr>
123</table>
124<hr><h2>Member Function Documentation</h2>
125<a class="anchor" name="Ogre_1_1ILUtil_1_1ILFormata2" doxytag="Ogre::ILUtil::ILFormat::isValid" ></a><p>
126<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
127  <tr>
128    <td class="mdRow">
129      <table cellpadding="0" cellspacing="0" border="0">
130        <tr>
131          <td class="md" nowrap valign="top"> bool Ogre::ILUtil::ILFormat::isValid </td>
132          <td class="md" valign="top">(&nbsp;</td>
133          <td class="mdname1" valign="top" nowrap>          </td>
134          <td class="md" valign="top">&nbsp;)&nbsp;</td>
135          <td class="md" nowrap></td>
136        </tr>
137
138      </table>
139    </td>
140  </tr>
141</table>
142<table cellspacing=5 cellpadding=0 border=0>
143  <tr>
144    <td>
145      &nbsp;
146    </td>
147    <td>
148
149<p>
150Return wether this structure represents a valid DevIL format.
151<p>
152
153<p>
154Definition at line <a class="el" href="OgreILUtil_8h-source.html#l00050">50</a> of file <a class="el" href="OgreILUtil_8h-source.html">OgreILUtil.h</a>.    </td>
155  </tr>
156</table>
157<hr><h2>Member Data Documentation</h2>
158<a class="anchor" name="Ogre_1_1ILUtil_1_1ILFormato1" doxytag="Ogre::ILUtil::ILFormat::format" ></a><p>
159<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
160  <tr>
161    <td class="mdRow">
162      <table cellpadding="0" cellspacing="0" border="0">
163        <tr>
164          <td class="md" nowrap valign="top"> int <a class="el" href="structOgre_1_1ILUtil_1_1ILFormat.html#Ogre_1_1ILUtil_1_1ILFormato1">Ogre::ILUtil::ILFormat::format</a>
165      </table>
166    </td>
167  </tr>
168</table>
169<table cellspacing=5 cellpadding=0 border=0>
170  <tr>
171    <td>
172      &nbsp;
173    </td>
174    <td>
175
176<p>
177IL_RGBA,IL_BGRA,IL_DXTx, ...
178<p>
179
180<p>
181Definition at line <a class="el" href="OgreILUtil_8h-source.html#l00055">55</a> of file <a class="el" href="OgreILUtil_8h-source.html">OgreILUtil.h</a>.    </td>
182  </tr>
183</table>
184<a class="anchor" name="Ogre_1_1ILUtil_1_1ILFormato0" doxytag="Ogre::ILUtil::ILFormat::numberOfChannels" ></a><p>
185<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
186  <tr>
187    <td class="mdRow">
188      <table cellpadding="0" cellspacing="0" border="0">
189        <tr>
190          <td class="md" nowrap valign="top"> int <a class="el" href="structOgre_1_1ILUtil_1_1ILFormat.html#Ogre_1_1ILUtil_1_1ILFormato0">Ogre::ILUtil::ILFormat::numberOfChannels</a>
191      </table>
192    </td>
193  </tr>
194</table>
195<table cellspacing=5 cellpadding=0 border=0>
196  <tr>
197    <td>
198      &nbsp;
199    </td>
200    <td>
201
202<p>
203Number of channels, usually 3 or 4.
204<p>
205
206<p>
207Definition at line <a class="el" href="OgreILUtil_8h-source.html#l00053">53</a> of file <a class="el" href="OgreILUtil_8h-source.html">OgreILUtil.h</a>.    </td>
208  </tr>
209</table>
210<a class="anchor" name="Ogre_1_1ILUtil_1_1ILFormato2" doxytag="Ogre::ILUtil::ILFormat::type" ></a><p>
211<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
212  <tr>
213    <td class="mdRow">
214      <table cellpadding="0" cellspacing="0" border="0">
215        <tr>
216          <td class="md" nowrap valign="top"> int <a class="el" href="structOgre_1_1ILUtil_1_1ILFormat.html#Ogre_1_1ILUtil_1_1ILFormato2">Ogre::ILUtil::ILFormat::type</a>
217      </table>
218    </td>
219  </tr>
220</table>
221<table cellspacing=5 cellpadding=0 border=0>
222  <tr>
223    <td>
224      &nbsp;
225    </td>
226    <td>
227
228<p>
229IL_UNSIGNED_BYTE, IL_UNSIGNED_SHORT, ... may be -1 for compressed formats.
230<p>
231
232<p>
233Definition at line <a class="el" href="OgreILUtil_8h-source.html#l00057">57</a> of file <a class="el" href="OgreILUtil_8h-source.html">OgreILUtil.h</a>.    </td>
234  </tr>
235</table>
236<hr>The documentation for this struct was generated from the following file:<ul>
237<li><a class="el" href="OgreILUtil_8h-source.html">OgreILUtil.h</a></ul>
238<hr>
239<p>
240Copyright &copy; 2000-2005 by The OGRE Team<br />
241<!--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/>
242This 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/>
243                <!--/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#">
244                <Work rdf:about="">
245                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
246        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
247                </Work>
248                <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> -->
249
250Last modified Sun Feb 12 13:00:48 2006
251</p>
252</body>
253</html>
Note: See TracBrowser for help on using the repository browser.