1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2
<html xmlns="http://www.w3.org/1999/xhtml">
4
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5
<title>Crazy Eddies GUI System: CEGUI::OpenGLTexture Class Reference</title>
6
<link href="tabs.css" rel="stylesheet" type="text/css"/>
7
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
10
<!-- Generated by Doxygen 1.7.2 -->
11
<script type="text/javascript">
12
function hasClass(ele,cls) {
13
return ele.className.match(new RegExp('(\\s|^)'+cls+'(\\s|$)'));
16
function addClass(ele,cls) {
17
if (!this.hasClass(ele,cls)) ele.className += " "+cls;
20
function removeClass(ele,cls) {
21
if (hasClass(ele,cls)) {
22
var reg = new RegExp('(\\s|^)'+cls+'(\\s|$)');
23
ele.className=ele.className.replace(reg,' ');
27
function toggleVisibility(linkObj) {
28
var base = linkObj.getAttribute('id');
29
var summary = document.getElementById(base + '-summary');
30
var content = document.getElementById(base + '-content');
31
var trigger = document.getElementById(base + '-trigger');
32
if ( hasClass(linkObj,'closed') ) {
33
summary.style.display = 'none';
34
content.style.display = 'block';
35
trigger.src = 'open.png';
36
removeClass(linkObj,'closed');
37
addClass(linkObj,'opened');
38
} else if ( hasClass(linkObj,'opened') ) {
39
summary.style.display = 'block';
40
content.style.display = 'none';
41
trigger.src = 'closed.png';
42
removeClass(linkObj,'opened');
43
addClass(linkObj,'closed');
48
<div class="navigation" id="top">
51
<li><a href="index.html"><span>Main Page</span></a></li>
52
<li><a href="pages.html"><span>Related Pages</span></a></li>
53
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
54
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
55
<li><a href="files.html"><span>Files</span></a></li>
60
<li><a href="annotated.html"><span>Class List</span></a></li>
61
<li><a href="classes.html"><span>Class Index</span></a></li>
62
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
63
<li><a href="functions.html"><span>Class Members</span></a></li>
68
<li><a class="el" href="namespaceCEGUI.html">CEGUI</a> </li>
69
<li><a class="el" href="classCEGUI_1_1OpenGLTexture.html">OpenGLTexture</a> </li>
75
<a href="#pub-methods">Public Member Functions</a> |
76
<a href="#pro-methods">Protected Member Functions</a> |
77
<a href="#pro-attribs">Protected Attributes</a> |
78
<a href="#friends">Friends</a> </div>
79
<div class="headertitle">
80
<h1>CEGUI::OpenGLTexture Class Reference</h1> </div>
82
<div class="contents">
83
<!-- doxytag: class="CEGUI::OpenGLTexture" --><!-- doxytag: inherits="CEGUI::Texture" -->
84
<p><a class="el" href="classCEGUI_1_1Texture.html" title="Abstract base class specifying the required interface for Texture objects.">Texture</a> implementation for the <a class="el" href="classCEGUI_1_1OpenGLRenderer.html" title="Renderer class to interface with OpenGL.">OpenGLRenderer</a>.
85
<a href="#_details">More...</a></p>
86
<!-- startSectionHeader --><div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
87
<img id="dynsection-0-trigger" src="closed.png"/> Inheritance diagram for CEGUI::OpenGLTexture:<!-- endSectionHeader --></div>
88
<!-- startSectionSummary --><div id="dynsection-0-summary" class="dynsummary" style="display:block;">
89
<!-- endSectionSummary --></div>
90
<!-- startSectionContent --><div id="dynsection-0-content" class="dyncontent" style="display:none;">
91
<div class="center"><img src="classCEGUI_1_1OpenGLTexture__inherit__graph.gif" border="0" usemap="#CEGUI_1_1OpenGLTexture_inherit__map" alt="Inheritance graph"/></div>
92
<map name="CEGUI_1_1OpenGLTexture_inherit__map" id="CEGUI_1_1OpenGLTexture_inherit__map">
93
<area shape="rect" id="node2" href="classCEGUI_1_1Texture.html" title="Abstract base class specifying the required interface for Texture objects." alt="" coords="31,5,145,35"/></map>
94
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center><!-- endSectionContent --></div>
95
<!-- startSectionHeader --><div id="dynsection-1" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
96
<img id="dynsection-1-trigger" src="closed.png"/> Collaboration diagram for CEGUI::OpenGLTexture:<!-- endSectionHeader --></div>
97
<!-- startSectionSummary --><div id="dynsection-1-summary" class="dynsummary" style="display:block;">
98
<!-- endSectionSummary --></div>
99
<!-- startSectionContent --><div id="dynsection-1-content" class="dyncontent" style="display:none;">
100
<div class="center"><img src="classCEGUI_1_1OpenGLTexture__coll__graph.gif" border="0" usemap="#CEGUI_1_1OpenGLTexture_coll__map" alt="Collaboration graph"/></div>
101
<map name="CEGUI_1_1OpenGLTexture_coll__map" id="CEGUI_1_1OpenGLTexture_coll__map">
102
<area shape="rect" id="node2" href="classCEGUI_1_1Texture.html" title="Abstract base class specifying the required interface for Texture objects." alt="" coords="5,104,120,133"/><area shape="rect" id="node4" href="classCEGUI_1_1Size.html" title="Class that holds the size (width & height) of something." alt="" coords="177,5,273,35"/><area shape="rect" id="node6" href="classCEGUI_1_1OpenGLRenderer.html" title="Renderer class to interface with OpenGL." alt="" coords="264,104,443,133"/></map>
103
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center><!-- endSectionContent --></div>
105
<p><a href="classCEGUI_1_1OpenGLTexture-members.html">List of all members.</a></p>
106
<table class="memberdecls">
107
<tr><td colspan="2"><h2><a name="pub-methods"></a>
108
Public Member Functions</h2></td></tr>
109
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab9dad01ba3745cbbaf2ffe8ae1e772e1"></a><!-- doxytag: member="CEGUI::OpenGLTexture::setOpenGLTexture" ref="ab9dad01ba3745cbbaf2ffe8ae1e772e1" args="(GLuint tex, const Size &size)" -->
110
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OpenGLTexture.html#ab9dad01ba3745cbbaf2ffe8ae1e772e1">setOpenGLTexture</a> (GLuint tex, const <a class="el" href="classCEGUI_1_1Size.html">Size</a> &size)</td></tr>
111
<tr><td class="mdescLeft"> </td><td class="mdescRight">set the openGL texture that this <a class="el" href="classCEGUI_1_1Texture.html" title="Abstract base class specifying the required interface for Texture objects.">Texture</a> is based on to the specified texture, with the specified size. <br/></td></tr>
112
<tr><td class="memItemLeft" align="right" valign="top">GLuint </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OpenGLTexture.html#ac381786b999d877d16691f2191198244">getOpenGLTexture</a> () const </td></tr>
113
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the internal OpenGL texture id used by this <a class="el" href="classCEGUI_1_1Texture.html" title="Abstract base class specifying the required interface for Texture objects.">Texture</a> object. <a href="#ac381786b999d877d16691f2191198244"></a><br/></td></tr>
114
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OpenGLTexture.html#ae7465945cf05cb3b29710181a4b00b21">setTextureSize</a> (const <a class="el" href="classCEGUI_1_1Size.html">Size</a> &sz)</td></tr>
115
<tr><td class="mdescLeft"> </td><td class="mdescRight">set the size of the internal texture. <a href="#ae7465945cf05cb3b29710181a4b00b21"></a><br/></td></tr>
116
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OpenGLTexture.html#a1a91faad2eea97689c164634156ce44a">grabTexture</a> ()</td></tr>
117
<tr><td class="mdescLeft"> </td><td class="mdescRight">Grab the texture to a local buffer. <a href="#a1a91faad2eea97689c164634156ce44a"></a><br/></td></tr>
118
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae988679e3477c781285b177f45d6cff5"></a><!-- doxytag: member="CEGUI::OpenGLTexture::restoreTexture" ref="ae988679e3477c781285b177f45d6cff5" args="()" -->
119
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OpenGLTexture.html#ae988679e3477c781285b177f45d6cff5">restoreTexture</a> ()</td></tr>
120
<tr><td class="mdescLeft"> </td><td class="mdescRight">Restore the texture from the locally buffered copy previously create by a call to grabTexture. <br/></td></tr>
121
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classCEGUI_1_1Size.html">Size</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OpenGLTexture.html#a15c130382430151075ebbdd5edc0d7e2">getSize</a> () const </td></tr>
122
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the current pixel size of the texture. <a href="#a15c130382430151075ebbdd5edc0d7e2"></a><br/></td></tr>
123
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classCEGUI_1_1Size.html">Size</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OpenGLTexture.html#a3eb6251be58218921c1d9832e1b9f537">getOriginalDataSize</a> () const </td></tr>
124
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the original pixel size of the data loaded into the texture. <a href="#a3eb6251be58218921c1d9832e1b9f537"></a><br/></td></tr>
125
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classCEGUI_1_1Vector2.html">Vector2</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OpenGLTexture.html#afa2e23043b20cdc552868898316612f5">getTexelScaling</a> () const </td></tr>
126
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns pixel to texel scale values that should be used for converting pixel values to texture co-ords. <a href="#afa2e23043b20cdc552868898316612f5"></a><br/></td></tr>
127
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OpenGLTexture.html#a59ef0dad6986679fa0a4ad27e2835b9a">loadFromFile</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &filename, const <a class="el" href="classCEGUI_1_1String.html">String</a> &resourceGroup)</td></tr>
128
<tr><td class="mdescLeft"> </td><td class="mdescRight">Loads the specified image file into the texture. The texture is resized as required to hold the image. <a href="#a59ef0dad6986679fa0a4ad27e2835b9a"></a><br/></td></tr>
129
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OpenGLTexture.html#a70fc6856c52c051296deb26cc81ae1f8">loadFromMemory</a> (const void *buffer, const <a class="el" href="classCEGUI_1_1Size.html">Size</a> &buffer_size, <a class="el" href="classCEGUI_1_1Texture.html#a2156af785c41d517b3d8c6668ac08e45">PixelFormat</a> pixel_format)</td></tr>
130
<tr><td class="mdescLeft"> </td><td class="mdescRight">Loads (copies) an image in memory into the texture. The texture is resized as required to hold the image. <a href="#a70fc6856c52c051296deb26cc81ae1f8"></a><br/></td></tr>
131
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OpenGLTexture.html#a7578b8643ccbfa24f88d408dcf4aa279">saveToMemory</a> (void *buffer)</td></tr>
132
<tr><td class="mdescLeft"> </td><td class="mdescRight">Save / dump the content of the texture to a memory buffer. The dumped pixel format is always RGBA (4 bytes per pixel). <a href="#a7578b8643ccbfa24f88d408dcf4aa279"></a><br/></td></tr>
133
<tr><td colspan="2"><h2><a name="pro-methods"></a>
134
Protected Member Functions</h2></td></tr>
135
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afc94eca51750f2daa4484c62d77702f4"></a><!-- doxytag: member="CEGUI::OpenGLTexture::OpenGLTexture" ref="afc94eca51750f2daa4484c62d77702f4" args="(OpenGLRenderer &owner)" -->
136
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OpenGLTexture.html#afc94eca51750f2daa4484c62d77702f4">OpenGLTexture</a> (<a class="el" href="classCEGUI_1_1OpenGLRenderer.html">OpenGLRenderer</a> &owner)</td></tr>
137
<tr><td class="mdescLeft"> </td><td class="mdescRight">Basic constructor. <br/></td></tr>
138
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1e0267fd1f63ea7d4fa9e051b08a6d8d"></a><!-- doxytag: member="CEGUI::OpenGLTexture::OpenGLTexture" ref="a1e0267fd1f63ea7d4fa9e051b08a6d8d" args="(OpenGLRenderer &owner, const String &filename, const String &resourceGroup)" -->
139
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OpenGLTexture.html#a1e0267fd1f63ea7d4fa9e051b08a6d8d">OpenGLTexture</a> (<a class="el" href="classCEGUI_1_1OpenGLRenderer.html">OpenGLRenderer</a> &owner, const <a class="el" href="classCEGUI_1_1String.html">String</a> &filename, const <a class="el" href="classCEGUI_1_1String.html">String</a> &resourceGroup)</td></tr>
140
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor that creates a <a class="el" href="classCEGUI_1_1Texture.html" title="Abstract base class specifying the required interface for Texture objects.">Texture</a> from an image file. <br/></td></tr>
141
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af77ca4f7a3428c6dc3cdc23d00a6686a"></a><!-- doxytag: member="CEGUI::OpenGLTexture::OpenGLTexture" ref="af77ca4f7a3428c6dc3cdc23d00a6686a" args="(OpenGLRenderer &owner, const Size &size)" -->
142
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OpenGLTexture.html#af77ca4f7a3428c6dc3cdc23d00a6686a">OpenGLTexture</a> (<a class="el" href="classCEGUI_1_1OpenGLRenderer.html">OpenGLRenderer</a> &owner, const <a class="el" href="classCEGUI_1_1Size.html">Size</a> &size)</td></tr>
143
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor that creates a <a class="el" href="classCEGUI_1_1Texture.html" title="Abstract base class specifying the required interface for Texture objects.">Texture</a> with a given size. <br/></td></tr>
144
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af3fb9ded2123263f4033417393d792f5"></a><!-- doxytag: member="CEGUI::OpenGLTexture::OpenGLTexture" ref="af3fb9ded2123263f4033417393d792f5" args="(OpenGLRenderer &owner, GLuint tex, const Size &size)" -->
145
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OpenGLTexture.html#af3fb9ded2123263f4033417393d792f5">OpenGLTexture</a> (<a class="el" href="classCEGUI_1_1OpenGLRenderer.html">OpenGLRenderer</a> &owner, GLuint tex, const <a class="el" href="classCEGUI_1_1Size.html">Size</a> &size)</td></tr>
146
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor that wraps an existing GL texture. <br/></td></tr>
147
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac526b435a5d72cb10ad0a1e5c459f227"></a><!-- doxytag: member="CEGUI::OpenGLTexture::~OpenGLTexture" ref="ac526b435a5d72cb10ad0a1e5c459f227" args="()" -->
148
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OpenGLTexture.html#ac526b435a5d72cb10ad0a1e5c459f227">~OpenGLTexture</a> ()</td></tr>
149
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br/></td></tr>
150
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab2389e8941c5d38a0ddad8f3dd09bc6d"></a><!-- doxytag: member="CEGUI::OpenGLTexture::generateOpenGLTexture" ref="ab2389e8941c5d38a0ddad8f3dd09bc6d" args="()" -->
151
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OpenGLTexture.html#ab2389e8941c5d38a0ddad8f3dd09bc6d">generateOpenGLTexture</a> ()</td></tr>
152
<tr><td class="mdescLeft"> </td><td class="mdescRight">generate the OpenGL texture and set some initial options. <br/></td></tr>
153
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0a792898d7e766780e29d6352857f24e"></a><!-- doxytag: member="CEGUI::OpenGLTexture::updateCachedScaleValues" ref="a0a792898d7e766780e29d6352857f24e" args="()" -->
154
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OpenGLTexture.html#a0a792898d7e766780e29d6352857f24e">updateCachedScaleValues</a> ()</td></tr>
155
<tr><td class="mdescLeft"> </td><td class="mdescRight">updates cached scale value used to map pixels to texture co-ords. <br/></td></tr>
156
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a719641185dfb668cf725d81a52c4f533"></a><!-- doxytag: member="CEGUI::OpenGLTexture::cleanupOpenGLTexture" ref="a719641185dfb668cf725d81a52c4f533" args="()" -->
157
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OpenGLTexture.html#a719641185dfb668cf725d81a52c4f533">cleanupOpenGLTexture</a> ()</td></tr>
158
<tr><td class="mdescLeft"> </td><td class="mdescRight">clean up the GL texture, or the grab buffer if it had been grabbed <br/></td></tr>
159
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
160
Protected Attributes</h2></td></tr>
161
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a40985213377f308dc0d502d98d023fa5"></a><!-- doxytag: member="CEGUI::OpenGLTexture::d_ogltexture" ref="a40985213377f308dc0d502d98d023fa5" args="" -->
162
GLuint </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OpenGLTexture.html#a40985213377f308dc0d502d98d023fa5">d_ogltexture</a></td></tr>
163
<tr><td class="mdescLeft"> </td><td class="mdescRight">The OpenGL texture we're wrapping. <br/></td></tr>
164
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8de675226a6176bb0cd49e74fbaec8e9"></a><!-- doxytag: member="CEGUI::OpenGLTexture::d_size" ref="a8de675226a6176bb0cd49e74fbaec8e9" args="" -->
165
<a class="el" href="classCEGUI_1_1Size.html">Size</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OpenGLTexture.html#a8de675226a6176bb0cd49e74fbaec8e9">d_size</a></td></tr>
166
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classCEGUI_1_1Size.html" title="Class that holds the size (width & height) of something.">Size</a> of the texture. <br/></td></tr>
167
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aca5b1ace05044d6414610ed81d5545eb"></a><!-- doxytag: member="CEGUI::OpenGLTexture::d_grabBuffer" ref="aca5b1ace05044d6414610ed81d5545eb" args="" -->
168
uint8 * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OpenGLTexture.html#aca5b1ace05044d6414610ed81d5545eb">d_grabBuffer</a></td></tr>
169
<tr><td class="mdescLeft"> </td><td class="mdescRight">cached image data for restoring the texture. <br/></td></tr>
170
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4e59d10b98ec9ca53152204b49c6cf76"></a><!-- doxytag: member="CEGUI::OpenGLTexture::d_dataSize" ref="a4e59d10b98ec9ca53152204b49c6cf76" args="" -->
171
<a class="el" href="classCEGUI_1_1Size.html">Size</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OpenGLTexture.html#a4e59d10b98ec9ca53152204b49c6cf76">d_dataSize</a></td></tr>
172
<tr><td class="mdescLeft"> </td><td class="mdescRight">original pixel of size data loaded into texture <br/></td></tr>
173
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1e5cae65a67e7563d00e6388c962a4db"></a><!-- doxytag: member="CEGUI::OpenGLTexture::d_texelScaling" ref="a1e5cae65a67e7563d00e6388c962a4db" args="" -->
174
<a class="el" href="classCEGUI_1_1Vector2.html">Vector2</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OpenGLTexture.html#a1e5cae65a67e7563d00e6388c962a4db">d_texelScaling</a></td></tr>
175
<tr><td class="mdescLeft"> </td><td class="mdescRight">cached pixel to texel mapping scale values. <br/></td></tr>
176
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a91b2724b18eb56f30978fd964f6eb02a"></a><!-- doxytag: member="CEGUI::OpenGLTexture::d_owner" ref="a91b2724b18eb56f30978fd964f6eb02a" args="" -->
177
<a class="el" href="classCEGUI_1_1OpenGLRenderer.html">OpenGLRenderer</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OpenGLTexture.html#a91b2724b18eb56f30978fd964f6eb02a">d_owner</a></td></tr>
178
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classCEGUI_1_1OpenGLRenderer.html" title="Renderer class to interface with OpenGL.">OpenGLRenderer</a> that created and owns this <a class="el" href="classCEGUI_1_1OpenGLTexture.html" title="Texture implementation for the OpenGLRenderer.">OpenGLTexture</a>. <br/></td></tr>
179
<tr><td colspan="2"><h2><a name="friends"></a>
180
Friends</h2></td></tr>
181
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a856435f1b6e64e92798b0b3a128b87e7"></a><!-- doxytag: member="CEGUI::OpenGLTexture::OpenGLRenderer::createTexture" ref="a856435f1b6e64e92798b0b3a128b87e7" args="(void)" -->
182
<a class="el" href="classCEGUI_1_1Texture.html">Texture</a> & </td><td class="memItemRight" valign="bottom"><b>OpenGLRenderer::createTexture</b> (void)</td></tr>
183
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af9d2dc4c718ec812a31df37be64c0cc7"></a><!-- doxytag: member="CEGUI::OpenGLTexture::OpenGLRenderer::createTexture" ref="af9d2dc4c718ec812a31df37be64c0cc7" args="(const String &, const String &)" -->
184
<a class="el" href="classCEGUI_1_1Texture.html">Texture</a> & </td><td class="memItemRight" valign="bottom"><b>OpenGLRenderer::createTexture</b> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &, const <a class="el" href="classCEGUI_1_1String.html">String</a> &)</td></tr>
185
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3984f84dfb272d458382d4a0de859124"></a><!-- doxytag: member="CEGUI::OpenGLTexture::OpenGLRenderer::createTexture" ref="a3984f84dfb272d458382d4a0de859124" args="(const Size &)" -->
186
<a class="el" href="classCEGUI_1_1Texture.html">Texture</a> & </td><td class="memItemRight" valign="bottom"><b>OpenGLRenderer::createTexture</b> (const <a class="el" href="classCEGUI_1_1Size.html">Size</a> &)</td></tr>
187
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4515f5aaf8270c9558fb74e25c1284e7"></a><!-- doxytag: member="CEGUI::OpenGLTexture::OpenGLRenderer::createTexture" ref="a4515f5aaf8270c9558fb74e25c1284e7" args="(GLuint, const Size &)" -->
188
<a class="el" href="classCEGUI_1_1Texture.html">Texture</a> & </td><td class="memItemRight" valign="bottom"><b>OpenGLRenderer::createTexture</b> (GLuint, const <a class="el" href="classCEGUI_1_1Size.html">Size</a> &)</td></tr>
189
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae48c54c3bd0d3ac12bf8842e7ce37ae1"></a><!-- doxytag: member="CEGUI::OpenGLTexture::OpenGLRenderer::destroyTexture" ref="ae48c54c3bd0d3ac12bf8842e7ce37ae1" args="(Texture &)" -->
190
void </td><td class="memItemRight" valign="bottom"><b>OpenGLRenderer::destroyTexture</b> (<a class="el" href="classCEGUI_1_1Texture.html">Texture</a> &)</td></tr>
192
<hr/><a name="_details"></a><h2>Detailed Description</h2>
193
<p><a class="el" href="classCEGUI_1_1Texture.html" title="Abstract base class specifying the required interface for Texture objects.">Texture</a> implementation for the <a class="el" href="classCEGUI_1_1OpenGLRenderer.html" title="Renderer class to interface with OpenGL.">OpenGLRenderer</a>. </p>
194
<hr/><h2>Member Function Documentation</h2>
195
<a class="anchor" id="ac381786b999d877d16691f2191198244"></a><!-- doxytag: member="CEGUI::OpenGLTexture::getOpenGLTexture" ref="ac381786b999d877d16691f2191198244" args="() const " -->
196
<div class="memitem">
197
<div class="memproto">
198
<table class="memname">
200
<td class="memname">GLuint CEGUI::OpenGLTexture::getOpenGLTexture </td>
202
<td class="paramname"> )</td>
209
<p>Return the internal OpenGL texture id used by this <a class="el" href="classCEGUI_1_1Texture.html" title="Abstract base class specifying the required interface for Texture objects.">Texture</a> object. </p>
210
<dl class="return"><dt><b>Returns:</b></dt><dd>id of the OpenGL texture that this object is using. </dd></dl>
214
<a class="anchor" id="a3eb6251be58218921c1d9832e1b9f537"></a><!-- doxytag: member="CEGUI::OpenGLTexture::getOriginalDataSize" ref="a3eb6251be58218921c1d9832e1b9f537" args="() const " -->
215
<div class="memitem">
216
<div class="memproto">
217
<table class="memname">
219
<td class="memname">const <a class="el" href="classCEGUI_1_1Size.html">Size</a>& CEGUI::OpenGLTexture::getOriginalDataSize </td>
221
<td class="paramname"> )</td>
222
<td> const<code> [virtual]</code></td>
228
<p>Returns the original pixel size of the data loaded into the texture. </p>
229
<dl class="return"><dt><b>Returns:</b></dt><dd>reference to a <a class="el" href="classCEGUI_1_1Size.html" title="Class that holds the size (width & height) of something.">Size</a> object that describes the original size, in pixels, of the data loaded into the texture. </dd></dl>
231
<p>Implements <a class="el" href="classCEGUI_1_1Texture.html#aae220cf1d9dc112ef5f00a54628c36ce">CEGUI::Texture</a>.</p>
235
<a class="anchor" id="a15c130382430151075ebbdd5edc0d7e2"></a><!-- doxytag: member="CEGUI::OpenGLTexture::getSize" ref="a15c130382430151075ebbdd5edc0d7e2" args="() const " -->
236
<div class="memitem">
237
<div class="memproto">
238
<table class="memname">
240
<td class="memname">const <a class="el" href="classCEGUI_1_1Size.html">Size</a>& CEGUI::OpenGLTexture::getSize </td>
242
<td class="paramname"> )</td>
243
<td> const<code> [virtual]</code></td>
249
<p>Returns the current pixel size of the texture. </p>
250
<dl class="return"><dt><b>Returns:</b></dt><dd>Reference to a <a class="el" href="classCEGUI_1_1Size.html" title="Class that holds the size (width & height) of something.">Size</a> object that describes the size of the texture in pixels. </dd></dl>
252
<p>Implements <a class="el" href="classCEGUI_1_1Texture.html#a362b2b8c4a77f2380a1dd10f609c86ae">CEGUI::Texture</a>.</p>
256
<a class="anchor" id="afa2e23043b20cdc552868898316612f5"></a><!-- doxytag: member="CEGUI::OpenGLTexture::getTexelScaling" ref="afa2e23043b20cdc552868898316612f5" args="() const " -->
257
<div class="memitem">
258
<div class="memproto">
259
<table class="memname">
261
<td class="memname">const <a class="el" href="classCEGUI_1_1Vector2.html">Vector2</a>& CEGUI::OpenGLTexture::getTexelScaling </td>
263
<td class="paramname"> )</td>
264
<td> const<code> [virtual]</code></td>
270
<p>Returns pixel to texel scale values that should be used for converting pixel values to texture co-ords. </p>
271
<dl class="return"><dt><b>Returns:</b></dt><dd>Reference to a <a class="el" href="classCEGUI_1_1Vector2.html" title="Class used as a two dimensional vector (aka a Point)">Vector2</a> object that describes the scaling values required to accurately map pixel positions to texture co-ordinates. </dd></dl>
273
<p>Implements <a class="el" href="classCEGUI_1_1Texture.html#a3b71ae3940f4e76673af663aa475b199">CEGUI::Texture</a>.</p>
277
<a class="anchor" id="a1a91faad2eea97689c164634156ce44a"></a><!-- doxytag: member="CEGUI::OpenGLTexture::grabTexture" ref="a1a91faad2eea97689c164634156ce44a" args="()" -->
278
<div class="memitem">
279
<div class="memproto">
280
<table class="memname">
282
<td class="memname">void CEGUI::OpenGLTexture::grabTexture </td>
284
<td class="paramname"> )</td>
291
<p>Grab the texture to a local buffer. </p>
292
<p>This will destroy the OpenGL texture, and restoreTexture must be called before using it again. </p>
296
<a class="anchor" id="a59ef0dad6986679fa0a4ad27e2835b9a"></a><!-- doxytag: member="CEGUI::OpenGLTexture::loadFromFile" ref="a59ef0dad6986679fa0a4ad27e2835b9a" args="(const String &filename, const String &resourceGroup)" -->
297
<div class="memitem">
298
<div class="memproto">
299
<table class="memname">
301
<td class="memname">void CEGUI::OpenGLTexture::loadFromFile </td>
303
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
304
<td class="paramname"> <em>filename</em>, </td>
307
<td class="paramkey"></td>
309
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
310
<td class="paramname"> <em>resourceGroup</em> </td>
315
<td></td><td><code> [virtual]</code></td>
321
<p>Loads the specified image file into the texture. The texture is resized as required to hold the image. </p>
322
<dl><dt><b>Parameters:</b></dt><dd>
323
<table class="params">
324
<tr><td class="paramname">filename</td><td>The filename of the image file that is to be loaded into the texture</td></tr>
325
<tr><td class="paramname">resourceGroup</td><td>Resource group identifier to be passed to the resource provider when loading the image file.</td></tr>
329
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
331
<p>Implements <a class="el" href="classCEGUI_1_1Texture.html#a76b2d285c2af474739bf2b608d857d0b">CEGUI::Texture</a>.</p>
335
<a class="anchor" id="a70fc6856c52c051296deb26cc81ae1f8"></a><!-- doxytag: member="CEGUI::OpenGLTexture::loadFromMemory" ref="a70fc6856c52c051296deb26cc81ae1f8" args="(const void *buffer, const Size &buffer_size, PixelFormat pixel_format)" -->
336
<div class="memitem">
337
<div class="memproto">
338
<table class="memname">
340
<td class="memname">void CEGUI::OpenGLTexture::loadFromMemory </td>
342
<td class="paramtype">const void * </td>
343
<td class="paramname"> <em>buffer</em>, </td>
346
<td class="paramkey"></td>
348
<td class="paramtype">const <a class="el" href="classCEGUI_1_1Size.html">Size</a> & </td>
349
<td class="paramname"> <em>buffer_size</em>, </td>
352
<td class="paramkey"></td>
354
<td class="paramtype"><a class="el" href="classCEGUI_1_1Texture.html#a2156af785c41d517b3d8c6668ac08e45">PixelFormat</a> </td>
355
<td class="paramname"> <em>pixel_format</em> </td>
360
<td></td><td><code> [virtual]</code></td>
366
<p>Loads (copies) an image in memory into the texture. The texture is resized as required to hold the image. </p>
367
<dl><dt><b>Parameters:</b></dt><dd>
368
<table class="params">
369
<tr><td class="paramname">buffer</td><td>Pointer to the buffer containing the image data.</td></tr>
370
<tr><td class="paramname">buffer_size</td><td><a class="el" href="classCEGUI_1_1Size.html" title="Class that holds the size (width & height) of something.">Size</a> of the buffer (in pixels as specified by <em>pixelFormat</em>)</td></tr>
371
<tr><td class="paramname">pixel_format</td><td>PixelFormat value describing the format contained in <em>buffPtr</em>.</td></tr>
375
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
377
<p>Implements <a class="el" href="classCEGUI_1_1Texture.html#ab4ec02a12731a72069f59ef475c20da2">CEGUI::Texture</a>.</p>
381
<a class="anchor" id="a7578b8643ccbfa24f88d408dcf4aa279"></a><!-- doxytag: member="CEGUI::OpenGLTexture::saveToMemory" ref="a7578b8643ccbfa24f88d408dcf4aa279" args="(void *buffer)" -->
382
<div class="memitem">
383
<div class="memproto">
384
<table class="memname">
386
<td class="memname">void CEGUI::OpenGLTexture::saveToMemory </td>
388
<td class="paramtype">void * </td>
389
<td class="paramname"> <em>buffer</em> )</td>
390
<td><code> [virtual]</code></td>
396
<p>Save / dump the content of the texture to a memory buffer. The dumped pixel format is always RGBA (4 bytes per pixel). </p>
397
<dl><dt><b>Parameters:</b></dt><dd>
398
<table class="params">
399
<tr><td class="paramname">buffer</td><td>Pointer to the buffer that is to receive the image data. You must make sure that this buffer is large enough to hold the dumped texture data, the required pixel dimensions can be established by calling getSize. </td></tr>
404
<p>Implements <a class="el" href="classCEGUI_1_1Texture.html#a6a927c3292f409f03f31c18ab9a6e957">CEGUI::Texture</a>.</p>
408
<a class="anchor" id="ae7465945cf05cb3b29710181a4b00b21"></a><!-- doxytag: member="CEGUI::OpenGLTexture::setTextureSize" ref="ae7465945cf05cb3b29710181a4b00b21" args="(const Size &sz)" -->
409
<div class="memitem">
410
<div class="memproto">
411
<table class="memname">
413
<td class="memname">void CEGUI::OpenGLTexture::setTextureSize </td>
415
<td class="paramtype">const <a class="el" href="classCEGUI_1_1Size.html">Size</a> & </td>
416
<td class="paramname"> <em>sz</em> )</td>
423
<p>set the size of the internal texture. </p>
424
<dl><dt><b>Parameters:</b></dt><dd>
425
<table class="params">
426
<tr><td class="paramname">sz</td><td>size for the internal texture, in pixels.</td></tr>
430
<dl class="note"><dt><b>Note:</b></dt><dd>Depending upon the hardware capabilities, the actual final size of the texture may be larger than what is specified when calling this function. The texture will never be smaller than what you request here. To discover the actual size, call getSize.</dd></dl>
431
<dl><dt><b>Exceptions:</b></dt><dd>
432
<table class="exception">
433
<tr><td class="paramname"><a class="el" href="classCEGUI_1_1RendererException.html" title="Exception class used for problems in the rendering subsystem classes.">RendererException</a></td><td>thrown if the hardware is unable to support a texture large enough to fulfill the requested size.</td></tr>
437
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing. </dd></dl>
442
<hr class="footer"/><address class="footer"><small>Generated on Fri Nov 19 2010 12:01:23 for Crazy Eddies GUI System by 
443
<a href="http://www.doxygen.org/index.html">
444
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.2 </small></address>
added
removed
docs/classCEGUI_1_1OpenGLTexture.html
