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
|
<!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: Imageset XML files.</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 class="current"><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="headertitle">
<div class="title">Imageset XML files. </div> </div>
</div>
<div class="contents">
<div class="textblock"><dl class="author"><dt><b>Author:</b></dt><dd>Paul D Turner</dd></dl>
<p>An Imageset is a collection of named regions upon some source surface, such as an image file or texture. In <a class="el" href="namespaceCEGUI.html" title="Main namespace for Crazy Eddie's GUI Library.">CEGUI</a> terminology, each of these named regions is an Image and is the basic level of imagery used by <a class="el" href="namespaceCEGUI.html" title="Main namespace for Crazy Eddie's GUI Library.">CEGUI</a>.</p>
<p><br/>
</p>
<h2><a class="anchor" id="xml_imageset_overview"></a>
Overview</h2>
<p>The reference for each element is arranged into sections, as described below:</p>
<ul>
<li>Purpose:<ul>
<li>This section describes what the elements general purpose is within the specifications.</li>
</ul>
</li>
</ul>
<ul>
<li>Attributes:<ul>
<li>This section describes available attributes for the elements, and whether they are required or optional.</li>
</ul>
</li>
</ul>
<ul>
<li>Usage:<ul>
<li>Describes where the element may appear, whether the element may have sub-elements, and other important usage information.</li>
</ul>
</li>
</ul>
<ul>
<li>Examples:<ul>
<li>For many elements, this section will contain brief examples showing the element used in context.</li>
</ul>
</li>
</ul>
<p><br/>
</p>
<h2><a class="anchor" id="xml_imageset_imageset"></a>
<Imageset> Element</h2>
<ul>
<li>Purpose:<ul>
<li>The <Imageset> element is the root element in XML imageset definition files.</li>
</ul>
</li>
</ul>
<ul>
<li>Attributes:<ul>
<li><code>Name:</code> Specifies the name that will be assigned to the Imageset in the <a class="el" href="namespaceCEGUI.html" title="Main namespace for Crazy Eddie's GUI Library.">CEGUI</a> system. Required Attribute.</li>
<li><code>Imagefile:</code> Specifies the path to the image file containing the imagery for the imageset. Required attribute.</li>
<li><code>ResourceGroup:</code> Specifies the resource group identifier to pass to the ResourceProvider when loading the file given in the <code>Imagefile</code> attribute. Optional attribute, default is the Imageset default group.</li>
<li><code>AutoScaled:</code> Boolean property that states whether to scale imagery so it appears the same <em>physical</em> size at any resolution. The specified native resolution values indicate the resolution that will result in a one-to-one (i.e. unscaled) mapping from source to destination. At resolutions higher than the native, the imagery will be scaled <em>up</em> to take up more space, and at resolutions lower than the native, the imagery will be scaled <em>down</em> to take up less space. Optional attribute, default is false.</li>
<li><code>NativeHorzRes:</code> When AutoScaled is enabled, specifies the horizontal screen resolution that will result in an unscaled, one-to-one mapping of pixels from the source image to the destination surface. Optional attribute, default is 640.</li>
<li><code>NativeVertRes:</code> When AutoScaled is enabled, specifies the vertical screen resolution that will result in an unscaled, one-to-one mapping of pixels from the source image to the destination surface. Optional attribute, default is 480.</li>
</ul>
</li>
</ul>
<ul>
<li>Usage:<ul>
<li>The <Imageset> element is the root element for imageset files.</li>
<li>The <Imageset> element may contain any number of <Image> elements.</li>
<li>No element may contain <Imageset> elements as a sub-element.</li>
</ul>
</li>
</ul>
<ul>
<li>Examples:</li>
</ul>
<p><br/>
</p>
<h2><a class="anchor" id="xml_imageset_image"></a>
<Image> Element</h2>
<ul>
<li>Purpose:<ul>
<li>Defines a single component image of an imageset.</li>
</ul>
</li>
</ul>
<ul>
<li>Attributes:<ul>
<li><code>Name:</code> Specifies the name that will be used to identify the image within the Imageset. Required attribute.</li>
<li><code>XPos:</code> Specifies the X pixel co-ordinate of the top-left corner of the image on the source surface. Required attribute.</li>
<li><code>YPos:</code> Specifies the Y pixel co-ordinate of the top-left corner of the image on the source surface. Required attribute.</li>
<li><code>Width:</code> Specifies the width of the image in pixels. Required attribute.</li>
<li><code>Height:</code> Specifies the height of the image in pixels. Required attibute.</li>
<li><code>XOffset:</code> Specifies a horizontal offset to apply when rendering the image. Optional attribute, default is 0.</li>
<li><code>YOffset:</code> Specifies a vertical offset to apply when rendering the image. Optional attribute, default is 0.</li>
</ul>
</li>
</ul>
<ul>
<li>Usage:<ul>
<li>The <Image> element may only appear as a sub-element of the <Imageset> element.</li>
<li>The <Image> element may not contain any sub-elements.</li>
</ul>
</li>
</ul>
<ul>
<li>Examples: </li>
</ul>
</div></div>
<hr class="footer"/><address class="footer"><small>Generated on Sun Jan 22 2012 16:07:40 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>
|
