Debian Codegraph @

Documentation/Overview/surface_resources.xml

raw
1 <xml>
2 <head>
3 <title>Surface Resources</title>
4 </head>
5 <body>
6
7 <h3>Resource options</h3>
8
9 <p>Each surface <i>can</i> have the following properties:</p>
10
11 <pre>
12 &lt;surface
13 name="my_surface"
14 file="filename"
15 format="image_format" &gt;
16 </pre>
17
18 <p>To setup a surface resource, it is required to specify the <i>name</i>
19 and <i>file</i> attributes of &lt;surface&gt;. If ClanLib has trouble
20 determining what format the specified filename is in, the extension known by
21 clanlib (eg. "jpg") can be told using the <i>format</i> attribute.</p>
22
23 <h3>Surface resource options reference</h3>
24
25 <p><b>&lt;surface&gt;</b></p>
26
27 <ul>
28 <li>Attribute <b>name</b>: Name of resource.
29 <p>
30 <i>Valid values</i>:<br>
31 <i>Default value</i>: None, MUST BE PRESENT.
32 </p>
33 </li>
34 <li>Attribute <b>file</b>: Filename of image to be used.
35 <p>
36 <i>Valid values</i>:<br>
37 <i>Default value</i>: None, MUST BE PRESENT.
38 </p>
39 </li>
40 <li>Attribute <b>format</b>: Extension of known format to be used for loading.
41 <p>
42 <i>Valid values</i>: "png", "jpg", "tga, "pcx"<br>
43 <i>Default value</i>: Uses the extension used in the <i>file</i> attribute.
44 </p>
45 </li>
46 </ul>
47
48 </body>
49 </xml>