Class representing a font in the system. More...
#include <OgreFont.h>
Classes | |
class | CmdCharSpacer |
class | CmdCodePoints |
Command object for Font - see ParamCommand. More... | |
class | CmdResolution |
Command object for Font - see ParamCommand. More... | |
class | CmdSize |
Command object for Font - see ParamCommand. More... | |
class | CmdSource |
Command object for Font - see ParamCommand. More... | |
class | CmdType |
Command object for Font - see ParamCommand. More... | |
struct | GlyphInfo |
Information about the position and size of a glyph in a texture. More... | |
Public Types | |
typedef Ogre::uint32 | CodePoint |
typedef std::pair< CodePoint, CodePoint > | CodePointRange |
A range of code points, inclusive on both ends. More... | |
typedef vector< CodePointRange > ::type | CodePointRangeList |
enum | LoadingState { LOADSTATE_UNLOADED, LOADSTATE_LOADING, LOADSTATE_LOADED, LOADSTATE_UNLOADING, LOADSTATE_PREPARED, LOADSTATE_PREPARING } |
Enum identifying the loading state of the resource. More... | |
typedef Ogre::FloatRect | UVRect |
Public Member Functions | |
Font (ResourceManager *creator, const String &name, ResourceHandle handle, const String &group, bool isManual=false, ManualResourceLoader *loader=0) | |
Constructor. More... | |
virtual | ~Font () |
virtual void | _dirtyState () |
Manually mark the state of this resource as having been changed. More... | |
virtual void | _fireLoadingComplete (bool wasBackgroundLoaded) |
Firing of loading complete event. More... | |
virtual void | _firePreparingComplete (bool wasBackgroundLoaded) |
Firing of preparing complete event. More... | |
virtual void | _fireUnloadingComplete (void) |
Firing of unloading complete event. More... | |
virtual void | _notifyOrigin (const String &origin) |
Notify this resource of it's origin. More... | |
void | addCodePointRange (const CodePointRange &range) |
Adds a range of code points to the list of code point ranges to generate glyphs for, if this is a truetype based font. More... | |
virtual void | addListener (Listener *lis) |
Register a listener on this resource. More... | |
virtual void | changeGroupOwnership (const String &newGroup) |
Change the resource group ownership of a Resource. More... | |
void | clearCodePointRanges () |
Clear the list of code point ranges. More... | |
virtual void | copyParametersTo (StringInterface *dest) const |
Method for copying this object's parameters to another object. More... | |
virtual void | escalateLoading () |
Escalates the loading of a background loaded resource. More... | |
bool | getAntialiasColour (void) const |
Gets whether or not the colour of this font is antialiased as it is generated from a true type font. More... | |
uint | getCharacterSpacer (void) const |
Gets the spacing to allocate for font characters to overlap each other. More... | |
const CodePointRangeList & | getCodePointRangeList () const |
Get a const reference to the list of code point ranges to be used to generate glyphs from a truetype font. More... | |
virtual ResourceManager * | getCreator (void) |
Gets the manager which created this resource. More... | |
Real | getGlyphAspectRatio (CodePoint id) const |
Gets the aspect ratio (width / height) of this character. More... | |
const GlyphInfo & | getGlyphInfo (CodePoint id) const |
Gets the information available for a glyph corresponding to a given code point, or throws an exception if it doesn't exist;. More... | |
const UVRect & | getGlyphTexCoords (CodePoint id) const |
Returns the texture coordinates of the associated glyph. More... | |
virtual const String & | getGroup (void) const |
Gets the group which this resource is a member of. More... | |
virtual ResourceHandle | getHandle (void) const |
virtual LoadingState | getLoadingState () const |
Returns the current loading state. More... | |
const MaterialPtr & | getMaterial () const |
Gets the material generated for this font, as a weak reference. More... | |
const MaterialPtr & | getMaterial () |
Gets the material generated for this font, as a weak reference. More... | |
virtual const String & | getName (void) const |
Gets resource name. More... | |
virtual const String & | getOrigin (void) const |
Get the origin of this resource, e.g. More... | |
ParamDictionary * | getParamDictionary (void) |
Retrieves the parameter dictionary for this class. More... | |
const ParamDictionary * | getParamDictionary (void) const |
virtual String | getParameter (const String &name) const |
Generic parameter retrieval method. More... | |
const ParameterList & | getParameters (void) const |
Retrieves a list of parameters valid for this object. More... | |
virtual size_t | getSize (void) const |
Retrieves info about the size of the resource. More... | |
const String & | getSource (void) const |
Gets the source this font (either an image or a truetype font). More... | |
virtual size_t | getStateCount () const |
Returns the number of times this resource has changed state, which generally means the number of times it has been loaded. More... | |
int | getTrueTypeMaxBearingY () const |
Gets the maximum baseline distance of all glyphs used in the texture. More... | |
uint | getTrueTypeResolution (void) const |
Gets the resolution (dpi) of the font used to generate the texture. More... | |
Real | getTrueTypeSize (void) const |
Gets the point size of the font used to generate the texture. More... | |
FontType | getType (void) const |
Gets the type of font. More... | |
virtual bool | isBackgroundLoaded (void) const |
Returns whether this Resource has been earmarked for background loading. More... | |
virtual bool | isLoaded (void) const |
Returns true if the Resource has been loaded, false otherwise. More... | |
virtual bool | isLoading () const |
Returns whether the resource is currently in the process of background loading. More... | |
virtual bool | isManuallyLoaded (void) const |
Is this resource manually loaded? More... | |
virtual bool | isPrepared (void) const |
Returns true if the Resource has been prepared, false otherwise. More... | |
virtual bool | isReloadable (void) const |
Returns true if the Resource is reloadable, false otherwise. More... | |
virtual void | load (bool backgroundThread=false) |
Loads the resource, if it is not already. More... | |
void | loadResource (Resource *resource) |
Implementation of ManualResourceLoader::loadResource, called when the Texture that this font creates needs to (re)load. More... | |
void | operator delete (void *ptr) |
void | operator delete (void *ptr, void *) |
void | operator delete (void *ptr, const char *, int, const char *) |
void | operator delete[] (void *ptr) |
void | operator delete[] (void *ptr, const char *, int, const char *) |
void * | operator new (size_t sz, const char *file, int line, const char *func) |
operator new, with debug line info More... | |
void * | operator new (size_t sz) |
void * | operator new (size_t sz, void *ptr) |
placement operator new More... | |
void * | operator new[] (size_t sz, const char *file, int line, const char *func) |
array operator new, with debug line info More... | |
void * | operator new[] (size_t sz) |
virtual void | prepare (bool backgroundThread=false) |
Prepares the resource for load, if it is not already. More... | |
virtual void | prepareResource (Resource *resource) |
Called when a resource wishes to load. More... | |
virtual void | reload (void) |
Reloads the resource, if it is already loaded. More... | |
virtual void | removeListener (Listener *lis) |
Remove a listener on this resource. More... | |
void | setAntialiasColour (bool enabled) |
Sets whether or not the colour of this font is antialiased as it is generated from a true type font. More... | |
virtual void | setBackgroundLoaded (bool bl) |
Tells the resource whether it is background loaded or not. More... | |
void | setCharacterSpacer (uint charSpacer) |
Sets the spacing to allocate for font characters to overlap each other. More... | |
void | setGlyphAspectRatio (CodePoint id, Real ratio) |
Sets the aspect ratio (width / height) of this character. More... | |
void | setGlyphTexCoords (CodePoint id, Real u1, Real v1, Real u2, Real v2, Real textureAspect) |
Sets the texture coordinates of a glyph. More... | |
virtual bool | setParameter (const String &name, const String &value) |
Generic parameter setting method. More... | |
virtual void | setParameterList (const NameValuePairList ¶mList) |
Generic multiple parameter setting method. More... | |
void | setSource (const String &source) |
Sets the source of the font. More... | |
void | setTrueTypeResolution (uint ttfResolution) |
Gets the resolution (dpi) of the font used to generate the texture (only required for FT_TRUETYPE). More... | |
void | setTrueTypeSize (Real ttfSize) |
Sets the size of a truetype font (only required for FT_TRUETYPE). More... | |
void | setType (FontType ftype) |
Sets the type of font. More... | |
virtual void | touch (void) |
'Touches' the resource to indicate it has been used. More... | |
virtual void | unload (void) |
Unloads the resource; this is not permanent, the resource can be reloaded later if required. More... | |
Static Public Member Functions | |
static void | cleanupDictionary () |
Cleans up the static 'msDictionary' required to reset Ogre, otherwise the containers are left with invalid pointers, which will lead to a crash as soon as one of the ResourceManager implementers (e.g. More... | |
Public Attributes | |
OGRE_AUTO_MUTEX | |
Protected Types | |
typedef map< CodePoint, GlyphInfo >::type | CodePointMap |
Map from unicode code point to texture coordinates. More... | |
typedef set< Listener * >::type | ListenerList |
Protected Member Functions | |
size_t | calculateSize (void) const |
Calculate the size of a resource; this will only be called after 'load'. More... | |
bool | createParamDictionary (const String &className) |
Internal method for creating a parameter dictionary for the class, if it does not already exist. More... | |
void | createTextureFromFont (void) |
Internal method for loading from ttf. More... | |
virtual void | loadImpl () |
Internal implementation of the meat of the 'load' action, only called if this resource is not being loaded from a ManualResourceLoader. More... | |
OGRE_MUTEX (mListenerListMutex) | |
virtual void | postLoadImpl (void) |
Internal hook to perform actions after the load process, but before the resource has been marked as fully loaded. More... | |
virtual void | postUnloadImpl (void) |
Internal hook to perform actions after the unload process, but before the resource has been marked as fully unloaded. More... | |
virtual void | preLoadImpl (void) |
Internal hook to perform actions before the load process, but after the resource has been marked as 'loading'. More... | |
virtual void | prepareImpl (void) |
Internal implementation of the meat of the 'prepare' action. More... | |
virtual void | preUnloadImpl (void) |
Internal hook to perform actions before the unload process. More... | |
virtual void | unloadImpl () |
Internal implementation of the 'unload' action; called regardless of whether this resource is being loaded from a ManualResourceLoader. More... | |
virtual void | unprepareImpl (void) |
Internal function for undoing the 'prepare' action. More... | |
Protected Attributes | |
bool | mAntialiasColour |
for TRUE_TYPE font only More... | |
uint | mCharacterSpacer |
Add a gap between letters vertically and horizonally prevents nasty artifacts caused by fonts atypically wide or tall characters. More... | |
CodePointMap | mCodePointMap |
CodePointRangeList | mCodePointRangeList |
Range of code points to generate glyphs for (truetype only) More... | |
ResourceManager * | mCreator |
Creator. More... | |
String | mGroup |
The name of the resource group. More... | |
ResourceHandle | mHandle |
Numeric handle for more efficient look up than name. More... | |
volatile bool | mIsBackgroundLoaded |
Is this resource going to be background loaded? Only applicable for multithreaded. More... | |
bool | mIsManual |
Is this file manually loaded? More... | |
ListenerList | mListenerList |
ManualResourceLoader * | mLoader |
Optional manual loader; if provided, data is loaded from here instead of a file. More... | |
AtomicScalar< LoadingState > | mLoadingState |
Is the resource currently loaded? More... | |
MaterialPtr | mMaterial |
The material which is generated for this font. More... | |
String | mName |
Unique name of the resource. More... | |
String | mOrigin |
Origin of this resource (e.g. script name) - optional. More... | |
size_t | mSize |
The size of the resource in bytes. More... | |
String | mSource |
Source of the font (either an image name or a truetype font) More... | |
size_t | mStateCount |
State count, the number of times this resource has changed state. More... | |
TexturePtr | mTexture |
Texture pointer. More... | |
int | mTtfMaxBearingY |
Max distance to baseline of this (truetype) font. More... | |
uint | mTtfResolution |
Resolution (dpi) of truetype font. More... | |
Real | mTtfSize |
Size of the truetype font, in points. More... | |
FontType | mType |
The type of font. More... | |
Static Protected Attributes | |
static CmdCharSpacer | msCharacterSpacerCmd |
static CmdCodePoints | msCodePointsCmd |
static CmdResolution | msResolutionCmd |
static CmdSize | msSizeCmd |
static CmdSource | msSourceCmd |
static CmdType | msTypeCmd |
Class representing a font in the system.
Definition at line 67 of file OgreFont.h.
typedef Ogre::uint32 Ogre::Font::CodePoint |
Definition at line 139 of file OgreFont.h.
|
protected |
Map from unicode code point to texture coordinates.
Definition at line 159 of file OgreFont.h.
typedef std::pair<CodePoint, CodePoint> Ogre::Font::CodePointRange |
A range of code points, inclusive on both ends.
Definition at line 155 of file OgreFont.h.
typedef vector<CodePointRange>::type Ogre::Font::CodePointRangeList |
Definition at line 156 of file OgreFont.h.
|
protectedinherited |
Definition at line 166 of file OgreResource.h.
typedef Ogre::FloatRect Ogre::Font::UVRect |
Definition at line 140 of file OgreFont.h.
|
inherited |
Enum identifying the loading state of the resource.
Definition at line 127 of file OgreResource.h.
Ogre::Font::Font | ( | ResourceManager * | creator, |
const String & | name, | ||
ResourceHandle | handle, | ||
const String & | group, | ||
bool | isManual = false , |
||
ManualResourceLoader * | loader = 0 |
||
) |
Constructor.
|
virtual |
|
virtualinherited |
Manually mark the state of this resource as having been changed.
|
virtualinherited |
Firing of loading complete event.
wasBackgroundLoaded | Whether this was a background loaded event |
|
virtualinherited |
Firing of preparing complete event.
wasBackgroundLoaded | Whether this was a background loaded event |
|
virtualinherited |
Firing of unloading complete event.
|
inlinevirtualinherited |
Notify this resource of it's origin.
Definition at line 420 of file OgreResource.h.
|
inline |
Adds a range of code points to the list of code point ranges to generate glyphs for, if this is a truetype based font.
Definition at line 356 of file OgreFont.h.
|
virtualinherited |
Register a listener on this resource.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
|
inlineprotectedvirtual |
Calculate the size of a resource; this will only be called after 'load'.
Reimplemented from Ogre::Resource.
Definition at line 182 of file OgreFont.h.
|
virtualinherited |
Change the resource group ownership of a Resource.
newGroup | Name of the new group |
|
staticinherited |
Cleans up the static 'msDictionary' required to reset Ogre, otherwise the containers are left with invalid pointers, which will lead to a crash as soon as one of the ResourceManager implementers (e.g.
MaterialManager) initializes.
|
inline |
Clear the list of code point ranges.
Definition at line 363 of file OgreFont.h.
|
inlinevirtualinherited |
Method for copying this object's parameters to another object.
dest | Pointer to object to have it's parameters set the same as this object. |
Definition at line 303 of file OgreStringInterface.h.
References Ogre::ParamDictionary::mParamDefs, and Ogre::StringInterface::setParameter().
|
inlineprotectedinherited |
Internal method for creating a parameter dictionary for the class, if it does not already exist.
className | the name of the class using the dictionary |
Definition at line 186 of file OgreStringInterface.h.
References OGRE_LOCK_MUTEX.
|
protected |
Internal method for loading from ttf.
|
virtualinherited |
Escalates the loading of a background loaded resource.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
|
inline |
Gets whether or not the colour of this font is antialiased as it is generated from a true type font.
Definition at line 409 of file OgreFont.h.
uint Ogre::Font::getCharacterSpacer | ( | void | ) | const |
Gets the spacing to allocate for font characters to overlap each other.
|
inline |
Get a const reference to the list of code point ranges to be used to generate glyphs from a truetype font.
Definition at line 370 of file OgreFont.h.
|
inlinevirtualinherited |
Gets the manager which created this resource.
Definition at line 411 of file OgreResource.h.
Gets the aspect ratio (width / height) of this character.
Definition at line 317 of file OgreFont.h.
Gets the information available for a glyph corresponding to a given code point, or throws an exception if it doesn't exist;.
Returns the texture coordinates of the associated glyph.
id | The code point (unicode) |
Definition at line 275 of file OgreFont.h.
|
inlinevirtualinherited |
Gets the group which this resource is a member of.
Definition at line 399 of file OgreResource.h.
|
inlinevirtualinherited |
Reimplemented in Ogre::SkeletonInstance.
Definition at line 317 of file OgreResource.h.
|
inlinevirtualinherited |
Returns the current loading state.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 348 of file OgreResource.h.
|
inline |
Gets the material generated for this font, as a weak reference.
Definition at line 378 of file OgreFont.h.
|
inline |
Gets the material generated for this font, as a weak reference.
Definition at line 386 of file OgreFont.h.
|
inlinevirtualinherited |
Gets resource name.
Reimplemented in Ogre::SkeletonInstance.
Definition at line 312 of file OgreResource.h.
|
inlinevirtualinherited |
Get the origin of this resource, e.g.
a script file name.
Definition at line 418 of file OgreResource.h.
|
inlineinherited |
Retrieves the parameter dictionary for this class.
Definition at line 219 of file OgreStringInterface.h.
|
inlineinherited |
Definition at line 224 of file OgreStringInterface.h.
|
inlinevirtualinherited |
Generic parameter retrieval method.
name | The name of the parameter to get |
Definition at line 272 of file OgreStringInterface.h.
References Ogre::ParamCommand::doGet(), and Ogre::ParamDictionary::getParamCommand().
|
inherited |
Retrieves a list of parameters valid for this object.
|
inlinevirtualinherited |
Retrieves info about the size of the resource.
Reimplemented in Ogre::CgProgram, and Ogre::UnifiedHighLevelGpuProgram.
Definition at line 301 of file OgreResource.h.
const String& Ogre::Font::getSource | ( | void | ) | const |
Gets the source this font (either an image or a truetype font).
|
inlinevirtualinherited |
Returns the number of times this resource has changed state, which generally means the number of times it has been loaded.
Objects that build derived data based on the resource can check this value against a copy they kept last time they built this derived data, in order to know whether it needs rebuilding. This is a nice way of monitoring changes without having a tightly-bound callback.
Definition at line 429 of file OgreResource.h.
int Ogre::Font::getTrueTypeMaxBearingY | ( | ) | const |
Gets the maximum baseline distance of all glyphs used in the texture.
uint Ogre::Font::getTrueTypeResolution | ( | void | ) | const |
Gets the resolution (dpi) of the font used to generate the texture.
Real Ogre::Font::getTrueTypeSize | ( | void | ) | const |
Gets the point size of the font used to generate the texture.
FontType Ogre::Font::getType | ( | void | ) | const |
Gets the type of font.
|
inlinevirtualinherited |
Returns whether this Resource has been earmarked for background loading.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 365 of file OgreResource.h.
|
inlinevirtualinherited |
Returns true if the Resource has been loaded, false otherwise.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 332 of file OgreResource.h.
|
inlinevirtualinherited |
Returns whether the resource is currently in the process of background loading.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 341 of file OgreResource.h.
|
inlinevirtualinherited |
Is this resource manually loaded?
Definition at line 289 of file OgreResource.h.
|
inlinevirtualinherited |
Returns true if the Resource has been prepared, false otherwise.
Definition at line 324 of file OgreResource.h.
|
inlinevirtualinherited |
Returns true if the Resource is reloadable, false otherwise.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 282 of file OgreResource.h.
|
virtualinherited |
Loads the resource, if it is not already.
backgroundThread | Indicates whether the caller of this method is the background resource loading thread. |
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
|
protectedvirtual |
Internal implementation of the meat of the 'load' action, only called if this resource is not being loaded from a ManualResourceLoader.
Implements Ogre::Resource.
|
virtual |
Implementation of ManualResourceLoader::loadResource, called when the Texture that this font creates needs to (re)load.
Implements Ogre::ManualResourceLoader.
|
protectedinherited |
|
inlineinherited |
Definition at line 96 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 102 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 108 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 113 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 119 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
operator new, with debug line info
Definition at line 68 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 73 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
placement operator new
Definition at line 79 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
array operator new, with debug line info
Definition at line 86 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 91 of file OgreMemoryAllocatedObject.h.
|
inlineprotectedvirtualinherited |
Internal hook to perform actions after the load process, but before the resource has been marked as fully loaded.
Reimplemented in Ogre::Mesh, Ogre::D3D9Texture, and Ogre::D3D11Texture.
Definition at line 191 of file OgreResource.h.
|
inlineprotectedvirtualinherited |
Internal hook to perform actions after the unload process, but before the resource has been marked as fully unloaded.
Definition at line 201 of file OgreResource.h.
|
inlineprotectedvirtualinherited |
Internal hook to perform actions before the load process, but after the resource has been marked as 'loading'.
Definition at line 184 of file OgreResource.h.
|
virtualinherited |
Prepares the resource for load, if it is not already.
One can call prepare() before load(), but this is not required as load() will call prepare() itself, if needed. When OGRE_THREAD_SUPPORT==1 both load() and prepare() are thread-safe. When OGRE_THREAD_SUPPORT==2 however, only prepare() is thread-safe. The reason for this function is to allow a background thread to do some of the loading work, without requiring the whole render system to be thread-safe. The background thread would call prepare() while the main render loop would later call load(). So long as prepare() remains thread-safe, subclasses can arbitrarily split the work of loading a resource between load() and prepare(). It is best to try and do as much work in prepare(), however, since this will leave less work for the main render thread to do and thus increase FPS.
backgroundThread | Whether this is occurring in a background thread |
|
inlineprotectedvirtualinherited |
Internal implementation of the meat of the 'prepare' action.
Reimplemented in Ogre::Mesh, Ogre::D3D9Texture, Ogre::D3D11Texture, Ogre::Material, Ogre::PatchMesh, Ogre::GLTexture, and Ogre::GL3PlusTexture.
Definition at line 205 of file OgreResource.h.
|
inlinevirtualinherited |
Called when a resource wishes to load.
Note that this could get called in a background thread even in just a semithreaded ogre (OGRE_THREAD_SUPPORT==2). Thus, you must not access the rendersystem from this callback. Do that stuff in loadResource.
resource | The resource which wishes to load |
Definition at line 526 of file OgreResource.h.
|
inlineprotectedvirtualinherited |
Internal hook to perform actions before the unload process.
Definition at line 196 of file OgreResource.h.
|
virtualinherited |
Reloads the resource, if it is already loaded.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
|
virtualinherited |
Remove a listener on this resource.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
|
inline |
Sets whether or not the colour of this font is antialiased as it is generated from a true type font.
Definition at line 401 of file OgreFont.h.
|
inlinevirtualinherited |
Tells the resource whether it is background loaded or not.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
Definition at line 375 of file OgreResource.h.
void Ogre::Font::setCharacterSpacer | ( | uint | charSpacer | ) |
Sets the spacing to allocate for font characters to overlap each other.
charSpacer | The size of the character spacer, in points. Increasing it allows for more stretched-out fonts; decreasing it reduces memory and processing time. The default is "5". |
Sets the aspect ratio (width / height) of this character.
Definition at line 334 of file OgreFont.h.
|
inline |
Sets the texture coordinates of a glyph.
Definition at line 296 of file OgreFont.h.
|
virtualinherited |
Generic parameter setting method.
name | The name of the parameter to set |
value | String value. Must be in the right format for the type specified in the parameter definition. See the StringConverter class for more information. |
Referenced by Ogre::StringInterface::copyParametersTo().
|
virtualinherited |
Generic multiple parameter setting method.
paramList | Name/value pair list |
void Ogre::Font::setSource | ( | const String & | source | ) |
Sets the source of the font.
source | An image file or a truetype font, depending on the type of this font |
void Ogre::Font::setTrueTypeResolution | ( | uint | ttfResolution | ) |
Gets the resolution (dpi) of the font used to generate the texture (only required for FT_TRUETYPE).
ttfResolution | The resolution in dpi |
void Ogre::Font::setTrueTypeSize | ( | Real | ttfSize | ) |
Sets the size of a truetype font (only required for FT_TRUETYPE).
ttfSize | The size of the font in points. Note that the size of the font does not affect how big it is on the screen, just how large it is in the texture and thus how detailed it is. |
void Ogre::Font::setType | ( | FontType | ftype | ) |
Sets the type of font.
Must be set before loading.
|
virtualinherited |
'Touches' the resource to indicate it has been used.
Reimplemented in Ogre::Material, Ogre::CgProgram, and Ogre::UnifiedHighLevelGpuProgram.
Referenced by Ogre::Material::touch().
|
virtualinherited |
Unloads the resource; this is not permanent, the resource can be reloaded later if required.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
|
protectedvirtual |
Internal implementation of the 'unload' action; called regardless of whether this resource is being loaded from a ManualResourceLoader.
Implements Ogre::Resource.
|
inlineprotectedvirtualinherited |
Internal function for undoing the 'prepare' action.
Called when the load is completed, and when resources are unloaded when they are prepared but not yet loaded.
Reimplemented in Ogre::Mesh, Ogre::D3D9Texture, Ogre::D3D11Texture, Ogre::Material, Ogre::GLTexture, and Ogre::GL3PlusTexture.
Definition at line 210 of file OgreResource.h.
|
protected |
for TRUE_TYPE font only
Definition at line 169 of file OgreFont.h.
|
protected |
Add a gap between letters vertically and horizonally prevents nasty artifacts caused by fonts atypically wide or tall characters.
Definition at line 128 of file OgreFont.h.
|
protected |
Definition at line 160 of file OgreFont.h.
|
protected |
Range of code points to generate glyphs for (truetype only)
Definition at line 172 of file OgreFont.h.
|
protectedinherited |
Creator.
Definition at line 144 of file OgreResource.h.
|
protectedinherited |
The name of the resource group.
Definition at line 148 of file OgreResource.h.
|
protectedinherited |
Numeric handle for more efficient look up than name.
Definition at line 150 of file OgreResource.h.
|
protectedinherited |
Is this resource going to be background loaded? Only applicable for multithreaded.
Definition at line 154 of file OgreResource.h.
|
protectedinherited |
Is this file manually loaded?
Definition at line 158 of file OgreResource.h.
|
protectedinherited |
Definition at line 167 of file OgreResource.h.
|
protectedinherited |
Optional manual loader; if provided, data is loaded from here instead of a file.
Definition at line 162 of file OgreResource.h.
|
protectedinherited |
Is the resource currently loaded?
Definition at line 152 of file OgreResource.h.
|
protected |
The material which is generated for this font.
Definition at line 163 of file OgreFont.h.
|
protectedinherited |
Unique name of the resource.
Definition at line 146 of file OgreResource.h.
|
protectedinherited |
Origin of this resource (e.g. script name) - optional.
Definition at line 160 of file OgreResource.h.
|
staticprotected |
Definition at line 115 of file OgreFont.h.
|
staticprotected |
Definition at line 118 of file OgreFont.h.
|
protectedinherited |
The size of the resource in bytes.
Definition at line 156 of file OgreResource.h.
|
protected |
Source of the font (either an image name or a truetype font)
Definition at line 124 of file OgreFont.h.
|
staticprotected |
Definition at line 117 of file OgreFont.h.
|
staticprotected |
Definition at line 116 of file OgreFont.h.
|
staticprotected |
Definition at line 114 of file OgreFont.h.
|
protectedinherited |
State count, the number of times this resource has changed state.
Definition at line 164 of file OgreResource.h.
|
staticprotected |
Definition at line 113 of file OgreFont.h.
|
protected |
Texture pointer.
Definition at line 166 of file OgreFont.h.
|
protected |
Max distance to baseline of this (truetype) font.
Definition at line 135 of file OgreFont.h.
|
protected |
Resolution (dpi) of truetype font.
Definition at line 133 of file OgreFont.h.
|
protected |
Size of the truetype font, in points.
Definition at line 131 of file OgreFont.h.
|
protected |
The type of font.
Definition at line 121 of file OgreFont.h.
|
inherited |
Definition at line 82 of file OgreResource.h.