1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Crazy Eddies GUI System: CEGUI::OgreImageCodec Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.4 -->
<script type="text/javascript">
function hasClass(ele,cls) {
return ele.className.match(new RegExp('(\\s|^)'+cls+'(\\s|$)'));
}
function addClass(ele,cls) {
if (!this.hasClass(ele,cls)) ele.className += " "+cls;
}
function removeClass(ele,cls) {
if (hasClass(ele,cls)) {
var reg = new RegExp('(\\s|^)'+cls+'(\\s|$)');
ele.className=ele.className.replace(reg,' ');
}
}
function toggleVisibility(linkObj) {
var base = linkObj.getAttribute('id');
var summary = document.getElementById(base + '-summary');
var content = document.getElementById(base + '-content');
var trigger = document.getElementById(base + '-trigger');
if ( hasClass(linkObj,'closed') ) {
summary.style.display = 'none';
content.style.display = 'block';
trigger.src = 'open.png';
removeClass(linkObj,'closed');
addClass(linkObj,'opened');
} else if ( hasClass(linkObj,'opened') ) {
summary.style.display = 'block';
content.style.display = 'none';
trigger.src = 'closed.png';
removeClass(linkObj,'opened');
addClass(linkObj,'closed');
}
return false;
}
</script>
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Crazy Eddies GUI System <span id="projectnumber">0.7.6</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceCEGUI.html">CEGUI</a> </li>
<li class="navelem"><a class="el" href="classCEGUI_1_1OgreImageCodec.html">OgreImageCodec</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle">
<div class="title">CEGUI::OgreImageCodec Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::OgreImageCodec" --><!-- doxytag: inherits="CEGUI::ImageCodec" -->
<p><a class="el" href="classCEGUI_1_1ImageCodec.html" title="Abstract ImageLoader class. An image loader encapsulate the loading of a texture.">ImageCodec</a> object that loads data via image loading facilities in Ogre.
<a href="classCEGUI_1_1OgreImageCodec.html#details">More...</a></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png"/> Inheritance diagram for CEGUI::OgreImageCodec:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classCEGUI_1_1OgreImageCodec__inherit__graph.gif" border="0" usemap="#CEGUI_1_1OgreImageCodec_inherit__map" alt="Inheritance graph"/></div>
<map name="CEGUI_1_1OgreImageCodec_inherit__map" id="CEGUI_1_1OgreImageCodec_inherit__map">
<area shape="rect" id="node2" href="classCEGUI_1_1ImageCodec.html" title="Abstract ImageLoader class. An image loader encapsulate the loading of a texture." alt="" coords="19,5,165,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div id="dynsection-1" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-1-trigger" src="closed.png"/> Collaboration diagram for CEGUI::OgreImageCodec:</div>
<div id="dynsection-1-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-1-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classCEGUI_1_1OgreImageCodec__coll__graph.gif" border="0" usemap="#CEGUI_1_1OgreImageCodec_coll__map" alt="Collaboration graph"/></div>
<map name="CEGUI_1_1OgreImageCodec_coll__map" id="CEGUI_1_1OgreImageCodec_coll__map">
<area shape="rect" id="node2" href="classCEGUI_1_1ImageCodec.html" title="Abstract ImageLoader class. An image loader encapsulate the loading of a texture." alt="" coords="145,117,292,147"/><area shape="rect" id="node4" href="classCEGUI_1_1String.html" title="String class used within the GUI system." alt="" coords="41,5,148,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classCEGUI_1_1OgreImageCodec-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaf56dbf2722c09d778f92d0178314f0b"></a><!-- doxytag: member="CEGUI::OgreImageCodec::OgreImageCodec" ref="aaf56dbf2722c09d778f92d0178314f0b" args="()" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OgreImageCodec.html#aaf56dbf2722c09d778f92d0178314f0b">OgreImageCodec</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OgreImageCodec.html#a2308012a6dbadc4eec3c04a49690f849">setImageFileDataType</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &type)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the file-type identifier that will be used for future load operations. <a href="#a2308012a6dbadc4eec3c04a49690f849"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4cc384fa58293b9c955384138698387e"></a><!-- doxytag: member="CEGUI::OgreImageCodec::getImageFileDataType" ref="a4cc384fa58293b9c955384138698387e" args="() const " -->
const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OgreImageCodec.html#a4cc384fa58293b9c955384138698387e">getImageFileDataType</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the string descibing the currently set file type. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCEGUI_1_1Texture.html">Texture</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OgreImageCodec.html#a9c9bb31ba2713b7b116410e995b7dbca">load</a> (const <a class="el" href="classCEGUI_1_1RawDataContainer.html">RawDataContainer</a> &data, <a class="el" href="classCEGUI_1_1Texture.html">Texture</a> *result)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Load an image from a memory buffer. <a href="#a9c9bb31ba2713b7b116410e995b7dbca"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a87210ac0f94fb705ce8c33907c869705"></a><!-- doxytag: member="CEGUI::OgreImageCodec::d_dataTypeID" ref="a87210ac0f94fb705ce8c33907c869705" args="" -->
<a class="el" href="classCEGUI_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OgreImageCodec.html#a87210ac0f94fb705ce8c33907c869705">d_dataTypeID</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Holds currently set file data type specifier (i.e. the file extension). <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classCEGUI_1_1ImageCodec.html" title="Abstract ImageLoader class. An image loader encapsulate the loading of a texture.">ImageCodec</a> object that loads data via image loading facilities in Ogre. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a9c9bb31ba2713b7b116410e995b7dbca"></a><!-- doxytag: member="CEGUI::OgreImageCodec::load" ref="a9c9bb31ba2713b7b116410e995b7dbca" args="(const RawDataContainer &data, Texture *result)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCEGUI_1_1Texture.html">Texture</a>* CEGUI::OgreImageCodec::load </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1RawDataContainer.html">RawDataContainer</a> & </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1Texture.html">Texture</a> * </td>
<td class="paramname"><em>result</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Load an image from a memory buffer. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>the image data</td></tr>
<tr><td class="paramname">result</td><td>the texture to use for storing the image data</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>result on success or 0 if the load failed </dd></dl>
<p>Implements <a class="el" href="classCEGUI_1_1ImageCodec.html#a74501ad680f231d134e5e8a9584c6024">CEGUI::ImageCodec</a>.</p>
</div>
</div>
<a class="anchor" id="a2308012a6dbadc4eec3c04a49690f849"></a><!-- doxytag: member="CEGUI::OgreImageCodec::setImageFileDataType" ref="a2308012a6dbadc4eec3c04a49690f849" args="(const String &type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::OgreImageCodec::setImageFileDataType </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>type</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the file-type identifier that will be used for future load operations. </p>
<p>This allows us to pass the type on to Ogre when we process the image data (because it's just file data; we do not have a filename nor file extension). Ogre needs this sometimes in order to correctly select the right codec to use for the final decoding of the data. If this value is not set, loading may still succeed, though that will depend upon the specific libraries and codecs that the Ogre installation has available to it.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">type</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object that describes the type of file data that will be passed in subsequent load operations. Note that this type will typically be the file extension (or equivalent). </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Sun Jan 22 2012 16:07:42 for Crazy Eddies GUI System by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>
|
