Crazy Eddie's GUI System
0.8.4
|
Font files can define one of two types of font:
The reference for each element is arranged into sections, as described below:
version:
specifies the version of the resource file. Should be specified for all files, current CEGUI font version is: 3type:
Specifies the type of font being defined. This should be one of the following values:FreeType:
Indicates a font based upon a standard font file (such as a true-type '.ttf' font).Pixmap:
Indicates a font based upon an Imageset which defines Images for the font glyphs.name:
Specifies the name that will be used to identify the Font within the CEGUI system. Required attribute.filename:
Specifies the path to the associated resource for the font. Required attribute.resourceGroup:
Specifies the resource group identifier to pass to the ResourceProvider when loading the file given in the Filename
attribute. For Pixmap type fonts, this may be the special value "*"
to indicate the Imagseset specified in Filename
is actually the name of an already loaded Imagesest rather than the name of an Imageset XMl file to be loaded. Optional attribute.size:
Specifies the point size for a FreeType type font. This is ignored for Pixmap type fonts. Optional attribute, default is 12.antiAlias:
Boolean attribute that states whether the font should be rendered anti-aliased. This setting only affects FreeType type fonts. Optional attribute, default is true.autoScaled:
Property that specifies how to scale glyphs in relation to the specified native resolution. The native resolution values are intended to indicate the resolution that would result in a one-to-one (i.e. unscaled) mapping from source to destination. At display resolutions higher than the native, the glyphs will be scaled up to take up more space, and at display resolutions lower than the native, glyphs will be scaled down to take up less space. Possible values for this attribute are as follows:nativeHorzRes:
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.nativeVertRes:
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.lineSpacing:
Specifies a line spacing value to be used in preference to what is extracted from the underlying font file (useful if the font file is made with a bad line spacing value). If set to zero, the value from the underlying font file is used instead. This setting only affects FreeType type fonts. Optional attribute, default is 0.
codepoint:
Specifies the Unicode codepoint to produce a mapping for. Required attribute.image:
Specifies the name of the image to map to the codepoint specified in Codepoint
. This named image must be defined for the Imageset identified in the Filename
attribute of the containing <Font> element.horzAdvance:
Specifies a number of pixels to advance the 'pen' position after rendering the image specified in this mapping. A value of -1 will cause an appropriate value to be auto-calculated. Optional attribute, default is -1.