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

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

added ogre dependencies and patched ogre sources
Line 
1<html>
2<head>
3<title>Ogre::GLPixelUtil 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::GLPixelUtil Class Reference</h1>Class to do pixel format mapping between GL and OGRE. 
11<a href="#_details">More...</a>
12<p>
13<code>#include &lt;<a class="el" href="OgreGLPixelFormat_8h-source.html">OgreGLPixelFormat.h</a>&gt;</code>
14<p>
15<a href="classOgre_1_1GLPixelUtil-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>Static Public Member Functions</h2></td></tr>
18<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="OgreGLPrerequisites_8h.html#a41">GLenum</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1GLPixelUtil.html#Ogre_1_1GLPixelUtile0">getGLOriginFormat</a> (<a class="el" href="namespaceOgre.html#a667">PixelFormat</a> mFormat)</td></tr>
19
20<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Takes the OGRE pixel format and returns the appropriate GL one.  <a href="#Ogre_1_1GLPixelUtile0"></a><br><br></td></tr>
21<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="OgreGLPrerequisites_8h.html#a41">GLenum</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1GLPixelUtil.html#Ogre_1_1GLPixelUtile1">getGLOriginDataType</a> (<a class="el" href="namespaceOgre.html#a667">PixelFormat</a> mFormat)</td></tr>
22
23<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Takes the OGRE pixel format and returns type that must be provided to GL as data type for reading it into the GPU.  <a href="#Ogre_1_1GLPixelUtile1"></a><br><br></td></tr>
24<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="OgreGLPrerequisites_8h.html#a41">GLenum</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1GLPixelUtil.html#Ogre_1_1GLPixelUtile2">getClosestGLInternalFormat</a> (<a class="el" href="namespaceOgre.html#a667">PixelFormat</a> mFormat)</td></tr>
25
26<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Takes the OGRE pixel format and returns the type that must be provided to GL as internal format.  <a href="#Ogre_1_1GLPixelUtile2"></a><br><br></td></tr>
27<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_1GLPixelUtil.html#Ogre_1_1GLPixelUtile3">getClosestOGREFormat</a> (<a class="el" href="OgreGLPrerequisites_8h.html#a41">GLenum</a> fmt)</td></tr>
28
29<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Function to get the closest matching OGRE format to an internal GL format.  <a href="#Ogre_1_1GLPixelUtile3"></a><br><br></td></tr>
30<tr><td class="memItemLeft" nowrap align=right valign=top>size_t&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1GLPixelUtil.html#Ogre_1_1GLPixelUtile4">getMaxMipmaps</a> (size_t width, size_t height, size_t depth, <a class="el" href="namespaceOgre.html#a667">PixelFormat</a> format)</td></tr>
31
32<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the maximum number of Mipmaps that can be generated until we reach the mininum format possible.  <a href="#Ogre_1_1GLPixelUtile4"></a><br><br></td></tr>
33</table>
34<hr><a name="_details"></a><h2>Detailed Description</h2>
35Class to do pixel format mapping between GL and OGRE.
36<p>
37
38<p>
39Definition at line <a class="el" href="OgreGLPixelFormat_8h-source.html#l00034">34</a> of file <a class="el" href="OgreGLPixelFormat_8h-source.html">OgreGLPixelFormat.h</a>.<hr><h2>Member Function Documentation</h2>
40<a class="anchor" name="Ogre_1_1GLPixelUtile2" doxytag="Ogre::GLPixelUtil::getClosestGLInternalFormat" ></a><p>
41<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
42  <tr>
43    <td class="mdRow">
44      <table cellpadding="0" cellspacing="0" border="0">
45        <tr>
46          <td class="md" nowrap valign="top"> <a class="el" href="OgreGLPrerequisites_8h.html#a41">GLenum</a> Ogre::GLPixelUtil::getClosestGLInternalFormat </td>
47          <td class="md" valign="top">(&nbsp;</td>
48          <td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a667">PixelFormat</a>&nbsp;</td>
49          <td class="mdname1" valign="top" nowrap> <em>mFormat</em>          </td>
50          <td class="md" valign="top">&nbsp;)&nbsp;</td>
51          <td class="md" nowrap><code> [static]</code></td>
52        </tr>
53
54      </table>
55    </td>
56  </tr>
57</table>
58<table cellspacing=5 cellpadding=0 border=0>
59  <tr>
60    <td>
61      &nbsp;
62    </td>
63    <td>
64
65<p>
66Takes the OGRE pixel format and returns the type that must be provided to GL as internal format.
67<p>
68    </td>
69  </tr>
70</table>
71<a class="anchor" name="Ogre_1_1GLPixelUtile3" doxytag="Ogre::GLPixelUtil::getClosestOGREFormat" ></a><p>
72<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
73  <tr>
74    <td class="mdRow">
75      <table cellpadding="0" cellspacing="0" border="0">
76        <tr>
77          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a667">PixelFormat</a> Ogre::GLPixelUtil::getClosestOGREFormat </td>
78          <td class="md" valign="top">(&nbsp;</td>
79          <td class="md" nowrap valign="top"><a class="el" href="OgreGLPrerequisites_8h.html#a41">GLenum</a>&nbsp;</td>
80          <td class="mdname1" valign="top" nowrap> <em>fmt</em>          </td>
81          <td class="md" valign="top">&nbsp;)&nbsp;</td>
82          <td class="md" nowrap><code> [static]</code></td>
83        </tr>
84
85      </table>
86    </td>
87  </tr>
88</table>
89<table cellspacing=5 cellpadding=0 border=0>
90  <tr>
91    <td>
92      &nbsp;
93    </td>
94    <td>
95
96<p>
97Function to get the closest matching OGRE format to an internal GL format.
98<p>
99To be precise, the format will be chosen that is most efficient to transfer to the card without losing precision. <dl compact><dt><b>Remarks:</b></dt><dd>It is valid for this function to always return PF_A8R8G8B8.</dd></dl>
100    </td>
101  </tr>
102</table>
103<a class="anchor" name="Ogre_1_1GLPixelUtile1" doxytag="Ogre::GLPixelUtil::getGLOriginDataType" ></a><p>
104<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
105  <tr>
106    <td class="mdRow">
107      <table cellpadding="0" cellspacing="0" border="0">
108        <tr>
109          <td class="md" nowrap valign="top"> <a class="el" href="OgreGLPrerequisites_8h.html#a41">GLenum</a> Ogre::GLPixelUtil::getGLOriginDataType </td>
110          <td class="md" valign="top">(&nbsp;</td>
111          <td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a667">PixelFormat</a>&nbsp;</td>
112          <td class="mdname1" valign="top" nowrap> <em>mFormat</em>          </td>
113          <td class="md" valign="top">&nbsp;)&nbsp;</td>
114          <td class="md" nowrap><code> [static]</code></td>
115        </tr>
116
117      </table>
118    </td>
119  </tr>
120</table>
121<table cellspacing=5 cellpadding=0 border=0>
122  <tr>
123    <td>
124      &nbsp;
125    </td>
126    <td>
127
128<p>
129Takes the OGRE pixel format and returns type that must be provided to GL as data type for reading it into the GPU.
130<p>
131<dl compact><dt><b>Returns:</b></dt><dd>a GLenum describing the data type, or 0 if there is no exactly matching one (and conversion is needed)</dd></dl>
132    </td>
133  </tr>
134</table>
135<a class="anchor" name="Ogre_1_1GLPixelUtile0" doxytag="Ogre::GLPixelUtil::getGLOriginFormat" ></a><p>
136<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
137  <tr>
138    <td class="mdRow">
139      <table cellpadding="0" cellspacing="0" border="0">
140        <tr>
141          <td class="md" nowrap valign="top"> <a class="el" href="OgreGLPrerequisites_8h.html#a41">GLenum</a> Ogre::GLPixelUtil::getGLOriginFormat </td>
142          <td class="md" valign="top">(&nbsp;</td>
143          <td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a667">PixelFormat</a>&nbsp;</td>
144          <td class="mdname1" valign="top" nowrap> <em>mFormat</em>          </td>
145          <td class="md" valign="top">&nbsp;)&nbsp;</td>
146          <td class="md" nowrap><code> [static]</code></td>
147        </tr>
148
149      </table>
150    </td>
151  </tr>
152</table>
153<table cellspacing=5 cellpadding=0 border=0>
154  <tr>
155    <td>
156      &nbsp;
157    </td>
158    <td>
159
160<p>
161Takes the OGRE pixel format and returns the appropriate GL one.
162<p>
163<dl compact><dt><b>Returns:</b></dt><dd>a GLenum describing the format, or 0 if there is no exactly matching one (and conversion is needed)</dd></dl>
164    </td>
165  </tr>
166</table>
167<a class="anchor" name="Ogre_1_1GLPixelUtile4" doxytag="Ogre::GLPixelUtil::getMaxMipmaps" ></a><p>
168<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
169  <tr>
170    <td class="mdRow">
171      <table cellpadding="0" cellspacing="0" border="0">
172        <tr>
173          <td class="md" nowrap valign="top"> size_t Ogre::GLPixelUtil::getMaxMipmaps </td>
174          <td class="md" valign="top">(&nbsp;</td>
175          <td class="md" nowrap valign="top">size_t&nbsp;</td>
176          <td class="mdname" nowrap> <em>width</em>, </td>
177        </tr>
178        <tr>
179          <td class="md" nowrap align="right"></td>
180          <td></td>
181          <td class="md" nowrap>size_t&nbsp;</td>
182          <td class="mdname" nowrap> <em>height</em>, </td>
183        </tr>
184        <tr>
185          <td class="md" nowrap align="right"></td>
186          <td></td>
187          <td class="md" nowrap>size_t&nbsp;</td>
188          <td class="mdname" nowrap> <em>depth</em>, </td>
189        </tr>
190        <tr>
191          <td class="md" nowrap align="right"></td>
192          <td></td>
193          <td class="md" nowrap><a class="el" href="namespaceOgre.html#a667">PixelFormat</a>&nbsp;</td>
194          <td class="mdname" nowrap> <em>format</em></td>
195        </tr>
196        <tr>
197          <td></td>
198          <td class="md">)&nbsp;</td>
199          <td class="md" colspan="2"><code> [static]</code></td>
200        </tr>
201
202      </table>
203    </td>
204  </tr>
205</table>
206<table cellspacing=5 cellpadding=0 border=0>
207  <tr>
208    <td>
209      &nbsp;
210    </td>
211    <td>
212
213<p>
214Returns the maximum number of Mipmaps that can be generated until we reach the mininum format possible.
215<p>
216This does not count the base level. <dl compact><dt><b>Parameters:</b></dt><dd>
217  <table border="0" cellspacing="2" cellpadding="0">
218    <tr><td valign=top><em>width</em>&nbsp;</td><td>The width of the area </td></tr>
219    <tr><td valign=top><em>height</em>&nbsp;</td><td>The height of the area </td></tr>
220    <tr><td valign=top><em>depth</em>&nbsp;</td><td>The depth of the area </td></tr>
221    <tr><td valign=top><em>format</em>&nbsp;</td><td>The format of the area </td></tr>
222  </table>
223</dl>
224<dl compact><dt><b>Remarks:</b></dt><dd>In case that the format is non-compressed, this simply returns how many times we can divide this texture in 2 until we reach 1x1. For compressed formats, constraints apply on minimum size and alignment so this might differ.</dd></dl>
225    </td>
226  </tr>
227</table>
228<hr>The documentation for this class was generated from the following file:<ul>
229<li><a class="el" href="OgreGLPixelFormat_8h-source.html">OgreGLPixelFormat.h</a></ul>
230<hr>
231<p>
232Copyright &copy; 2000-2005 by The OGRE Team<br />
233<!--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/>
234This 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/>
235                <!--/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#">
236                <Work rdf:about="">
237                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
238        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
239                </Work>
240                <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> -->
241
242Last modified Sun Feb 12 13:10:19 2006
243</p>
244</body>
245</html>
Note: See TracBrowser for help on using the repository browser.