← Back to branch summary

~ubuntu-branches/debian/wheezy/cegui-mk2/wheezy

« back to all changes in this revision

Viewing changes to doc/doxygen/xml_imageset.dox

  • Committer: Package Import Robot
  • Author(s): Muammar El Khatib
  • Date: 2011-10-13 12:43:12 UTC
  • mfrom: (10.1.5 experimental)
  • Revision ID: package-import@ubuntu.com-20111013124312-qch0o3fayloxgxu3
Tags: 0.7.5-7
http://bugs.debian.org/645109
Moved to unstable. (Closes: #645109)

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/doxygen/xml_imageset.dox
 
1
/**
 
2
@page xml_imageset Imageset XML files.
 
3
@author Paul D Turner
 
4
 
 
5
An Imageset is a collection of named regions upon some source surface, such as
 
6
an image file or texture.  In CEGUI terminology, each of these named regions is
 
7
an Image and is the basic level of imagery used by CEGUI.
 
8
 
 
9
<br>
 
10
@section xml_imageset_overview Overview
 
11
The reference for each element is arranged into sections, as described below:
 
12
- Purpose:
 
13
    - This section describes what the elements general purpose is within the
 
14
      specifications.
 
15
 
 
16
- Attributes:
 
17
    - This section describes available attributes for the elements, and whether
 
18
      they are required or optional.
 
19
 
 
20
- Usage:
 
21
    - Describes where the element may appear, whether the element may have
 
22
      sub-elements, and other important usage information.
 
23
 
 
24
- Examples:
 
25
    - For many elements, this section will contain brief examples showing the
 
26
      element used in context.
 
27
 
 
28
 
 
29
<br>
 
30
@section xml_imageset_imageset \<Imageset\> Element
 
31
- Purpose:
 
32
    - The \<Imageset\> element is the root element in XML imageset definition
 
33
    files.
 
34
 
 
35
- Attributes:
 
36
    - @c Name: Specifies the name that will be assigned to the Imageset in the
 
37
      CEGUI system.  Required Attribute.
 
38
    - @c Imagefile: Specifies the path to the image file containing the imagery 
 
39
      for the imageset.  Required attribute.
 
40
    - @c ResourceGroup: Specifies the resource group identifier to pass to the
 
41
      ResourceProvider when loading the file given in the @c Imagefile
 
42
      attribute.  Optional attribute, default is the Imageset default group.
 
43
    - @c AutoScaled: Boolean property that states whether to scale imagery so
 
44
      it appears the same @e physical size at any resolution.  The specified
 
45
      native resolution values indicate the resolution that will result in a
 
46
      one-to-one (i.e. unscaled) mapping from source to destination.  At
 
47
      resolutions higher than the native, the imagery will be scaled @e up to
 
48
      take up more space, and at resolutions lower than the native, the imagery
 
49
      will be scaled @e down to take up less space.
 
50
      Optional attribute, default is false.
 
51
    - @c NativeHorzRes: When AutoScaled is enabled, specifies the horizontal
 
52
      screen resolution that will result in an unscaled, one-to-one mapping of
 
53
      pixels from the source image to the destination surface.
 
54
      Optional attribute, default is 640.
 
55
    - @c NativeVertRes: When AutoScaled is enabled, specifies the vertical
 
56
      screen resolution that will result in an unscaled, one-to-one mapping of
 
57
      pixels from the source image to the destination surface.
 
58
      Optional attribute, default is 480.
 
59
 
 
60
- Usage:
 
61
    - The \<Imageset\> element is the root element for imageset files. 
 
62
    - The \<Imageset\> element may contain any number of \<Image\> elements. 
 
63
    - No element may contain \<Imageset\> elements as a sub-element.
 
64
 
 
65
- Examples:
 
66
 
 
67
<br>
 
68
@section xml_imageset_image \<Image> Element
 
69
- Purpose:
 
70
    - Defines a single component image of an imageset.
 
71
 
 
72
- Attributes:
 
73
    - @c Name: Specifies the name that will be used to identify the image within
 
74
      the Imageset.  Required attribute.
 
75
    - @c XPos: Specifies the X pixel co-ordinate of the top-left corner of the
 
76
      image on the source surface.  Required attribute.
 
77
    - @c YPos: Specifies the Y pixel co-ordinate of the top-left corner of the
 
78
      image on the source surface.  Required attribute.
 
79
    - @c Width: Specifies the width of the image in pixels.
 
80
      Required attribute.
 
81
    - @c Height: Specifies the height of the image in pixels.
 
82
      Required attibute.
 
83
    - @c XOffset: Specifies a horizontal offset to apply when rendering the
 
84
      image.  Optional attribute, default is 0.
 
85
    - @c YOffset: Specifies a vertical offset to apply when rendering the
 
86
      image.  Optional attribute, default is 0.
 
87
 
 
88
- Usage:
 
89
    - The \<Image\> element may only appear as a sub-element of the \<Imageset\>
 
90
    element.
 
91
    - The \<Image\> element may not contain any sub-elements.
 
92
 
 
93
- Examples:
 
94
 
 
95
*/