\hypertarget{class_ogre_1_1_font}{}\section{Ogre\+:\+:Font Class Reference}
\label{class_ogre_1_1_font}\index{Ogre\+::\+Font@{Ogre\+::\+Font}}


Class representing a font in the system.  




{\ttfamily \#include $<$Ogre\+Font.\+h$>$}



Inheritance diagram for Ogre\+:\+:Font\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{class_ogre_1_1_font__inherit__graph}
\end{center}
\end{figure}
\subsection*{Classes}
\begin{DoxyCompactItemize}
\item 
struct \hyperlink{struct_ogre_1_1_font_1_1_glyph_info}{Glyph\+Info}
\begin{DoxyCompactList}\small\item\em Information about the position and size of a glyph in a texture. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Public Types}
\begin{DoxyCompactItemize}
\item 
typedef \hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{Ogre\+::uint32} \hyperlink{class_ogre_1_1_font_ad48cf05dd479e7c8f1d7a97221d933b1}{Code\+Point}
\item 
typedef std\+::pair$<$ \hyperlink{class_ogre_1_1_font_ad48cf05dd479e7c8f1d7a97221d933b1}{Code\+Point}, \hyperlink{class_ogre_1_1_font_ad48cf05dd479e7c8f1d7a97221d933b1}{Code\+Point} $>$ \hyperlink{class_ogre_1_1_font_aa455a399457bd458852555c696b28f6a}{Code\+Point\+Range}
\begin{DoxyCompactList}\small\item\em A range of code points, inclusive on both ends. \end{DoxyCompactList}\item 
typedef std\+::vector$<$ \hyperlink{class_ogre_1_1_font_aa455a399457bd458852555c696b28f6a}{Code\+Point\+Range} $>$ \hyperlink{class_ogre_1_1_font_a3b754bb7b6d6b9be27d76d7c3a70fc7e}{Code\+Point\+Range\+List}
\item 
enum \hyperlink{class_ogre_1_1_resource_a1aa750a4b994f2b1066220936cdfdb94}{Loading\+Flags} \{ \newline
\hyperlink{class_ogre_1_1_resource_a1aa750a4b994f2b1066220936cdfdb94ab49695ac949df3a7d2e2f9a03267097c}{L\+F\+\_\+\+D\+E\+F\+A\+U\+LT} = 0, 
\hyperlink{class_ogre_1_1_resource_a1aa750a4b994f2b1066220936cdfdb94a6ee542226e1cf18df28ab88426be6809}{L\+F\+\_\+\+I\+N\+C\+L\+U\+D\+E\+\_\+\+N\+O\+N\+\_\+\+R\+E\+L\+O\+A\+D\+A\+B\+LE} = 1, 
\hyperlink{class_ogre_1_1_resource_a1aa750a4b994f2b1066220936cdfdb94a70589e0b87b09b0a4fd98ce490dc9782}{L\+F\+\_\+\+O\+N\+L\+Y\+\_\+\+U\+N\+R\+E\+F\+E\+R\+E\+N\+C\+ED} = 2, 
\hyperlink{class_ogre_1_1_resource_a1aa750a4b994f2b1066220936cdfdb94ae5f2eca654bd810da4c774570a5b4b77}{L\+F\+\_\+\+O\+N\+L\+Y\+\_\+\+U\+N\+R\+E\+F\+E\+R\+E\+N\+C\+E\+D\+\_\+\+I\+N\+C\+L\+U\+D\+E\+\_\+\+N\+O\+N\+\_\+\+R\+E\+L\+O\+A\+D\+A\+B\+LE} = 3, 
\newline
\hyperlink{class_ogre_1_1_resource_a1aa750a4b994f2b1066220936cdfdb94ad83abf165de5cfa1a4c8e0cd5471ad2c}{L\+F\+\_\+\+P\+R\+E\+S\+E\+R\+V\+E\+\_\+\+S\+T\+A\+TE} = 4
 \}\begin{DoxyCompactList}\small\item\em Enum that allow to choose subset of unloaded/reloaded resources and to adjust reloading behavior. \end{DoxyCompactList}
\item 
enum \hyperlink{class_ogre_1_1_resource_a07e619aa09d3bc6789a6667cb4fc572c}{Loading\+State} \{ \newline
\hyperlink{class_ogre_1_1_resource_a07e619aa09d3bc6789a6667cb4fc572ca28d463296cacdfc115dbc3fb02d00e94}{L\+O\+A\+D\+S\+T\+A\+T\+E\+\_\+\+U\+N\+L\+O\+A\+D\+ED}, 
\hyperlink{class_ogre_1_1_resource_a07e619aa09d3bc6789a6667cb4fc572caf138fc9087e0dc755bff08a83720cbb5}{L\+O\+A\+D\+S\+T\+A\+T\+E\+\_\+\+L\+O\+A\+D\+I\+NG}, 
\hyperlink{class_ogre_1_1_resource_a07e619aa09d3bc6789a6667cb4fc572caa38cbef7605fc4bff6da2f34599ace8f}{L\+O\+A\+D\+S\+T\+A\+T\+E\+\_\+\+L\+O\+A\+D\+ED}, 
\hyperlink{class_ogre_1_1_resource_a07e619aa09d3bc6789a6667cb4fc572ca4228d390b3a9ed614001db177d1f441e}{L\+O\+A\+D\+S\+T\+A\+T\+E\+\_\+\+U\+N\+L\+O\+A\+D\+I\+NG}, 
\newline
\hyperlink{class_ogre_1_1_resource_a07e619aa09d3bc6789a6667cb4fc572ca133a073b86c346096237063f99870fc1}{L\+O\+A\+D\+S\+T\+A\+T\+E\+\_\+\+P\+R\+E\+P\+A\+R\+ED}, 
\hyperlink{class_ogre_1_1_resource_a07e619aa09d3bc6789a6667cb4fc572cab43c913411f4a96722902f17b88f10fb}{L\+O\+A\+D\+S\+T\+A\+T\+E\+\_\+\+P\+R\+E\+P\+A\+R\+I\+NG}
 \}\begin{DoxyCompactList}\small\item\em Enum identifying the loading state of the resource. \end{DoxyCompactList}
\item 
typedef \hyperlink{group___general_ga39213af9254535e83b4beca0859e8a2f}{Ogre\+::\+Float\+Rect} \hyperlink{class_ogre_1_1_font_a17ebc3668a45365c1243a83f36a512ef}{U\+V\+Rect}
\end{DoxyCompactItemize}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hyperlink{class_ogre_1_1_font_a9915203be62b8bd2feda436cc9f08cb0}{Font} (\hyperlink{class_ogre_1_1_resource_manager}{Resource\+Manager} $\ast$creator, const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&name, \hyperlink{namespace_ogre_aeb9f62c8e6c4239315286c63321722b2}{Resource\+Handle} handle, const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&group, bool is\+Manual=false, \hyperlink{class_ogre_1_1_manual_resource_loader}{Manual\+Resource\+Loader} $\ast$loader=0)
\begin{DoxyCompactList}\small\item\em Constructor. \end{DoxyCompactList}\item 
virtual \hyperlink{class_ogre_1_1_font_a02642b36387d7ffd80e164ce1fac4591}{$\sim$\+Font} ()
\item 
virtual void \hyperlink{class_ogre_1_1_resource_afcb4a61b965600a67ca2c2f060821db9}{\+\_\+dirty\+State} ()
\begin{DoxyCompactList}\small\item\em Manually mark the state of this resource as having been changed. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_resource_aa68664db6b8723dc198beef3d21d4ef5}{\+\_\+fire\+Loading\+Complete} (bool was\+Background\+Loaded)
\begin{DoxyCompactList}\small\item\em Firing of loading complete event. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_resource_aaf63d096584ac7d97fe1d1b0226c9561}{\+\_\+fire\+Preparing\+Complete} (bool was\+Background\+Loaded)
\begin{DoxyCompactList}\small\item\em Firing of preparing complete event. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_resource_aaf3746937cd11864f53bc1c3b4437541}{\+\_\+fire\+Unloading\+Complete} (void)
\begin{DoxyCompactList}\small\item\em Firing of unloading complete event. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_resource_a7e248a1cca0662418d4ab3f63c2e7cf6}{\+\_\+notify\+Origin} (const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&origin)
\begin{DoxyCompactList}\small\item\em Notify this resource of it\textquotesingle{}s origin. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_font_ac2c1fba5ad2d610ecc78b1e1a6a1b8dc}{add\+Code\+Point\+Range} (const \hyperlink{class_ogre_1_1_font_aa455a399457bd458852555c696b28f6a}{Code\+Point\+Range} \&range)
\begin{DoxyCompactList}\small\item\em Adds a range of code points to the list of code point ranges to generate glyphs for, if this is a truetype based font. \end{DoxyCompactList}\item 
virtual void \hyperlink{class_ogre_1_1_resource_a5513ffce404b14cff72846318b018d32}{add\+Listener} (\hyperlink{class_ogre_1_1_resource_1_1_listener}{Listener} $\ast$lis)
\begin{DoxyCompactList}\small\item\em Register a listener on this resource. \end{DoxyCompactList}\item 
virtual void \hyperlink{class_ogre_1_1_resource_aa5d6f3f7e73b77b233fc62b11f270e4d}{change\+Group\+Ownership} (const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&new\+Group)
\begin{DoxyCompactList}\small\item\em Change the resource group ownership of a \hyperlink{class_ogre_1_1_resource}{Resource}. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_font_aff75a40e8ca00a64f19c265e90c61733}{clear\+Code\+Point\+Ranges} ()
\begin{DoxyCompactList}\small\item\em Clear the list of code point ranges. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_string_interface_aad68d8b18faad14e8286a67527094654}{copy\+Parameters\+To} (\hyperlink{class_ogre_1_1_string_interface}{String\+Interface} $\ast$dest) const
\begin{DoxyCompactList}\small\item\em Method for copying this object\textquotesingle{}s parameters to another object. \end{DoxyCompactList}\item 
virtual void \hyperlink{class_ogre_1_1_resource_a367f6fe60bb211cb4c32e3825ca67e4c}{escalate\+Loading} ()
\begin{DoxyCompactList}\small\item\em Escalates the loading of a background loaded resource. \end{DoxyCompactList}\item 
bool \hyperlink{class_ogre_1_1_font_a278117d7414d69dbaed6e7290e842991}{get\+Antialias\+Colour} (void) const
\begin{DoxyCompactList}\small\item\em Gets whether or not the colour of this font is antialiased as it is generated from a true type font. \end{DoxyCompactList}\item 
\hyperlink{namespace_ogre_ab6e842a18caf062ed73a5d3badd0dd4c}{uint} \hyperlink{class_ogre_1_1_font_af055e465763f6328d3d5685eb30b0b30}{get\+Character\+Spacer} (void) const
\begin{DoxyCompactList}\small\item\em Gets the spacing to allocate for font characters to overlap each other. \end{DoxyCompactList}\item 
const \hyperlink{class_ogre_1_1_font_a3b754bb7b6d6b9be27d76d7c3a70fc7e}{Code\+Point\+Range\+List} \& \hyperlink{class_ogre_1_1_font_a84c9f4e4a5d536fc6660c8f9fc37db66}{get\+Code\+Point\+Range\+List} () const
\begin{DoxyCompactList}\small\item\em Get a const reference to the list of code point ranges to be used to generate glyphs from a truetype font. \end{DoxyCompactList}\item 
\hyperlink{class_ogre_1_1_resource_manager}{Resource\+Manager} $\ast$ \hyperlink{class_ogre_1_1_resource_ab6e377a3964d566ea112fe63bf1d7678}{get\+Creator} (void)
\begin{DoxyCompactList}\small\item\em Gets the manager which created this resource. \end{DoxyCompactList}\item 
\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} \hyperlink{class_ogre_1_1_font_a2184210a132f13a445a267165d571e19}{get\+Glyph\+Aspect\+Ratio} (\hyperlink{class_ogre_1_1_font_ad48cf05dd479e7c8f1d7a97221d933b1}{Code\+Point} id) const
\begin{DoxyCompactList}\small\item\em Gets the aspect ratio (width / height) of this character. \end{DoxyCompactList}\item 
const \hyperlink{struct_ogre_1_1_font_1_1_glyph_info}{Glyph\+Info} \& \hyperlink{class_ogre_1_1_font_a466bb6a4fcc47a2b36115f4046490f5b}{get\+Glyph\+Info} (\hyperlink{class_ogre_1_1_font_ad48cf05dd479e7c8f1d7a97221d933b1}{Code\+Point} id) const
\begin{DoxyCompactList}\small\item\em Gets the information available for a glyph corresponding to a given code point, or throws an exception if it doesn\textquotesingle{}t exist;. \end{DoxyCompactList}\item 
const \hyperlink{class_ogre_1_1_font_a17ebc3668a45365c1243a83f36a512ef}{U\+V\+Rect} \& \hyperlink{class_ogre_1_1_font_a3cd25330533cd4155bcc4dee9e468370}{get\+Glyph\+Tex\+Coords} (\hyperlink{class_ogre_1_1_font_ad48cf05dd479e7c8f1d7a97221d933b1}{Code\+Point} id) const
\begin{DoxyCompactList}\small\item\em Returns the texture coordinates of the associated glyph. \end{DoxyCompactList}\item 
virtual const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \& \hyperlink{class_ogre_1_1_resource_a382919945c07a6a13136889ad3fbf578}{get\+Group} (void) const
\begin{DoxyCompactList}\small\item\em Gets the group which this resource is a member of. \end{DoxyCompactList}\item 
virtual \hyperlink{namespace_ogre_aeb9f62c8e6c4239315286c63321722b2}{Resource\+Handle} \hyperlink{class_ogre_1_1_resource_a2298551707debaf774d577e643ee856a}{get\+Handle} (void) const
\item 
virtual \hyperlink{class_ogre_1_1_resource_a07e619aa09d3bc6789a6667cb4fc572c}{Loading\+State} \hyperlink{class_ogre_1_1_resource_a1e90ade99935ef70ec5b199243bf995b}{get\+Loading\+State} () const
\begin{DoxyCompactList}\small\item\em Returns the current loading state. \end{DoxyCompactList}\item 
const \hyperlink{namespace_ogre_a57ef769e80226674c3971ce58b58c91d}{Material\+Ptr} \& \hyperlink{class_ogre_1_1_font_a9de80ee5fde8a6cd4ddf1633f77b7b4d}{get\+Material} () const
\begin{DoxyCompactList}\small\item\em Gets the material generated for this font, as a weak reference. \end{DoxyCompactList}\item 
const \hyperlink{namespace_ogre_a57ef769e80226674c3971ce58b58c91d}{Material\+Ptr} \& \hyperlink{class_ogre_1_1_font_a354eac639a3afd4bfe797a208f6c90ce}{get\+Material} ()
\begin{DoxyCompactList}\small\item\em Gets the material generated for this font, as a weak reference. \end{DoxyCompactList}\item 
virtual const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \& \hyperlink{class_ogre_1_1_resource_a0646fba8aa0242c6b389d73f47ebe41b}{get\+Name} (void) const
\begin{DoxyCompactList}\small\item\em Gets resource name. \end{DoxyCompactList}\item 
const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \& \hyperlink{class_ogre_1_1_resource_a13423fa7944d7f2339e78b9de026c3be}{get\+Origin} (void) const
\begin{DoxyCompactList}\small\item\em Get the origin of this resource, e.\+g. \end{DoxyCompactList}\item 
\hyperlink{class_ogre_1_1_param_dictionary}{Param\+Dictionary} $\ast$ \hyperlink{class_ogre_1_1_string_interface_ae3e13925bde11db245f6c9bbf5031a93}{get\+Param\+Dictionary} (void)
\begin{DoxyCompactList}\small\item\em Retrieves the parameter dictionary for this class. \end{DoxyCompactList}\item 
const \hyperlink{class_ogre_1_1_param_dictionary}{Param\+Dictionary} $\ast$ \hyperlink{class_ogre_1_1_string_interface_a0f55da0550a7e1ab70a1c8bf598a3e20}{get\+Param\+Dictionary} (void) const
\item 
\hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \hyperlink{class_ogre_1_1_string_interface_a1d078304c38a9f85d483fc8ed0cdf1fe}{get\+Parameter} (const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&name) const
\begin{DoxyCompactList}\small\item\em Generic parameter retrieval method. \end{DoxyCompactList}\item 
const \hyperlink{group___general_ga1838c2b0619ade1f5e29767062212872}{Parameter\+List} \& \hyperlink{class_ogre_1_1_string_interface_ad4b984bfbf148ddb3310b3d0ba8a9d5d}{get\+Parameters} (void) const
\begin{DoxyCompactList}\small\item\em Retrieves a list of parameters valid for this object. \end{DoxyCompactList}\item 
virtual size\+\_\+t \hyperlink{class_ogre_1_1_resource_a0617d9f04ca03bd25f4bde201e6ac13b}{get\+Size} (void) const
\begin{DoxyCompactList}\small\item\em Retrieves info about the size of the resource. \end{DoxyCompactList}\item 
const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \& \hyperlink{class_ogre_1_1_font_a64b16b4bf7d41c25824780599b4c4f81}{get\+Source} (void) const
\begin{DoxyCompactList}\small\item\em Gets the source this font (either an image or a truetype font). \end{DoxyCompactList}\item 
virtual size\+\_\+t \hyperlink{class_ogre_1_1_resource_ade85e4d5579519e4117a84789c0ae8fd}{get\+State\+Count} () const
\begin{DoxyCompactList}\small\item\em Returns the number of times this resource has changed state, which generally means the number of times it has been loaded. \end{DoxyCompactList}\item 
int \hyperlink{class_ogre_1_1_font_a68ba192b84cc956d76b5d5f463b2f6b2}{get\+True\+Type\+Max\+BearingY} () const
\begin{DoxyCompactList}\small\item\em Gets the maximum baseline distance of all glyphs used in the texture. \end{DoxyCompactList}\item 
\hyperlink{namespace_ogre_ab6e842a18caf062ed73a5d3badd0dd4c}{uint} \hyperlink{class_ogre_1_1_font_adfdd689e89e023ae144207da8b82487a}{get\+True\+Type\+Resolution} (void) const
\begin{DoxyCompactList}\small\item\em Gets the resolution (dpi) of the font used to generate the texture. \end{DoxyCompactList}\item 
\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} \hyperlink{class_ogre_1_1_font_ad68729fd75b27236a4174a5e5013c448}{get\+True\+Type\+Size} (void) const
\begin{DoxyCompactList}\small\item\em Gets the point size of the font used to generate the texture. \end{DoxyCompactList}\item 
\hyperlink{group___overlays_ga7d22ba70debe31488cdd62c5dc307ce9}{Font\+Type} \hyperlink{class_ogre_1_1_font_a1248de6416ef53ce06eaf69bbb20a576}{get\+Type} (void) const
\begin{DoxyCompactList}\small\item\em Gets the type of font. \end{DoxyCompactList}\item 
virtual bool \hyperlink{class_ogre_1_1_resource_a60ce96525ac730a0f7b466ed287beef3}{is\+Background\+Loaded} (void) const
\begin{DoxyCompactList}\small\item\em Returns whether this \hyperlink{class_ogre_1_1_resource}{Resource} has been earmarked for background loading. \end{DoxyCompactList}\item 
virtual bool \hyperlink{class_ogre_1_1_resource_a74138c0203835513613af73cdb08890d}{is\+Loaded} (void) const
\begin{DoxyCompactList}\small\item\em Returns true if the \hyperlink{class_ogre_1_1_resource}{Resource} has been loaded, false otherwise. \end{DoxyCompactList}\item 
virtual bool \hyperlink{class_ogre_1_1_resource_a3af26f716731b64850ea50cfa4d2edef}{is\+Loading} () const
\begin{DoxyCompactList}\small\item\em Returns whether the resource is currently in the process of background loading. \end{DoxyCompactList}\item 
virtual bool \hyperlink{class_ogre_1_1_resource_a8f541900f7e1f73f4c313a732199029a}{is\+Manually\+Loaded} (void) const
\begin{DoxyCompactList}\small\item\em Is this resource manually loaded? \end{DoxyCompactList}\item 
virtual bool \hyperlink{class_ogre_1_1_resource_a0779c46df96234b6619a5f57fbb36078}{is\+Prepared} (void) const
\begin{DoxyCompactList}\small\item\em Returns true if the \hyperlink{class_ogre_1_1_resource}{Resource} has been prepared, false otherwise. \end{DoxyCompactList}\item 
virtual bool \hyperlink{class_ogre_1_1_resource_a8eb34a9034aab62fd537c021a79e3366}{is\+Reloadable} (void) const
\begin{DoxyCompactList}\small\item\em Returns true if the \hyperlink{class_ogre_1_1_resource}{Resource} is reloadable, false otherwise. \end{DoxyCompactList}\item 
virtual void \hyperlink{class_ogre_1_1_resource_a699d1c851f494a8d5d23d23b695ceb47}{load} (bool background\+Thread=false)
\begin{DoxyCompactList}\small\item\em Loads the resource, if it is not already. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_font_ad9fb35dcaf249ea1d86a3fe849422e2d}{load\+Resource} (\hyperlink{class_ogre_1_1_resource}{Resource} $\ast$resource)
\begin{DoxyCompactList}\small\item\em Implementation of \hyperlink{class_ogre_1_1_manual_resource_loader_ae04795ab21e4a46709beb6d521a75c53}{Manual\+Resource\+Loader\+::load\+Resource}, called when the \hyperlink{class_ogre_1_1_texture}{Texture} that this font creates needs to (re)load. \end{DoxyCompactList}\item 
virtual void \hyperlink{class_ogre_1_1_resource_a350b287fa3e83a389221274f68760008}{prepare} (bool background\+Thread=false)
\begin{DoxyCompactList}\small\item\em Prepares the resource for load, if it is not already. \end{DoxyCompactList}\item 
virtual void \hyperlink{class_ogre_1_1_manual_resource_loader_a7b4afd007622d165efbcc362e5566922}{prepare\+Resource} (\hyperlink{class_ogre_1_1_resource}{Resource} $\ast$resource)
\begin{DoxyCompactList}\small\item\em Called when a resource wishes to load. \end{DoxyCompactList}\item 
virtual void \hyperlink{class_ogre_1_1_resource_a5016aec1762b026997ddd346775879ef}{reload} (\hyperlink{class_ogre_1_1_resource_a1aa750a4b994f2b1066220936cdfdb94}{Loading\+Flags} flags=\hyperlink{class_ogre_1_1_resource_a1aa750a4b994f2b1066220936cdfdb94ab49695ac949df3a7d2e2f9a03267097c}{L\+F\+\_\+\+D\+E\+F\+A\+U\+LT})
\begin{DoxyCompactList}\small\item\em Reloads the resource, if it is already loaded. \end{DoxyCompactList}\item 
virtual void \hyperlink{class_ogre_1_1_resource_a3c49142f739ba8fb56d6e7b3db235fb7}{remove\+Listener} (\hyperlink{class_ogre_1_1_resource_1_1_listener}{Listener} $\ast$lis)
\begin{DoxyCompactList}\small\item\em Remove a listener on this resource. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_font_a6ca4172a3f554f07752997b1a25278c0}{set\+Antialias\+Colour} (bool enabled)
\begin{DoxyCompactList}\small\item\em Sets whether or not the colour of this font is antialiased as it is generated from a true type font. \end{DoxyCompactList}\item 
virtual void \hyperlink{class_ogre_1_1_resource_ae0a0007de944eb3c2f933a372a752b35}{set\+Background\+Loaded} (bool bl)
\begin{DoxyCompactList}\small\item\em Tells the resource whether it is background loaded or not. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_font_ab68fc068d526a83163bf305acdc6c732}{set\+Character\+Spacer} (\hyperlink{namespace_ogre_ab6e842a18caf062ed73a5d3badd0dd4c}{uint} char\+Spacer)
\begin{DoxyCompactList}\small\item\em Sets the spacing to allocate for font characters to overlap each other. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_font_aa80b463afd8a361e240a5a6856e892e3}{set\+Glyph\+Aspect\+Ratio} (\hyperlink{class_ogre_1_1_font_ad48cf05dd479e7c8f1d7a97221d933b1}{Code\+Point} id, \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} ratio)
\begin{DoxyCompactList}\small\item\em Sets the aspect ratio (width / height) of this character. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_font_a97480c17800578be97dc6a432983d3f2}{set\+Glyph\+Tex\+Coords} (\hyperlink{class_ogre_1_1_font_ad48cf05dd479e7c8f1d7a97221d933b1}{Code\+Point} id, \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} u1, \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} v1, \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} u2, \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} v2, \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} texture\+Aspect)
\begin{DoxyCompactList}\small\item\em Sets the texture coordinates of a glyph. \end{DoxyCompactList}\item 
bool \hyperlink{class_ogre_1_1_string_interface_a08d117bf25f011f96d81f1f4ecb25113}{set\+Parameter} (const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&name, const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&value)
\begin{DoxyCompactList}\small\item\em Generic parameter setting method. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_string_interface_a9aac32f93bd149a34b809a57a9f01f8f}{set\+Parameter\+List} (const \hyperlink{group___general_ga0537f38d7a77fcbe9f600f6ed8a926d6}{Name\+Value\+Pair\+List} \&param\+List)
\begin{DoxyCompactList}\small\item\em Generic multiple parameter setting method. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_font_a08e9fef8b8196c28d928c690964fc031}{set\+Source} (const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&source)
\begin{DoxyCompactList}\small\item\em Sets the source of the font. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_font_abfa4659b19ef3052676ccf8a64181e6f}{set\+True\+Type\+Resolution} (\hyperlink{namespace_ogre_ab6e842a18caf062ed73a5d3badd0dd4c}{uint} ttf\+Resolution)
\begin{DoxyCompactList}\small\item\em Gets the resolution (dpi) of the font used to generate the texture (only required for F\+T\+\_\+\+T\+R\+U\+E\+T\+Y\+PE). \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_font_a242776c92b41e51d0dbce17ba9fec747}{set\+True\+Type\+Size} (\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} ttf\+Size)
\begin{DoxyCompactList}\small\item\em Sets the size of a truetype font (only required for F\+T\+\_\+\+T\+R\+U\+E\+T\+Y\+PE). \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_font_ab89abe298177153acda383de2d7823ca}{set\+Type} (\hyperlink{group___overlays_ga7d22ba70debe31488cdd62c5dc307ce9}{Font\+Type} ftype)
\begin{DoxyCompactList}\small\item\em Sets the type of font. \end{DoxyCompactList}\item 
virtual void \hyperlink{class_ogre_1_1_resource_ae229b1f58092109adef55bfc6f864d79}{touch} (void)
\begin{DoxyCompactList}\small\item\em \textquotesingle{}Touches\textquotesingle{} the resource to indicate it has been used. \end{DoxyCompactList}\item 
virtual void \hyperlink{class_ogre_1_1_resource_aa31bef1bfaa87731622e56f11b548e27}{unload} (void)
\begin{DoxyCompactList}\small\item\em Unloads the resource; this is not permanent, the resource can be reloaded later if required. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Static Public Member Functions}
\begin{DoxyCompactItemize}
\item 
static void \hyperlink{class_ogre_1_1_string_interface_a1bea65fa2b3c2ac5a9f3be59b46a80e8}{cleanup\+Dictionary} ()
\begin{DoxyCompactList}\small\item\em Cleans up the static \textquotesingle{}ms\+Dictionary\textquotesingle{} required to reset \hyperlink{namespace_ogre}{Ogre}, otherwise the containers are left with invalid pointers, which will lead to a crash as soon as one of the \hyperlink{class_ogre_1_1_resource_manager}{Resource\+Manager} implementers (e.\+g. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Public Attributes}
\begin{DoxyCompactItemize}
\item 
\hyperlink{class_ogre_1_1_resource_a104d9db8bfcff1f37b29157bbe070f7a}{O\+G\+R\+E\+\_\+\+A\+U\+T\+O\+\_\+\+M\+U\+T\+EX}
\end{DoxyCompactItemize}


\subsection{Detailed Description}
Class representing a font in the system. 

\begin{DoxyRemark}{Remarks}
This class is simply a way of getting a font texture into the O\+G\+RE system and to easily retrieve the texture coordinates required to accurately render them. Fonts can either be loaded from precreated textures, or the texture can be generated using a truetype font. You can either create the texture manually in code, or you can use a .fontdef script to define it (probably more practical since you can reuse the definition more easily) 
\end{DoxyRemark}
\begin{DoxyNote}{Note}
This class extends both \hyperlink{class_ogre_1_1_resource}{Resource} and \hyperlink{class_ogre_1_1_manual_resource_loader}{Manual\+Resource\+Loader} since it is both a resource in it\textquotesingle{}s own right, but it also provides the manual load implementation for the \hyperlink{class_ogre_1_1_texture}{Texture} it creates. 
\end{DoxyNote}


\subsection{Member Typedef Documentation}
\mbox{\Hypertarget{class_ogre_1_1_font_ad48cf05dd479e7c8f1d7a97221d933b1}\label{class_ogre_1_1_font_ad48cf05dd479e7c8f1d7a97221d933b1}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!Code\+Point@{Code\+Point}}
\index{Code\+Point@{Code\+Point}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{Code\+Point}{CodePoint}}
{\footnotesize\ttfamily typedef \hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{Ogre\+::uint32} \hyperlink{class_ogre_1_1_font_ad48cf05dd479e7c8f1d7a97221d933b1}{Ogre\+::\+Font\+::\+Code\+Point}}

\mbox{\Hypertarget{class_ogre_1_1_font_a17ebc3668a45365c1243a83f36a512ef}\label{class_ogre_1_1_font_a17ebc3668a45365c1243a83f36a512ef}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!U\+V\+Rect@{U\+V\+Rect}}
\index{U\+V\+Rect@{U\+V\+Rect}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{U\+V\+Rect}{UVRect}}
{\footnotesize\ttfamily typedef \hyperlink{group___general_ga39213af9254535e83b4beca0859e8a2f}{Ogre\+::\+Float\+Rect} \hyperlink{class_ogre_1_1_font_a17ebc3668a45365c1243a83f36a512ef}{Ogre\+::\+Font\+::\+U\+V\+Rect}}

\mbox{\Hypertarget{class_ogre_1_1_font_aa455a399457bd458852555c696b28f6a}\label{class_ogre_1_1_font_aa455a399457bd458852555c696b28f6a}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!Code\+Point\+Range@{Code\+Point\+Range}}
\index{Code\+Point\+Range@{Code\+Point\+Range}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{Code\+Point\+Range}{CodePointRange}}
{\footnotesize\ttfamily typedef std\+::pair$<$\hyperlink{class_ogre_1_1_font_ad48cf05dd479e7c8f1d7a97221d933b1}{Code\+Point}, \hyperlink{class_ogre_1_1_font_ad48cf05dd479e7c8f1d7a97221d933b1}{Code\+Point}$>$ \hyperlink{class_ogre_1_1_font_aa455a399457bd458852555c696b28f6a}{Ogre\+::\+Font\+::\+Code\+Point\+Range}}



A range of code points, inclusive on both ends. 

\mbox{\Hypertarget{class_ogre_1_1_font_a3b754bb7b6d6b9be27d76d7c3a70fc7e}\label{class_ogre_1_1_font_a3b754bb7b6d6b9be27d76d7c3a70fc7e}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!Code\+Point\+Range\+List@{Code\+Point\+Range\+List}}
\index{Code\+Point\+Range\+List@{Code\+Point\+Range\+List}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{Code\+Point\+Range\+List}{CodePointRangeList}}
{\footnotesize\ttfamily typedef std\+::vector$<$\hyperlink{class_ogre_1_1_font_aa455a399457bd458852555c696b28f6a}{Code\+Point\+Range}$>$ \hyperlink{class_ogre_1_1_font_a3b754bb7b6d6b9be27d76d7c3a70fc7e}{Ogre\+::\+Font\+::\+Code\+Point\+Range\+List}}



\subsection{Member Enumeration Documentation}
\mbox{\Hypertarget{class_ogre_1_1_resource_a07e619aa09d3bc6789a6667cb4fc572c}\label{class_ogre_1_1_resource_a07e619aa09d3bc6789a6667cb4fc572c}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!Loading\+State@{Loading\+State}}
\index{Loading\+State@{Loading\+State}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{Loading\+State}{LoadingState}}
{\footnotesize\ttfamily enum \hyperlink{class_ogre_1_1_resource_a07e619aa09d3bc6789a6667cb4fc572c}{Ogre\+::\+Resource\+::\+Loading\+State}\hspace{0.3cm}{\ttfamily [inherited]}}



Enum identifying the loading state of the resource. 

\begin{DoxyEnumFields}{Enumerator}
\raisebox{\heightof{T}}[0pt][0pt]{\index{L\+O\+A\+D\+S\+T\+A\+T\+E\+\_\+\+U\+N\+L\+O\+A\+D\+ED@{L\+O\+A\+D\+S\+T\+A\+T\+E\+\_\+\+U\+N\+L\+O\+A\+D\+ED}!Ogre\+::\+Font@{Ogre\+::\+Font}}\index{Ogre\+::\+Font@{Ogre\+::\+Font}!L\+O\+A\+D\+S\+T\+A\+T\+E\+\_\+\+U\+N\+L\+O\+A\+D\+ED@{L\+O\+A\+D\+S\+T\+A\+T\+E\+\_\+\+U\+N\+L\+O\+A\+D\+ED}}}\mbox{\Hypertarget{class_ogre_1_1_resource_a07e619aa09d3bc6789a6667cb4fc572ca28d463296cacdfc115dbc3fb02d00e94}\label{class_ogre_1_1_resource_a07e619aa09d3bc6789a6667cb4fc572ca28d463296cacdfc115dbc3fb02d00e94}} 
L\+O\+A\+D\+S\+T\+A\+T\+E\+\_\+\+U\+N\+L\+O\+A\+D\+ED&Not loaded. \\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{L\+O\+A\+D\+S\+T\+A\+T\+E\+\_\+\+L\+O\+A\+D\+I\+NG@{L\+O\+A\+D\+S\+T\+A\+T\+E\+\_\+\+L\+O\+A\+D\+I\+NG}!Ogre\+::\+Font@{Ogre\+::\+Font}}\index{Ogre\+::\+Font@{Ogre\+::\+Font}!L\+O\+A\+D\+S\+T\+A\+T\+E\+\_\+\+L\+O\+A\+D\+I\+NG@{L\+O\+A\+D\+S\+T\+A\+T\+E\+\_\+\+L\+O\+A\+D\+I\+NG}}}\mbox{\Hypertarget{class_ogre_1_1_resource_a07e619aa09d3bc6789a6667cb4fc572caf138fc9087e0dc755bff08a83720cbb5}\label{class_ogre_1_1_resource_a07e619aa09d3bc6789a6667cb4fc572caf138fc9087e0dc755bff08a83720cbb5}} 
L\+O\+A\+D\+S\+T\+A\+T\+E\+\_\+\+L\+O\+A\+D\+I\+NG&Loading is in progress. \\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{L\+O\+A\+D\+S\+T\+A\+T\+E\+\_\+\+L\+O\+A\+D\+ED@{L\+O\+A\+D\+S\+T\+A\+T\+E\+\_\+\+L\+O\+A\+D\+ED}!Ogre\+::\+Font@{Ogre\+::\+Font}}\index{Ogre\+::\+Font@{Ogre\+::\+Font}!L\+O\+A\+D\+S\+T\+A\+T\+E\+\_\+\+L\+O\+A\+D\+ED@{L\+O\+A\+D\+S\+T\+A\+T\+E\+\_\+\+L\+O\+A\+D\+ED}}}\mbox{\Hypertarget{class_ogre_1_1_resource_a07e619aa09d3bc6789a6667cb4fc572caa38cbef7605fc4bff6da2f34599ace8f}\label{class_ogre_1_1_resource_a07e619aa09d3bc6789a6667cb4fc572caa38cbef7605fc4bff6da2f34599ace8f}} 
L\+O\+A\+D\+S\+T\+A\+T\+E\+\_\+\+L\+O\+A\+D\+ED&Fully loaded. \\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{L\+O\+A\+D\+S\+T\+A\+T\+E\+\_\+\+U\+N\+L\+O\+A\+D\+I\+NG@{L\+O\+A\+D\+S\+T\+A\+T\+E\+\_\+\+U\+N\+L\+O\+A\+D\+I\+NG}!Ogre\+::\+Font@{Ogre\+::\+Font}}\index{Ogre\+::\+Font@{Ogre\+::\+Font}!L\+O\+A\+D\+S\+T\+A\+T\+E\+\_\+\+U\+N\+L\+O\+A\+D\+I\+NG@{L\+O\+A\+D\+S\+T\+A\+T\+E\+\_\+\+U\+N\+L\+O\+A\+D\+I\+NG}}}\mbox{\Hypertarget{class_ogre_1_1_resource_a07e619aa09d3bc6789a6667cb4fc572ca4228d390b3a9ed614001db177d1f441e}\label{class_ogre_1_1_resource_a07e619aa09d3bc6789a6667cb4fc572ca4228d390b3a9ed614001db177d1f441e}} 
L\+O\+A\+D\+S\+T\+A\+T\+E\+\_\+\+U\+N\+L\+O\+A\+D\+I\+NG&Currently unloading. \\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{L\+O\+A\+D\+S\+T\+A\+T\+E\+\_\+\+P\+R\+E\+P\+A\+R\+ED@{L\+O\+A\+D\+S\+T\+A\+T\+E\+\_\+\+P\+R\+E\+P\+A\+R\+ED}!Ogre\+::\+Font@{Ogre\+::\+Font}}\index{Ogre\+::\+Font@{Ogre\+::\+Font}!L\+O\+A\+D\+S\+T\+A\+T\+E\+\_\+\+P\+R\+E\+P\+A\+R\+ED@{L\+O\+A\+D\+S\+T\+A\+T\+E\+\_\+\+P\+R\+E\+P\+A\+R\+ED}}}\mbox{\Hypertarget{class_ogre_1_1_resource_a07e619aa09d3bc6789a6667cb4fc572ca133a073b86c346096237063f99870fc1}\label{class_ogre_1_1_resource_a07e619aa09d3bc6789a6667cb4fc572ca133a073b86c346096237063f99870fc1}} 
L\+O\+A\+D\+S\+T\+A\+T\+E\+\_\+\+P\+R\+E\+P\+A\+R\+ED&Fully prepared. \\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{L\+O\+A\+D\+S\+T\+A\+T\+E\+\_\+\+P\+R\+E\+P\+A\+R\+I\+NG@{L\+O\+A\+D\+S\+T\+A\+T\+E\+\_\+\+P\+R\+E\+P\+A\+R\+I\+NG}!Ogre\+::\+Font@{Ogre\+::\+Font}}\index{Ogre\+::\+Font@{Ogre\+::\+Font}!L\+O\+A\+D\+S\+T\+A\+T\+E\+\_\+\+P\+R\+E\+P\+A\+R\+I\+NG@{L\+O\+A\+D\+S\+T\+A\+T\+E\+\_\+\+P\+R\+E\+P\+A\+R\+I\+NG}}}\mbox{\Hypertarget{class_ogre_1_1_resource_a07e619aa09d3bc6789a6667cb4fc572cab43c913411f4a96722902f17b88f10fb}\label{class_ogre_1_1_resource_a07e619aa09d3bc6789a6667cb4fc572cab43c913411f4a96722902f17b88f10fb}} 
L\+O\+A\+D\+S\+T\+A\+T\+E\+\_\+\+P\+R\+E\+P\+A\+R\+I\+NG&Preparing is in progress. \\
\hline

\end{DoxyEnumFields}
\mbox{\Hypertarget{class_ogre_1_1_resource_a1aa750a4b994f2b1066220936cdfdb94}\label{class_ogre_1_1_resource_a1aa750a4b994f2b1066220936cdfdb94}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!Loading\+Flags@{Loading\+Flags}}
\index{Loading\+Flags@{Loading\+Flags}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{Loading\+Flags}{LoadingFlags}}
{\footnotesize\ttfamily enum \hyperlink{class_ogre_1_1_resource_a1aa750a4b994f2b1066220936cdfdb94}{Ogre\+::\+Resource\+::\+Loading\+Flags}\hspace{0.3cm}{\ttfamily [inherited]}}



Enum that allow to choose subset of unloaded/reloaded resources and to adjust reloading behavior. 

\begin{DoxyEnumFields}{Enumerator}
\raisebox{\heightof{T}}[0pt][0pt]{\index{L\+F\+\_\+\+D\+E\+F\+A\+U\+LT@{L\+F\+\_\+\+D\+E\+F\+A\+U\+LT}!Ogre\+::\+Font@{Ogre\+::\+Font}}\index{Ogre\+::\+Font@{Ogre\+::\+Font}!L\+F\+\_\+\+D\+E\+F\+A\+U\+LT@{L\+F\+\_\+\+D\+E\+F\+A\+U\+LT}}}\mbox{\Hypertarget{class_ogre_1_1_resource_a1aa750a4b994f2b1066220936cdfdb94ab49695ac949df3a7d2e2f9a03267097c}\label{class_ogre_1_1_resource_a1aa750a4b994f2b1066220936cdfdb94ab49695ac949df3a7d2e2f9a03267097c}} 
L\+F\+\_\+\+D\+E\+F\+A\+U\+LT&Only reloadable resources are processed, reload restores initial state. \\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{L\+F\+\_\+\+I\+N\+C\+L\+U\+D\+E\+\_\+\+N\+O\+N\+\_\+\+R\+E\+L\+O\+A\+D\+A\+B\+LE@{L\+F\+\_\+\+I\+N\+C\+L\+U\+D\+E\+\_\+\+N\+O\+N\+\_\+\+R\+E\+L\+O\+A\+D\+A\+B\+LE}!Ogre\+::\+Font@{Ogre\+::\+Font}}\index{Ogre\+::\+Font@{Ogre\+::\+Font}!L\+F\+\_\+\+I\+N\+C\+L\+U\+D\+E\+\_\+\+N\+O\+N\+\_\+\+R\+E\+L\+O\+A\+D\+A\+B\+LE@{L\+F\+\_\+\+I\+N\+C\+L\+U\+D\+E\+\_\+\+N\+O\+N\+\_\+\+R\+E\+L\+O\+A\+D\+A\+B\+LE}}}\mbox{\Hypertarget{class_ogre_1_1_resource_a1aa750a4b994f2b1066220936cdfdb94a6ee542226e1cf18df28ab88426be6809}\label{class_ogre_1_1_resource_a1aa750a4b994f2b1066220936cdfdb94a6ee542226e1cf18df28ab88426be6809}} 
L\+F\+\_\+\+I\+N\+C\+L\+U\+D\+E\+\_\+\+N\+O\+N\+\_\+\+R\+E\+L\+O\+A\+D\+A\+B\+LE&Process non-\/reloadable resources too. \\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{L\+F\+\_\+\+O\+N\+L\+Y\+\_\+\+U\+N\+R\+E\+F\+E\+R\+E\+N\+C\+ED@{L\+F\+\_\+\+O\+N\+L\+Y\+\_\+\+U\+N\+R\+E\+F\+E\+R\+E\+N\+C\+ED}!Ogre\+::\+Font@{Ogre\+::\+Font}}\index{Ogre\+::\+Font@{Ogre\+::\+Font}!L\+F\+\_\+\+O\+N\+L\+Y\+\_\+\+U\+N\+R\+E\+F\+E\+R\+E\+N\+C\+ED@{L\+F\+\_\+\+O\+N\+L\+Y\+\_\+\+U\+N\+R\+E\+F\+E\+R\+E\+N\+C\+ED}}}\mbox{\Hypertarget{class_ogre_1_1_resource_a1aa750a4b994f2b1066220936cdfdb94a70589e0b87b09b0a4fd98ce490dc9782}\label{class_ogre_1_1_resource_a1aa750a4b994f2b1066220936cdfdb94a70589e0b87b09b0a4fd98ce490dc9782}} 
L\+F\+\_\+\+O\+N\+L\+Y\+\_\+\+U\+N\+R\+E\+F\+E\+R\+E\+N\+C\+ED&Process only resources which are not referenced by any other object. Usefull to reduce resource consumption. \\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{L\+F\+\_\+\+O\+N\+L\+Y\+\_\+\+U\+N\+R\+E\+F\+E\+R\+E\+N\+C\+E\+D\+\_\+\+I\+N\+C\+L\+U\+D\+E\+\_\+\+N\+O\+N\+\_\+\+R\+E\+L\+O\+A\+D\+A\+B\+LE@{L\+F\+\_\+\+O\+N\+L\+Y\+\_\+\+U\+N\+R\+E\+F\+E\+R\+E\+N\+C\+E\+D\+\_\+\+I\+N\+C\+L\+U\+D\+E\+\_\+\+N\+O\+N\+\_\+\+R\+E\+L\+O\+A\+D\+A\+B\+LE}!Ogre\+::\+Font@{Ogre\+::\+Font}}\index{Ogre\+::\+Font@{Ogre\+::\+Font}!L\+F\+\_\+\+O\+N\+L\+Y\+\_\+\+U\+N\+R\+E\+F\+E\+R\+E\+N\+C\+E\+D\+\_\+\+I\+N\+C\+L\+U\+D\+E\+\_\+\+N\+O\+N\+\_\+\+R\+E\+L\+O\+A\+D\+A\+B\+LE@{L\+F\+\_\+\+O\+N\+L\+Y\+\_\+\+U\+N\+R\+E\+F\+E\+R\+E\+N\+C\+E\+D\+\_\+\+I\+N\+C\+L\+U\+D\+E\+\_\+\+N\+O\+N\+\_\+\+R\+E\+L\+O\+A\+D\+A\+B\+LE}}}\mbox{\Hypertarget{class_ogre_1_1_resource_a1aa750a4b994f2b1066220936cdfdb94ae5f2eca654bd810da4c774570a5b4b77}\label{class_ogre_1_1_resource_a1aa750a4b994f2b1066220936cdfdb94ae5f2eca654bd810da4c774570a5b4b77}} 
L\+F\+\_\+\+O\+N\+L\+Y\+\_\+\+U\+N\+R\+E\+F\+E\+R\+E\+N\+C\+E\+D\+\_\+\+I\+N\+C\+L\+U\+D\+E\+\_\+\+N\+O\+N\+\_\+\+R\+E\+L\+O\+A\+D\+A\+B\+LE&Combination of L\+F\+\_\+\+O\+N\+L\+Y\+\_\+\+U\+N\+R\+E\+F\+E\+R\+E\+N\+C\+ED and L\+F\+\_\+\+I\+N\+C\+L\+U\+D\+E\+\_\+\+N\+O\+N\+\_\+\+R\+E\+L\+O\+A\+D\+A\+B\+LE. \\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{L\+F\+\_\+\+P\+R\+E\+S\+E\+R\+V\+E\+\_\+\+S\+T\+A\+TE@{L\+F\+\_\+\+P\+R\+E\+S\+E\+R\+V\+E\+\_\+\+S\+T\+A\+TE}!Ogre\+::\+Font@{Ogre\+::\+Font}}\index{Ogre\+::\+Font@{Ogre\+::\+Font}!L\+F\+\_\+\+P\+R\+E\+S\+E\+R\+V\+E\+\_\+\+S\+T\+A\+TE@{L\+F\+\_\+\+P\+R\+E\+S\+E\+R\+V\+E\+\_\+\+S\+T\+A\+TE}}}\mbox{\Hypertarget{class_ogre_1_1_resource_a1aa750a4b994f2b1066220936cdfdb94ad83abf165de5cfa1a4c8e0cd5471ad2c}\label{class_ogre_1_1_resource_a1aa750a4b994f2b1066220936cdfdb94ad83abf165de5cfa1a4c8e0cd5471ad2c}} 
L\+F\+\_\+\+P\+R\+E\+S\+E\+R\+V\+E\+\_\+\+S\+T\+A\+TE&Preserve some states during reloading, for example stencil shadows prepareness for Meshes. \\
\hline

\end{DoxyEnumFields}


\subsection{Constructor \& Destructor Documentation}
\mbox{\Hypertarget{class_ogre_1_1_font_a9915203be62b8bd2feda436cc9f08cb0}\label{class_ogre_1_1_font_a9915203be62b8bd2feda436cc9f08cb0}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!Font@{Font}}
\index{Font@{Font}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{Font()}{Font()}}
{\footnotesize\ttfamily Ogre\+::\+Font\+::\+Font (\begin{DoxyParamCaption}\item[{\hyperlink{class_ogre_1_1_resource_manager}{Resource\+Manager} $\ast$}]{creator,  }\item[{const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&}]{name,  }\item[{\hyperlink{namespace_ogre_aeb9f62c8e6c4239315286c63321722b2}{Resource\+Handle}}]{handle,  }\item[{const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&}]{group,  }\item[{bool}]{is\+Manual = {\ttfamily false},  }\item[{\hyperlink{class_ogre_1_1_manual_resource_loader}{Manual\+Resource\+Loader} $\ast$}]{loader = {\ttfamily 0} }\end{DoxyParamCaption})}



Constructor. 

\begin{DoxySeeAlso}{See also}
\hyperlink{class_ogre_1_1_resource}{Resource} 
\end{DoxySeeAlso}
\mbox{\Hypertarget{class_ogre_1_1_font_a02642b36387d7ffd80e164ce1fac4591}\label{class_ogre_1_1_font_a02642b36387d7ffd80e164ce1fac4591}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!````~Font@{$\sim$\+Font}}
\index{````~Font@{$\sim$\+Font}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{$\sim$\+Font()}{~Font()}}
{\footnotesize\ttfamily virtual Ogre\+::\+Font\+::$\sim$\+Font (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



\subsection{Member Function Documentation}
\mbox{\Hypertarget{class_ogre_1_1_font_ab89abe298177153acda383de2d7823ca}\label{class_ogre_1_1_font_ab89abe298177153acda383de2d7823ca}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!set\+Type@{set\+Type}}
\index{set\+Type@{set\+Type}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{set\+Type()}{setType()}}
{\footnotesize\ttfamily void Ogre\+::\+Font\+::set\+Type (\begin{DoxyParamCaption}\item[{\hyperlink{group___overlays_ga7d22ba70debe31488cdd62c5dc307ce9}{Font\+Type}}]{ftype }\end{DoxyParamCaption})}



Sets the type of font. 

Must be set before loading. \mbox{\Hypertarget{class_ogre_1_1_font_a1248de6416ef53ce06eaf69bbb20a576}\label{class_ogre_1_1_font_a1248de6416ef53ce06eaf69bbb20a576}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!get\+Type@{get\+Type}}
\index{get\+Type@{get\+Type}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{get\+Type()}{getType()}}
{\footnotesize\ttfamily \hyperlink{group___overlays_ga7d22ba70debe31488cdd62c5dc307ce9}{Font\+Type} Ogre\+::\+Font\+::get\+Type (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const}



Gets the type of font. 

\mbox{\Hypertarget{class_ogre_1_1_font_a08e9fef8b8196c28d928c690964fc031}\label{class_ogre_1_1_font_a08e9fef8b8196c28d928c690964fc031}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!set\+Source@{set\+Source}}
\index{set\+Source@{set\+Source}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{set\+Source()}{setSource()}}
{\footnotesize\ttfamily void Ogre\+::\+Font\+::set\+Source (\begin{DoxyParamCaption}\item[{const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&}]{source }\end{DoxyParamCaption})}



Sets the source of the font. 

\begin{DoxyRemark}{Remarks}
If you have created a font of type F\+T\+\_\+\+I\+M\+A\+GE, this method tells the \hyperlink{class_ogre_1_1_font}{Font} which image to use as the source for the characters. So the parameter should be the name of an appropriate image file. Note that when using an image as a font source, you will also need to tell the font where each character is located using set\+Glyph\+Tex\+Coords (for each character). 
\end{DoxyRemark}
\begin{DoxyParagraph}{}
If you have created a font of type F\+T\+\_\+\+T\+R\+U\+E\+T\+Y\+PE, this method tells the \hyperlink{class_ogre_1_1_font}{Font} which .ttf file to use to generate the text. You will also need to call set\+True\+Type\+Size and set\+True\+Type\+Resolution, and call add\+Code\+Point\+Range as many times as required to define the range of glyphs you want to be available. 
\end{DoxyParagraph}

\begin{DoxyParams}{Parameters}
{\em source} & An image file or a truetype font, depending on the type of this font \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{class_ogre_1_1_font_a64b16b4bf7d41c25824780599b4c4f81}\label{class_ogre_1_1_font_a64b16b4bf7d41c25824780599b4c4f81}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!get\+Source@{get\+Source}}
\index{get\+Source@{get\+Source}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{get\+Source()}{getSource()}}
{\footnotesize\ttfamily const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}\& Ogre\+::\+Font\+::get\+Source (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const}



Gets the source this font (either an image or a truetype font). 

\mbox{\Hypertarget{class_ogre_1_1_font_ab68fc068d526a83163bf305acdc6c732}\label{class_ogre_1_1_font_ab68fc068d526a83163bf305acdc6c732}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!set\+Character\+Spacer@{set\+Character\+Spacer}}
\index{set\+Character\+Spacer@{set\+Character\+Spacer}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{set\+Character\+Spacer()}{setCharacterSpacer()}}
{\footnotesize\ttfamily void Ogre\+::\+Font\+::set\+Character\+Spacer (\begin{DoxyParamCaption}\item[{\hyperlink{namespace_ogre_ab6e842a18caf062ed73a5d3badd0dd4c}{uint}}]{char\+Spacer }\end{DoxyParamCaption})}



Sets the spacing to allocate for font characters to overlap each other. 


\begin{DoxyParams}{Parameters}
{\em char\+Spacer} & 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 \char`\"{}5\char`\"{}. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{class_ogre_1_1_font_af055e465763f6328d3d5685eb30b0b30}\label{class_ogre_1_1_font_af055e465763f6328d3d5685eb30b0b30}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!get\+Character\+Spacer@{get\+Character\+Spacer}}
\index{get\+Character\+Spacer@{get\+Character\+Spacer}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{get\+Character\+Spacer()}{getCharacterSpacer()}}
{\footnotesize\ttfamily \hyperlink{namespace_ogre_ab6e842a18caf062ed73a5d3badd0dd4c}{uint} Ogre\+::\+Font\+::get\+Character\+Spacer (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const}



Gets the spacing to allocate for font characters to overlap each other. 

\begin{DoxyRemark}{Remarks}
Returns the size of the character spacer, in points. A higher value allows for more stretched-\/out fonts. A low value reduces memory and processing time. The default is \char`\"{}5\char`\"{}. 
\end{DoxyRemark}
\mbox{\Hypertarget{class_ogre_1_1_font_a242776c92b41e51d0dbce17ba9fec747}\label{class_ogre_1_1_font_a242776c92b41e51d0dbce17ba9fec747}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!set\+True\+Type\+Size@{set\+True\+Type\+Size}}
\index{set\+True\+Type\+Size@{set\+True\+Type\+Size}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{set\+True\+Type\+Size()}{setTrueTypeSize()}}
{\footnotesize\ttfamily void Ogre\+::\+Font\+::set\+True\+Type\+Size (\begin{DoxyParamCaption}\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}]{ttf\+Size }\end{DoxyParamCaption})}



Sets the size of a truetype font (only required for F\+T\+\_\+\+T\+R\+U\+E\+T\+Y\+PE). 


\begin{DoxyParams}{Parameters}
{\em ttf\+Size} & 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. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{class_ogre_1_1_font_abfa4659b19ef3052676ccf8a64181e6f}\label{class_ogre_1_1_font_abfa4659b19ef3052676ccf8a64181e6f}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!set\+True\+Type\+Resolution@{set\+True\+Type\+Resolution}}
\index{set\+True\+Type\+Resolution@{set\+True\+Type\+Resolution}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{set\+True\+Type\+Resolution()}{setTrueTypeResolution()}}
{\footnotesize\ttfamily void Ogre\+::\+Font\+::set\+True\+Type\+Resolution (\begin{DoxyParamCaption}\item[{\hyperlink{namespace_ogre_ab6e842a18caf062ed73a5d3badd0dd4c}{uint}}]{ttf\+Resolution }\end{DoxyParamCaption})}



Gets the resolution (dpi) of the font used to generate the texture (only required for F\+T\+\_\+\+T\+R\+U\+E\+T\+Y\+PE). 


\begin{DoxyParams}{Parameters}
{\em ttf\+Resolution} & The resolution in dpi \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{class_ogre_1_1_font_ad68729fd75b27236a4174a5e5013c448}\label{class_ogre_1_1_font_ad68729fd75b27236a4174a5e5013c448}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!get\+True\+Type\+Size@{get\+True\+Type\+Size}}
\index{get\+True\+Type\+Size@{get\+True\+Type\+Size}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{get\+True\+Type\+Size()}{getTrueTypeSize()}}
{\footnotesize\ttfamily \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} Ogre\+::\+Font\+::get\+True\+Type\+Size (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const}



Gets the point size of the font used to generate the texture. 

\begin{DoxyRemark}{Remarks}
Only applicable for F\+T\+\_\+\+T\+R\+U\+E\+T\+Y\+PE \hyperlink{class_ogre_1_1_font}{Font} objects. 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. 
\end{DoxyRemark}
\mbox{\Hypertarget{class_ogre_1_1_font_adfdd689e89e023ae144207da8b82487a}\label{class_ogre_1_1_font_adfdd689e89e023ae144207da8b82487a}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!get\+True\+Type\+Resolution@{get\+True\+Type\+Resolution}}
\index{get\+True\+Type\+Resolution@{get\+True\+Type\+Resolution}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{get\+True\+Type\+Resolution()}{getTrueTypeResolution()}}
{\footnotesize\ttfamily \hyperlink{namespace_ogre_ab6e842a18caf062ed73a5d3badd0dd4c}{uint} Ogre\+::\+Font\+::get\+True\+Type\+Resolution (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const}



Gets the resolution (dpi) of the font used to generate the texture. 

\begin{DoxyRemark}{Remarks}
Only applicable for F\+T\+\_\+\+T\+R\+U\+E\+T\+Y\+PE \hyperlink{class_ogre_1_1_font}{Font} objects. 
\end{DoxyRemark}
\mbox{\Hypertarget{class_ogre_1_1_font_a68ba192b84cc956d76b5d5f463b2f6b2}\label{class_ogre_1_1_font_a68ba192b84cc956d76b5d5f463b2f6b2}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!get\+True\+Type\+Max\+BearingY@{get\+True\+Type\+Max\+BearingY}}
\index{get\+True\+Type\+Max\+BearingY@{get\+True\+Type\+Max\+BearingY}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{get\+True\+Type\+Max\+Bearing\+Y()}{getTrueTypeMaxBearingY()}}
{\footnotesize\ttfamily int Ogre\+::\+Font\+::get\+True\+Type\+Max\+BearingY (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const}



Gets the maximum baseline distance of all glyphs used in the texture. 

\begin{DoxyRemark}{Remarks}
Only applicable for F\+T\+\_\+\+T\+R\+U\+E\+T\+Y\+PE \hyperlink{class_ogre_1_1_font}{Font} objects. The baseline is the vertical origin of horizontal based glyphs. The bearingY attribute is the distance from the baseline (origin) to the top of the glyph\textquotesingle{}s bounding box. 
\end{DoxyRemark}
\begin{DoxyNote}{Note}
This value is only available after the font has been loaded. 
\end{DoxyNote}
\mbox{\Hypertarget{class_ogre_1_1_font_a3cd25330533cd4155bcc4dee9e468370}\label{class_ogre_1_1_font_a3cd25330533cd4155bcc4dee9e468370}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!get\+Glyph\+Tex\+Coords@{get\+Glyph\+Tex\+Coords}}
\index{get\+Glyph\+Tex\+Coords@{get\+Glyph\+Tex\+Coords}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{get\+Glyph\+Tex\+Coords()}{getGlyphTexCoords()}}
{\footnotesize\ttfamily const \hyperlink{class_ogre_1_1_font_a17ebc3668a45365c1243a83f36a512ef}{U\+V\+Rect}\& Ogre\+::\+Font\+::get\+Glyph\+Tex\+Coords (\begin{DoxyParamCaption}\item[{\hyperlink{class_ogre_1_1_font_ad48cf05dd479e7c8f1d7a97221d933b1}{Code\+Point}}]{id }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Returns the texture coordinates of the associated glyph. 

\begin{DoxyRemark}{Remarks}
Parameter is a short to allow both A\+S\+C\+II and wide chars. 
\end{DoxyRemark}

\begin{DoxyParams}{Parameters}
{\em id} & The code point (unicode) \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
A rectangle with the UV coordinates, or null U\+Vs if the code point was not present 
\end{DoxyReturn}
\mbox{\Hypertarget{class_ogre_1_1_font_a97480c17800578be97dc6a432983d3f2}\label{class_ogre_1_1_font_a97480c17800578be97dc6a432983d3f2}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!set\+Glyph\+Tex\+Coords@{set\+Glyph\+Tex\+Coords}}
\index{set\+Glyph\+Tex\+Coords@{set\+Glyph\+Tex\+Coords}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{set\+Glyph\+Tex\+Coords()}{setGlyphTexCoords()}}
{\footnotesize\ttfamily void Ogre\+::\+Font\+::set\+Glyph\+Tex\+Coords (\begin{DoxyParamCaption}\item[{\hyperlink{class_ogre_1_1_font_ad48cf05dd479e7c8f1d7a97221d933b1}{Code\+Point}}]{id,  }\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}]{u1,  }\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}]{v1,  }\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}]{u2,  }\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}]{v2,  }\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}]{texture\+Aspect }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Sets the texture coordinates of a glyph. 

\begin{DoxyRemark}{Remarks}
You only need to call this if you\textquotesingle{}re setting up a font loaded from a texture manually. 
\end{DoxyRemark}
\begin{DoxyNote}{Note}
Also sets the aspect ratio (width / height) of this character. texture\+Aspect is the width/height of the texture (may be non-\/square) 
\end{DoxyNote}
\mbox{\Hypertarget{class_ogre_1_1_font_a2184210a132f13a445a267165d571e19}\label{class_ogre_1_1_font_a2184210a132f13a445a267165d571e19}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!get\+Glyph\+Aspect\+Ratio@{get\+Glyph\+Aspect\+Ratio}}
\index{get\+Glyph\+Aspect\+Ratio@{get\+Glyph\+Aspect\+Ratio}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{get\+Glyph\+Aspect\+Ratio()}{getGlyphAspectRatio()}}
{\footnotesize\ttfamily \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} Ogre\+::\+Font\+::get\+Glyph\+Aspect\+Ratio (\begin{DoxyParamCaption}\item[{\hyperlink{class_ogre_1_1_font_ad48cf05dd479e7c8f1d7a97221d933b1}{Code\+Point}}]{id }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Gets the aspect ratio (width / height) of this character. 

\mbox{\Hypertarget{class_ogre_1_1_font_aa80b463afd8a361e240a5a6856e892e3}\label{class_ogre_1_1_font_aa80b463afd8a361e240a5a6856e892e3}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!set\+Glyph\+Aspect\+Ratio@{set\+Glyph\+Aspect\+Ratio}}
\index{set\+Glyph\+Aspect\+Ratio@{set\+Glyph\+Aspect\+Ratio}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{set\+Glyph\+Aspect\+Ratio()}{setGlyphAspectRatio()}}
{\footnotesize\ttfamily void Ogre\+::\+Font\+::set\+Glyph\+Aspect\+Ratio (\begin{DoxyParamCaption}\item[{\hyperlink{class_ogre_1_1_font_ad48cf05dd479e7c8f1d7a97221d933b1}{Code\+Point}}]{id,  }\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}]{ratio }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Sets the aspect ratio (width / height) of this character. 

\begin{DoxyRemark}{Remarks}
You only need to call this if you\textquotesingle{}re setting up a font loaded from a texture manually. 
\end{DoxyRemark}
\mbox{\Hypertarget{class_ogre_1_1_font_a466bb6a4fcc47a2b36115f4046490f5b}\label{class_ogre_1_1_font_a466bb6a4fcc47a2b36115f4046490f5b}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!get\+Glyph\+Info@{get\+Glyph\+Info}}
\index{get\+Glyph\+Info@{get\+Glyph\+Info}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{get\+Glyph\+Info()}{getGlyphInfo()}}
{\footnotesize\ttfamily const \hyperlink{struct_ogre_1_1_font_1_1_glyph_info}{Glyph\+Info}\& Ogre\+::\+Font\+::get\+Glyph\+Info (\begin{DoxyParamCaption}\item[{\hyperlink{class_ogre_1_1_font_ad48cf05dd479e7c8f1d7a97221d933b1}{Code\+Point}}]{id }\end{DoxyParamCaption}) const}



Gets the information available for a glyph corresponding to a given code point, or throws an exception if it doesn\textquotesingle{}t exist;. 

\mbox{\Hypertarget{class_ogre_1_1_font_ac2c1fba5ad2d610ecc78b1e1a6a1b8dc}\label{class_ogre_1_1_font_ac2c1fba5ad2d610ecc78b1e1a6a1b8dc}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!add\+Code\+Point\+Range@{add\+Code\+Point\+Range}}
\index{add\+Code\+Point\+Range@{add\+Code\+Point\+Range}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{add\+Code\+Point\+Range()}{addCodePointRange()}}
{\footnotesize\ttfamily void Ogre\+::\+Font\+::add\+Code\+Point\+Range (\begin{DoxyParamCaption}\item[{const \hyperlink{class_ogre_1_1_font_aa455a399457bd458852555c696b28f6a}{Code\+Point\+Range} \&}]{range }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [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. 

\begin{DoxyRemark}{Remarks}
In order to save texture space, only the glyphs which are actually needed by the application are generated into the texture. Before this object is loaded you must call this method as many times as necessary to define the code point range that you need. 
\end{DoxyRemark}
\mbox{\Hypertarget{class_ogre_1_1_font_aff75a40e8ca00a64f19c265e90c61733}\label{class_ogre_1_1_font_aff75a40e8ca00a64f19c265e90c61733}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!clear\+Code\+Point\+Ranges@{clear\+Code\+Point\+Ranges}}
\index{clear\+Code\+Point\+Ranges@{clear\+Code\+Point\+Ranges}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{clear\+Code\+Point\+Ranges()}{clearCodePointRanges()}}
{\footnotesize\ttfamily void Ogre\+::\+Font\+::clear\+Code\+Point\+Ranges (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Clear the list of code point ranges. 

\mbox{\Hypertarget{class_ogre_1_1_font_a84c9f4e4a5d536fc6660c8f9fc37db66}\label{class_ogre_1_1_font_a84c9f4e4a5d536fc6660c8f9fc37db66}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!get\+Code\+Point\+Range\+List@{get\+Code\+Point\+Range\+List}}
\index{get\+Code\+Point\+Range\+List@{get\+Code\+Point\+Range\+List}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{get\+Code\+Point\+Range\+List()}{getCodePointRangeList()}}
{\footnotesize\ttfamily const \hyperlink{class_ogre_1_1_font_a3b754bb7b6d6b9be27d76d7c3a70fc7e}{Code\+Point\+Range\+List}\& Ogre\+::\+Font\+::get\+Code\+Point\+Range\+List (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Get a const reference to the list of code point ranges to be used to generate glyphs from a truetype font. 

\mbox{\Hypertarget{class_ogre_1_1_font_a9de80ee5fde8a6cd4ddf1633f77b7b4d}\label{class_ogre_1_1_font_a9de80ee5fde8a6cd4ddf1633f77b7b4d}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!get\+Material@{get\+Material}}
\index{get\+Material@{get\+Material}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{get\+Material()}{getMaterial()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily const \hyperlink{namespace_ogre_a57ef769e80226674c3971ce58b58c91d}{Material\+Ptr}\& Ogre\+::\+Font\+::get\+Material (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Gets the material generated for this font, as a weak reference. 

\begin{DoxyRemark}{Remarks}
This will only be valid after the \hyperlink{class_ogre_1_1_font}{Font} has been loaded. 
\end{DoxyRemark}
\mbox{\Hypertarget{class_ogre_1_1_font_a354eac639a3afd4bfe797a208f6c90ce}\label{class_ogre_1_1_font_a354eac639a3afd4bfe797a208f6c90ce}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!get\+Material@{get\+Material}}
\index{get\+Material@{get\+Material}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{get\+Material()}{getMaterial()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily const \hyperlink{namespace_ogre_a57ef769e80226674c3971ce58b58c91d}{Material\+Ptr}\& Ogre\+::\+Font\+::get\+Material (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Gets the material generated for this font, as a weak reference. 

\begin{DoxyRemark}{Remarks}
This will only be valid after the \hyperlink{class_ogre_1_1_font}{Font} has been loaded. 
\end{DoxyRemark}
\mbox{\Hypertarget{class_ogre_1_1_font_a6ca4172a3f554f07752997b1a25278c0}\label{class_ogre_1_1_font_a6ca4172a3f554f07752997b1a25278c0}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!set\+Antialias\+Colour@{set\+Antialias\+Colour}}
\index{set\+Antialias\+Colour@{set\+Antialias\+Colour}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{set\+Antialias\+Colour()}{setAntialiasColour()}}
{\footnotesize\ttfamily void Ogre\+::\+Font\+::set\+Antialias\+Colour (\begin{DoxyParamCaption}\item[{bool}]{enabled }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Sets whether or not the colour of this font is antialiased as it is generated from a true type font. 

\begin{DoxyRemark}{Remarks}
This is valid only for a F\+T\+\_\+\+T\+R\+U\+E\+T\+Y\+PE font. If you are planning on using alpha blending to draw your font, then it is a good idea to set this to false (which is the default), otherwise the darkening of the font will combine with the fading out of the alpha around the edges and make your font look thinner than it should. However, if you intend to blend your font using a colour blending mode (add or modulate for example) then it\textquotesingle{}s a good idea to set this to true, in order to soften your font edges. 
\end{DoxyRemark}
\mbox{\Hypertarget{class_ogre_1_1_font_a278117d7414d69dbaed6e7290e842991}\label{class_ogre_1_1_font_a278117d7414d69dbaed6e7290e842991}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!get\+Antialias\+Colour@{get\+Antialias\+Colour}}
\index{get\+Antialias\+Colour@{get\+Antialias\+Colour}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{get\+Antialias\+Colour()}{getAntialiasColour()}}
{\footnotesize\ttfamily bool Ogre\+::\+Font\+::get\+Antialias\+Colour (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Gets whether or not the colour of this font is antialiased as it is generated from a true type font. 

\mbox{\Hypertarget{class_ogre_1_1_font_ad9fb35dcaf249ea1d86a3fe849422e2d}\label{class_ogre_1_1_font_ad9fb35dcaf249ea1d86a3fe849422e2d}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!load\+Resource@{load\+Resource}}
\index{load\+Resource@{load\+Resource}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{load\+Resource()}{loadResource()}}
{\footnotesize\ttfamily void Ogre\+::\+Font\+::load\+Resource (\begin{DoxyParamCaption}\item[{\hyperlink{class_ogre_1_1_resource}{Resource} $\ast$}]{resource }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Implementation of \hyperlink{class_ogre_1_1_manual_resource_loader_ae04795ab21e4a46709beb6d521a75c53}{Manual\+Resource\+Loader\+::load\+Resource}, called when the \hyperlink{class_ogre_1_1_texture}{Texture} that this font creates needs to (re)load. 



Implements \hyperlink{class_ogre_1_1_manual_resource_loader_ae04795ab21e4a46709beb6d521a75c53}{Ogre\+::\+Manual\+Resource\+Loader}.

\mbox{\Hypertarget{class_ogre_1_1_resource_a350b287fa3e83a389221274f68760008}\label{class_ogre_1_1_resource_a350b287fa3e83a389221274f68760008}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!prepare@{prepare}}
\index{prepare@{prepare}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{prepare()}{prepare()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Resource\+::prepare (\begin{DoxyParamCaption}\item[{bool}]{background\+Thread = {\ttfamily false} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}, {\ttfamily [inherited]}}



Prepares the resource for load, if it is not already. 

One can call \hyperlink{class_ogre_1_1_resource_a350b287fa3e83a389221274f68760008}{prepare()} before \hyperlink{class_ogre_1_1_resource_a699d1c851f494a8d5d23d23b695ceb47}{load()}, but this is not required as \hyperlink{class_ogre_1_1_resource_a699d1c851f494a8d5d23d23b695ceb47}{load()} will call \hyperlink{class_ogre_1_1_resource_a350b287fa3e83a389221274f68760008}{prepare()} itself, if needed. When O\+G\+R\+E\+\_\+\+T\+H\+R\+E\+A\+D\+\_\+\+S\+U\+P\+P\+O\+RT==1 both \hyperlink{class_ogre_1_1_resource_a699d1c851f494a8d5d23d23b695ceb47}{load()} and \hyperlink{class_ogre_1_1_resource_a350b287fa3e83a389221274f68760008}{prepare()} are thread-\/safe. When O\+G\+R\+E\+\_\+\+T\+H\+R\+E\+A\+D\+\_\+\+S\+U\+P\+P\+O\+RT==2 however, only \hyperlink{class_ogre_1_1_resource_a350b287fa3e83a389221274f68760008}{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 \hyperlink{class_ogre_1_1_resource_a350b287fa3e83a389221274f68760008}{prepare()} while the main render loop would later call \hyperlink{class_ogre_1_1_resource_a699d1c851f494a8d5d23d23b695ceb47}{load()}. So long as \hyperlink{class_ogre_1_1_resource_a350b287fa3e83a389221274f68760008}{prepare()} remains thread-\/safe, subclasses can arbitrarily split the work of loading a resource between \hyperlink{class_ogre_1_1_resource_a699d1c851f494a8d5d23d23b695ceb47}{load()} and \hyperlink{class_ogre_1_1_resource_a350b287fa3e83a389221274f68760008}{prepare()}. It is best to try and do as much work in \hyperlink{class_ogre_1_1_resource_a350b287fa3e83a389221274f68760008}{prepare()}, however, since this will leave less work for the main render thread to do and thus increase F\+PS. 
\begin{DoxyParams}{Parameters}
{\em background\+Thread} & Whether this is occurring in a background thread \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{class_ogre_1_1_resource_a699d1c851f494a8d5d23d23b695ceb47}\label{class_ogre_1_1_resource_a699d1c851f494a8d5d23d23b695ceb47}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!load@{load}}
\index{load@{load}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{load()}{load()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Resource\+::load (\begin{DoxyParamCaption}\item[{bool}]{background\+Thread = {\ttfamily false} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}, {\ttfamily [inherited]}}



Loads the resource, if it is not already. 

\begin{DoxyRemark}{Remarks}
If the resource is loaded from a file, loading is automatic. If not, if for example this resource gained it\textquotesingle{}s data from procedural calls rather than loading from a file, then this resource will not reload on it\textquotesingle{}s own. 
\end{DoxyRemark}

\begin{DoxyParams}{Parameters}
{\em background\+Thread} & Indicates whether the caller of this method is the background resource loading thread. \\
\hline
\end{DoxyParams}


Reimplemented in \hyperlink{class_ogre_1_1_unified_high_level_gpu_program_a39d8ef352a44619ef8cdd93e152c9b5c}{Ogre\+::\+Unified\+High\+Level\+Gpu\+Program}.

\mbox{\Hypertarget{class_ogre_1_1_resource_a5016aec1762b026997ddd346775879ef}\label{class_ogre_1_1_resource_a5016aec1762b026997ddd346775879ef}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!reload@{reload}}
\index{reload@{reload}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{reload()}{reload()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Resource\+::reload (\begin{DoxyParamCaption}\item[{\hyperlink{class_ogre_1_1_resource_a1aa750a4b994f2b1066220936cdfdb94}{Loading\+Flags}}]{flags = {\ttfamily \hyperlink{class_ogre_1_1_resource_a1aa750a4b994f2b1066220936cdfdb94ab49695ac949df3a7d2e2f9a03267097c}{L\+F\+\_\+\+D\+E\+F\+A\+U\+LT}} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}, {\ttfamily [inherited]}}



Reloads the resource, if it is already loaded. 

\begin{DoxyRemark}{Remarks}
Calls \hyperlink{class_ogre_1_1_resource_aa31bef1bfaa87731622e56f11b548e27}{unload()} and then \hyperlink{class_ogre_1_1_resource_a699d1c851f494a8d5d23d23b695ceb47}{load()} again, if the resource is already loaded. If it is not loaded already, then nothing happens. 
\end{DoxyRemark}


Reimplemented in \hyperlink{class_ogre_1_1_mesh_adca1dc667f145d4a4132811eaadf324f}{Ogre\+::\+Mesh}, and \hyperlink{class_ogre_1_1_unified_high_level_gpu_program_a33b2a090d63a597ee92343f4e7abe1d2}{Ogre\+::\+Unified\+High\+Level\+Gpu\+Program}.

\mbox{\Hypertarget{class_ogre_1_1_resource_a8eb34a9034aab62fd537c021a79e3366}\label{class_ogre_1_1_resource_a8eb34a9034aab62fd537c021a79e3366}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!is\+Reloadable@{is\+Reloadable}}
\index{is\+Reloadable@{is\+Reloadable}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{is\+Reloadable()}{isReloadable()}}
{\footnotesize\ttfamily virtual bool Ogre\+::\+Resource\+::is\+Reloadable (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}, {\ttfamily [inherited]}}



Returns true if the \hyperlink{class_ogre_1_1_resource}{Resource} is reloadable, false otherwise. 



Reimplemented in \hyperlink{class_ogre_1_1_unified_high_level_gpu_program_a957204efc949b9ad55562b9f8f4371f3}{Ogre\+::\+Unified\+High\+Level\+Gpu\+Program}.

\mbox{\Hypertarget{class_ogre_1_1_resource_a8f541900f7e1f73f4c313a732199029a}\label{class_ogre_1_1_resource_a8f541900f7e1f73f4c313a732199029a}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!is\+Manually\+Loaded@{is\+Manually\+Loaded}}
\index{is\+Manually\+Loaded@{is\+Manually\+Loaded}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{is\+Manually\+Loaded()}{isManuallyLoaded()}}
{\footnotesize\ttfamily virtual bool Ogre\+::\+Resource\+::is\+Manually\+Loaded (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}, {\ttfamily [inherited]}}



Is this resource manually loaded? 

\mbox{\Hypertarget{class_ogre_1_1_resource_aa31bef1bfaa87731622e56f11b548e27}\label{class_ogre_1_1_resource_aa31bef1bfaa87731622e56f11b548e27}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!unload@{unload}}
\index{unload@{unload}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{unload()}{unload()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Resource\+::unload (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}, {\ttfamily [inherited]}}



Unloads the resource; this is not permanent, the resource can be reloaded later if required. 



Reimplemented in \hyperlink{class_ogre_1_1_unified_high_level_gpu_program_aa2afd5199e4fb4f9e071bcc3b5805d52}{Ogre\+::\+Unified\+High\+Level\+Gpu\+Program}.

\mbox{\Hypertarget{class_ogre_1_1_resource_a0617d9f04ca03bd25f4bde201e6ac13b}\label{class_ogre_1_1_resource_a0617d9f04ca03bd25f4bde201e6ac13b}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!get\+Size@{get\+Size}}
\index{get\+Size@{get\+Size}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{get\+Size()}{getSize()}}
{\footnotesize\ttfamily virtual size\+\_\+t Ogre\+::\+Resource\+::get\+Size (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}, {\ttfamily [inherited]}}



Retrieves info about the size of the resource. 



Reimplemented in \hyperlink{class_ogre_1_1_cg_program_a65a86c6f911a8ac4b0c6d7366fb44f26}{Ogre\+::\+Cg\+Program}, and \hyperlink{class_ogre_1_1_unified_high_level_gpu_program_ad501229700788396f71417c19f4990ee}{Ogre\+::\+Unified\+High\+Level\+Gpu\+Program}.

\mbox{\Hypertarget{class_ogre_1_1_resource_ae229b1f58092109adef55bfc6f864d79}\label{class_ogre_1_1_resource_ae229b1f58092109adef55bfc6f864d79}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!touch@{touch}}
\index{touch@{touch}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{touch()}{touch()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Resource\+::touch (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}, {\ttfamily [inherited]}}



\textquotesingle{}Touches\textquotesingle{} the resource to indicate it has been used. 



Reimplemented in \hyperlink{class_ogre_1_1_material_a340e9c6140a5b0f3467596712aa122a9}{Ogre\+::\+Material}, \hyperlink{class_ogre_1_1_cg_program_aa448e3603f9f6cad8cfe40818888227a}{Ogre\+::\+Cg\+Program}, and \hyperlink{class_ogre_1_1_unified_high_level_gpu_program_a682949c30fe1718d4514b25df77774c2}{Ogre\+::\+Unified\+High\+Level\+Gpu\+Program}.



Referenced by Ogre\+::\+Material\+::touch().

\mbox{\Hypertarget{class_ogre_1_1_resource_a0646fba8aa0242c6b389d73f47ebe41b}\label{class_ogre_1_1_resource_a0646fba8aa0242c6b389d73f47ebe41b}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!get\+Name@{get\+Name}}
\index{get\+Name@{get\+Name}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{get\+Name()}{getName()}}
{\footnotesize\ttfamily virtual const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}\& Ogre\+::\+Resource\+::get\+Name (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}, {\ttfamily [inherited]}}



Gets resource name. 



Reimplemented in \hyperlink{class_ogre_1_1_skeleton_instance_a7a09701fea2d613b196932b1227dab47}{Ogre\+::\+Skeleton\+Instance}.



Referenced by Ogre\+::\+Gpu\+Program\+Usage\+::get\+Program\+Name(), and Ogre\+Bites\+::\+Tray\+Manager\+::resource\+Load\+Started().

\mbox{\Hypertarget{class_ogre_1_1_resource_a2298551707debaf774d577e643ee856a}\label{class_ogre_1_1_resource_a2298551707debaf774d577e643ee856a}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!get\+Handle@{get\+Handle}}
\index{get\+Handle@{get\+Handle}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{get\+Handle()}{getHandle()}}
{\footnotesize\ttfamily virtual \hyperlink{namespace_ogre_aeb9f62c8e6c4239315286c63321722b2}{Resource\+Handle} Ogre\+::\+Resource\+::get\+Handle (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}, {\ttfamily [inherited]}}



Reimplemented in \hyperlink{class_ogre_1_1_skeleton_instance_ae6e32b49e6ec3cc795fc74a41eb379ad}{Ogre\+::\+Skeleton\+Instance}.

\mbox{\Hypertarget{class_ogre_1_1_resource_a0779c46df96234b6619a5f57fbb36078}\label{class_ogre_1_1_resource_a0779c46df96234b6619a5f57fbb36078}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!is\+Prepared@{is\+Prepared}}
\index{is\+Prepared@{is\+Prepared}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{is\+Prepared()}{isPrepared()}}
{\footnotesize\ttfamily virtual bool Ogre\+::\+Resource\+::is\+Prepared (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}, {\ttfamily [inherited]}}



Returns true if the \hyperlink{class_ogre_1_1_resource}{Resource} has been prepared, false otherwise. 

\mbox{\Hypertarget{class_ogre_1_1_resource_a74138c0203835513613af73cdb08890d}\label{class_ogre_1_1_resource_a74138c0203835513613af73cdb08890d}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!is\+Loaded@{is\+Loaded}}
\index{is\+Loaded@{is\+Loaded}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{is\+Loaded()}{isLoaded()}}
{\footnotesize\ttfamily virtual bool Ogre\+::\+Resource\+::is\+Loaded (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}, {\ttfamily [inherited]}}



Returns true if the \hyperlink{class_ogre_1_1_resource}{Resource} has been loaded, false otherwise. 



Reimplemented in \hyperlink{class_ogre_1_1_unified_high_level_gpu_program_ac8bfe1f64106637c89ab949dc2d6c59d}{Ogre\+::\+Unified\+High\+Level\+Gpu\+Program}.

\mbox{\Hypertarget{class_ogre_1_1_resource_a3af26f716731b64850ea50cfa4d2edef}\label{class_ogre_1_1_resource_a3af26f716731b64850ea50cfa4d2edef}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!is\+Loading@{is\+Loading}}
\index{is\+Loading@{is\+Loading}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{is\+Loading()}{isLoading()}}
{\footnotesize\ttfamily virtual bool Ogre\+::\+Resource\+::is\+Loading (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}, {\ttfamily [inherited]}}



Returns whether the resource is currently in the process of background loading. 



Reimplemented in \hyperlink{class_ogre_1_1_unified_high_level_gpu_program_a9f416e82992b3803108a52bd9460cfdf}{Ogre\+::\+Unified\+High\+Level\+Gpu\+Program}.

\mbox{\Hypertarget{class_ogre_1_1_resource_a1e90ade99935ef70ec5b199243bf995b}\label{class_ogre_1_1_resource_a1e90ade99935ef70ec5b199243bf995b}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!get\+Loading\+State@{get\+Loading\+State}}
\index{get\+Loading\+State@{get\+Loading\+State}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{get\+Loading\+State()}{getLoadingState()}}
{\footnotesize\ttfamily virtual \hyperlink{class_ogre_1_1_resource_a07e619aa09d3bc6789a6667cb4fc572c}{Loading\+State} Ogre\+::\+Resource\+::get\+Loading\+State (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}, {\ttfamily [inherited]}}



Returns the current loading state. 



Reimplemented in \hyperlink{class_ogre_1_1_unified_high_level_gpu_program_aa5cb2174294127eefbd4b6343c8107d8}{Ogre\+::\+Unified\+High\+Level\+Gpu\+Program}.

\mbox{\Hypertarget{class_ogre_1_1_resource_a60ce96525ac730a0f7b466ed287beef3}\label{class_ogre_1_1_resource_a60ce96525ac730a0f7b466ed287beef3}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!is\+Background\+Loaded@{is\+Background\+Loaded}}
\index{is\+Background\+Loaded@{is\+Background\+Loaded}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{is\+Background\+Loaded()}{isBackgroundLoaded()}}
{\footnotesize\ttfamily virtual bool Ogre\+::\+Resource\+::is\+Background\+Loaded (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}, {\ttfamily [inherited]}}



Returns whether this \hyperlink{class_ogre_1_1_resource}{Resource} has been earmarked for background loading. 

\begin{DoxyRemark}{Remarks}
This option only makes sense when you have built \hyperlink{namespace_ogre}{Ogre} with thread support (O\+G\+R\+E\+\_\+\+T\+H\+R\+E\+A\+D\+\_\+\+S\+U\+P\+P\+O\+RT). If a resource has been marked for background loading, then it won\textquotesingle{}t load on demand like normal when \hyperlink{class_ogre_1_1_resource_a699d1c851f494a8d5d23d23b695ceb47}{load()} is called. Instead, it will ignore request to \hyperlink{class_ogre_1_1_resource_a699d1c851f494a8d5d23d23b695ceb47}{load()} except if the caller indicates it is the background loader. \hyperlink{class_ogre_1_1_any}{Any} other users of this resource should check \hyperlink{class_ogre_1_1_resource_a74138c0203835513613af73cdb08890d}{is\+Loaded()}, and if that returns false, don\textquotesingle{}t use the resource and come back later. 
\end{DoxyRemark}


Reimplemented in \hyperlink{class_ogre_1_1_unified_high_level_gpu_program_a43c95218aea772dc8ff85b2dd65b8b26}{Ogre\+::\+Unified\+High\+Level\+Gpu\+Program}.

\mbox{\Hypertarget{class_ogre_1_1_resource_ae0a0007de944eb3c2f933a372a752b35}\label{class_ogre_1_1_resource_ae0a0007de944eb3c2f933a372a752b35}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!set\+Background\+Loaded@{set\+Background\+Loaded}}
\index{set\+Background\+Loaded@{set\+Background\+Loaded}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{set\+Background\+Loaded()}{setBackgroundLoaded()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Resource\+::set\+Background\+Loaded (\begin{DoxyParamCaption}\item[{bool}]{bl }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}, {\ttfamily [inherited]}}



Tells the resource whether it is background loaded or not. 

\begin{DoxySeeAlso}{See also}
\hyperlink{class_ogre_1_1_resource_a60ce96525ac730a0f7b466ed287beef3}{Resource\+::is\+Background\+Loaded}. Note that calling this only defers the normal on-\/demand loading behaviour of a resource, it does not actually \hyperlink{struct_ogre_1_1set}{set} up a thread to make sure the resource gets loaded in the background. You should use Resource\+Background\+Loading\+Queue to manage the actual loading (which will call this method itself). 
\end{DoxySeeAlso}


Reimplemented in \hyperlink{class_ogre_1_1_unified_high_level_gpu_program_adba65f42995100300f2983555f7214cc}{Ogre\+::\+Unified\+High\+Level\+Gpu\+Program}.

\mbox{\Hypertarget{class_ogre_1_1_resource_a367f6fe60bb211cb4c32e3825ca67e4c}\label{class_ogre_1_1_resource_a367f6fe60bb211cb4c32e3825ca67e4c}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!escalate\+Loading@{escalate\+Loading}}
\index{escalate\+Loading@{escalate\+Loading}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{escalate\+Loading()}{escalateLoading()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Resource\+::escalate\+Loading (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}, {\ttfamily [inherited]}}



Escalates the loading of a background loaded resource. 

\begin{DoxyRemark}{Remarks}
If a resource is set to load in the background, but something needs it before it\textquotesingle{}s been loaded, there could be a problem. If the user of this resource really can\textquotesingle{}t wait, they can escalate the loading which basically pulls the loading into the current thread immediately. If the resource is already being loaded but just hasn\textquotesingle{}t quite finished then this method will simply wait until the background load is complete. 
\end{DoxyRemark}


Reimplemented in \hyperlink{class_ogre_1_1_unified_high_level_gpu_program_a8b5b9e6fec77dfc8d7fde8eb8bf07dd9}{Ogre\+::\+Unified\+High\+Level\+Gpu\+Program}.

\mbox{\Hypertarget{class_ogre_1_1_resource_a5513ffce404b14cff72846318b018d32}\label{class_ogre_1_1_resource_a5513ffce404b14cff72846318b018d32}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!add\+Listener@{add\+Listener}}
\index{add\+Listener@{add\+Listener}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{add\+Listener()}{addListener()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Resource\+::add\+Listener (\begin{DoxyParamCaption}\item[{\hyperlink{class_ogre_1_1_resource_1_1_listener}{Listener} $\ast$}]{lis }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}, {\ttfamily [inherited]}}



Register a listener on this resource. 

\begin{DoxySeeAlso}{See also}
\hyperlink{class_ogre_1_1_resource_1_1_listener}{Resource\+::\+Listener} 
\end{DoxySeeAlso}


Reimplemented in \hyperlink{class_ogre_1_1_unified_high_level_gpu_program_aedc4baffb56b8c6dce5bcfa80bc869fd}{Ogre\+::\+Unified\+High\+Level\+Gpu\+Program}.

\mbox{\Hypertarget{class_ogre_1_1_resource_a3c49142f739ba8fb56d6e7b3db235fb7}\label{class_ogre_1_1_resource_a3c49142f739ba8fb56d6e7b3db235fb7}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!remove\+Listener@{remove\+Listener}}
\index{remove\+Listener@{remove\+Listener}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{remove\+Listener()}{removeListener()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Resource\+::remove\+Listener (\begin{DoxyParamCaption}\item[{\hyperlink{class_ogre_1_1_resource_1_1_listener}{Listener} $\ast$}]{lis }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}, {\ttfamily [inherited]}}



Remove a listener on this resource. 

\begin{DoxySeeAlso}{See also}
\hyperlink{class_ogre_1_1_resource_1_1_listener}{Resource\+::\+Listener} 
\end{DoxySeeAlso}


Reimplemented in \hyperlink{class_ogre_1_1_unified_high_level_gpu_program_ae4bdd44833d44f794e420d87ea529346}{Ogre\+::\+Unified\+High\+Level\+Gpu\+Program}.

\mbox{\Hypertarget{class_ogre_1_1_resource_a382919945c07a6a13136889ad3fbf578}\label{class_ogre_1_1_resource_a382919945c07a6a13136889ad3fbf578}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!get\+Group@{get\+Group}}
\index{get\+Group@{get\+Group}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{get\+Group()}{getGroup()}}
{\footnotesize\ttfamily virtual const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}\& Ogre\+::\+Resource\+::get\+Group (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}, {\ttfamily [inherited]}}



Gets the group which this resource is a member of. 



Reimplemented in \hyperlink{class_ogre_1_1_skeleton_instance_a99b3a28bfb04ed9c75952c663515fc35}{Ogre\+::\+Skeleton\+Instance}.

\mbox{\Hypertarget{class_ogre_1_1_resource_aa5d6f3f7e73b77b233fc62b11f270e4d}\label{class_ogre_1_1_resource_aa5d6f3f7e73b77b233fc62b11f270e4d}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!change\+Group\+Ownership@{change\+Group\+Ownership}}
\index{change\+Group\+Ownership@{change\+Group\+Ownership}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{change\+Group\+Ownership()}{changeGroupOwnership()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Resource\+::change\+Group\+Ownership (\begin{DoxyParamCaption}\item[{const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&}]{new\+Group }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}, {\ttfamily [inherited]}}



Change the resource group ownership of a \hyperlink{class_ogre_1_1_resource}{Resource}. 

\begin{DoxyRemark}{Remarks}
This method is generally reserved for internal use, although if you really know what you\textquotesingle{}re doing you can use it to move this resource from one group to another. 
\end{DoxyRemark}

\begin{DoxyParams}{Parameters}
{\em new\+Group} & Name of the new group \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{class_ogre_1_1_resource_ab6e377a3964d566ea112fe63bf1d7678}\label{class_ogre_1_1_resource_ab6e377a3964d566ea112fe63bf1d7678}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!get\+Creator@{get\+Creator}}
\index{get\+Creator@{get\+Creator}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{get\+Creator()}{getCreator()}}
{\footnotesize\ttfamily \hyperlink{class_ogre_1_1_resource_manager}{Resource\+Manager}$\ast$ Ogre\+::\+Resource\+::get\+Creator (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [inherited]}}



Gets the manager which created this resource. 

\mbox{\Hypertarget{class_ogre_1_1_resource_a13423fa7944d7f2339e78b9de026c3be}\label{class_ogre_1_1_resource_a13423fa7944d7f2339e78b9de026c3be}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!get\+Origin@{get\+Origin}}
\index{get\+Origin@{get\+Origin}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{get\+Origin()}{getOrigin()}}
{\footnotesize\ttfamily const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}\& Ogre\+::\+Resource\+::get\+Origin (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [inherited]}}



Get the origin of this resource, e.\+g. 

a script file name. \begin{DoxyRemark}{Remarks}
This property will only contain something if the creator of this resource chose to populate it. Script loaders are advised to populate it. 
\end{DoxyRemark}
\mbox{\Hypertarget{class_ogre_1_1_resource_a7e248a1cca0662418d4ab3f63c2e7cf6}\label{class_ogre_1_1_resource_a7e248a1cca0662418d4ab3f63c2e7cf6}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!\+\_\+notify\+Origin@{\+\_\+notify\+Origin}}
\index{\+\_\+notify\+Origin@{\+\_\+notify\+Origin}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{\+\_\+notify\+Origin()}{\_notifyOrigin()}}
{\footnotesize\ttfamily void Ogre\+::\+Resource\+::\+\_\+notify\+Origin (\begin{DoxyParamCaption}\item[{const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&}]{origin }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [inherited]}}



Notify this resource of it\textquotesingle{}s origin. 

\mbox{\Hypertarget{class_ogre_1_1_resource_ade85e4d5579519e4117a84789c0ae8fd}\label{class_ogre_1_1_resource_ade85e4d5579519e4117a84789c0ae8fd}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!get\+State\+Count@{get\+State\+Count}}
\index{get\+State\+Count@{get\+State\+Count}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{get\+State\+Count()}{getStateCount()}}
{\footnotesize\ttfamily virtual size\+\_\+t Ogre\+::\+Resource\+::get\+State\+Count (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}, {\ttfamily [inherited]}}



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. \mbox{\Hypertarget{class_ogre_1_1_resource_afcb4a61b965600a67ca2c2f060821db9}\label{class_ogre_1_1_resource_afcb4a61b965600a67ca2c2f060821db9}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!\+\_\+dirty\+State@{\+\_\+dirty\+State}}
\index{\+\_\+dirty\+State@{\+\_\+dirty\+State}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{\+\_\+dirty\+State()}{\_dirtyState()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Resource\+::\+\_\+dirty\+State (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}, {\ttfamily [inherited]}}



Manually mark the state of this resource as having been changed. 

\begin{DoxyRemark}{Remarks}
You only need to call this from outside if you explicitly want derived objects to think this object has changed. 
\end{DoxyRemark}
\begin{DoxySeeAlso}{See also}
\hyperlink{class_ogre_1_1_resource_ade85e4d5579519e4117a84789c0ae8fd}{get\+State\+Count}. 
\end{DoxySeeAlso}
\mbox{\Hypertarget{class_ogre_1_1_resource_aa68664db6b8723dc198beef3d21d4ef5}\label{class_ogre_1_1_resource_aa68664db6b8723dc198beef3d21d4ef5}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!\+\_\+fire\+Loading\+Complete@{\+\_\+fire\+Loading\+Complete}}
\index{\+\_\+fire\+Loading\+Complete@{\+\_\+fire\+Loading\+Complete}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{\+\_\+fire\+Loading\+Complete()}{\_fireLoadingComplete()}}
{\footnotesize\ttfamily void Ogre\+::\+Resource\+::\+\_\+fire\+Loading\+Complete (\begin{DoxyParamCaption}\item[{bool}]{was\+Background\+Loaded }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inherited]}}



Firing of loading complete event. 

\begin{DoxyRemark}{Remarks}
You should call this from the thread that runs the main frame loop to avoid having to make the receivers of this event thread-\/safe. If you use \hyperlink{namespace_ogre}{Ogre}\textquotesingle{}s built in frame loop you don\textquotesingle{}t need to call this yourself. 
\end{DoxyRemark}

\begin{DoxyParams}{Parameters}
{\em was\+Background\+Loaded} & Whether this was a background loaded event \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{class_ogre_1_1_resource_aaf63d096584ac7d97fe1d1b0226c9561}\label{class_ogre_1_1_resource_aaf63d096584ac7d97fe1d1b0226c9561}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!\+\_\+fire\+Preparing\+Complete@{\+\_\+fire\+Preparing\+Complete}}
\index{\+\_\+fire\+Preparing\+Complete@{\+\_\+fire\+Preparing\+Complete}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{\+\_\+fire\+Preparing\+Complete()}{\_firePreparingComplete()}}
{\footnotesize\ttfamily void Ogre\+::\+Resource\+::\+\_\+fire\+Preparing\+Complete (\begin{DoxyParamCaption}\item[{bool}]{was\+Background\+Loaded }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inherited]}}



Firing of preparing complete event. 

\begin{DoxyRemark}{Remarks}
You should call this from the thread that runs the main frame loop to avoid having to make the receivers of this event thread-\/safe. If you use \hyperlink{namespace_ogre}{Ogre}\textquotesingle{}s built in frame loop you don\textquotesingle{}t need to call this yourself. 
\end{DoxyRemark}

\begin{DoxyParams}{Parameters}
{\em was\+Background\+Loaded} & Whether this was a background loaded event \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{class_ogre_1_1_resource_aaf3746937cd11864f53bc1c3b4437541}\label{class_ogre_1_1_resource_aaf3746937cd11864f53bc1c3b4437541}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!\+\_\+fire\+Unloading\+Complete@{\+\_\+fire\+Unloading\+Complete}}
\index{\+\_\+fire\+Unloading\+Complete@{\+\_\+fire\+Unloading\+Complete}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{\+\_\+fire\+Unloading\+Complete()}{\_fireUnloadingComplete()}}
{\footnotesize\ttfamily void Ogre\+::\+Resource\+::\+\_\+fire\+Unloading\+Complete (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inherited]}}



Firing of unloading complete event. 

\begin{DoxyRemark}{Remarks}
You should call this from the thread that runs the main frame loop to avoid having to make the receivers of this event thread-\/safe. If you use \hyperlink{namespace_ogre}{Ogre}\textquotesingle{}s built in frame loop you don\textquotesingle{}t need to call this yourself. 
\end{DoxyRemark}
\mbox{\Hypertarget{class_ogre_1_1_string_interface_ae3e13925bde11db245f6c9bbf5031a93}\label{class_ogre_1_1_string_interface_ae3e13925bde11db245f6c9bbf5031a93}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!get\+Param\+Dictionary@{get\+Param\+Dictionary}}
\index{get\+Param\+Dictionary@{get\+Param\+Dictionary}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{get\+Param\+Dictionary()}{getParamDictionary()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily \hyperlink{class_ogre_1_1_param_dictionary}{Param\+Dictionary}$\ast$ Ogre\+::\+String\+Interface\+::get\+Param\+Dictionary (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [inherited]}}



Retrieves the parameter dictionary for this class. 

\begin{DoxyRemark}{Remarks}
Only valid to call this after create\+Param\+Dictionary. 
\end{DoxyRemark}
\begin{DoxyReturn}{Returns}
Pointer to \hyperlink{class_ogre_1_1_param_dictionary}{Param\+Dictionary} shared by all instances of this class which you can add parameters to, retrieve parameters etc. 
\end{DoxyReturn}
\mbox{\Hypertarget{class_ogre_1_1_string_interface_a0f55da0550a7e1ab70a1c8bf598a3e20}\label{class_ogre_1_1_string_interface_a0f55da0550a7e1ab70a1c8bf598a3e20}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!get\+Param\+Dictionary@{get\+Param\+Dictionary}}
\index{get\+Param\+Dictionary@{get\+Param\+Dictionary}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{get\+Param\+Dictionary()}{getParamDictionary()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily const \hyperlink{class_ogre_1_1_param_dictionary}{Param\+Dictionary}$\ast$ Ogre\+::\+String\+Interface\+::get\+Param\+Dictionary (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [inherited]}}

\mbox{\Hypertarget{class_ogre_1_1_string_interface_ad4b984bfbf148ddb3310b3d0ba8a9d5d}\label{class_ogre_1_1_string_interface_ad4b984bfbf148ddb3310b3d0ba8a9d5d}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!get\+Parameters@{get\+Parameters}}
\index{get\+Parameters@{get\+Parameters}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{get\+Parameters()}{getParameters()}}
{\footnotesize\ttfamily const \hyperlink{group___general_ga1838c2b0619ade1f5e29767062212872}{Parameter\+List}\& Ogre\+::\+String\+Interface\+::get\+Parameters (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inherited]}}



Retrieves a list of parameters valid for this object. 

\begin{DoxyReturn}{Returns}
A reference to a static list of \hyperlink{class_ogre_1_1_parameter_def}{Parameter\+Def} objects. 
\end{DoxyReturn}
\mbox{\Hypertarget{class_ogre_1_1_string_interface_a08d117bf25f011f96d81f1f4ecb25113}\label{class_ogre_1_1_string_interface_a08d117bf25f011f96d81f1f4ecb25113}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!set\+Parameter@{set\+Parameter}}
\index{set\+Parameter@{set\+Parameter}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{set\+Parameter()}{setParameter()}}
{\footnotesize\ttfamily bool Ogre\+::\+String\+Interface\+::set\+Parameter (\begin{DoxyParamCaption}\item[{const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&}]{name,  }\item[{const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&}]{value }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inherited]}}



Generic parameter setting method. 

\begin{DoxyRemark}{Remarks}
Call this method with the name of a parameter and a string version of the value to set. The implementor will convert the string to a native type internally. If in doubt, check the parameter definition in the list returned from \hyperlink{class_ogre_1_1_string_interface_ad4b984bfbf148ddb3310b3d0ba8a9d5d}{String\+Interface\+::get\+Parameters}. 
\end{DoxyRemark}

\begin{DoxyParams}{Parameters}
{\em name} & The name of the parameter to set \\
\hline
{\em value} & String value. Must be in the right format for the type specified in the parameter definition. See the \hyperlink{class_ogre_1_1_string_converter}{String\+Converter} class for more information. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
true if set was successful, false otherwise (NB no exceptions thrown -\/ tolerant method) 
\end{DoxyReturn}


Referenced by Ogre\+::\+String\+Interface\+::copy\+Parameters\+To().

\mbox{\Hypertarget{class_ogre_1_1_string_interface_a9aac32f93bd149a34b809a57a9f01f8f}\label{class_ogre_1_1_string_interface_a9aac32f93bd149a34b809a57a9f01f8f}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!set\+Parameter\+List@{set\+Parameter\+List}}
\index{set\+Parameter\+List@{set\+Parameter\+List}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{set\+Parameter\+List()}{setParameterList()}}
{\footnotesize\ttfamily void Ogre\+::\+String\+Interface\+::set\+Parameter\+List (\begin{DoxyParamCaption}\item[{const \hyperlink{group___general_ga0537f38d7a77fcbe9f600f6ed8a926d6}{Name\+Value\+Pair\+List} \&}]{param\+List }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inherited]}}



Generic multiple parameter setting method. 

\begin{DoxyRemark}{Remarks}
Call this method with a list of name / value pairs to set. The implementor will convert the string to a native type internally. If in doubt, check the parameter definition in the list returned from \hyperlink{class_ogre_1_1_string_interface_ad4b984bfbf148ddb3310b3d0ba8a9d5d}{String\+Interface\+::get\+Parameters}. 
\end{DoxyRemark}

\begin{DoxyParams}{Parameters}
{\em param\+List} & Name/value pair list \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{class_ogre_1_1_string_interface_a1d078304c38a9f85d483fc8ed0cdf1fe}\label{class_ogre_1_1_string_interface_a1d078304c38a9f85d483fc8ed0cdf1fe}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!get\+Parameter@{get\+Parameter}}
\index{get\+Parameter@{get\+Parameter}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{get\+Parameter()}{getParameter()}}
{\footnotesize\ttfamily \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} Ogre\+::\+String\+Interface\+::get\+Parameter (\begin{DoxyParamCaption}\item[{const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&}]{name }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [inherited]}}



Generic parameter retrieval method. 

\begin{DoxyRemark}{Remarks}
Call this method with the name of a parameter to retrieve a string-\/format value of the parameter in question. If in doubt, check the parameter definition in the list returned from get\+Parameters for the type of this parameter. If you like you can use \hyperlink{class_ogre_1_1_string_converter}{String\+Converter} to convert this string back into a native type. 
\end{DoxyRemark}

\begin{DoxyParams}{Parameters}
{\em name} & The name of the parameter to get \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
String value of parameter, blank if not found 
\end{DoxyReturn}


References Ogre\+::\+Param\+Command\+::do\+Get().

\mbox{\Hypertarget{class_ogre_1_1_string_interface_aad68d8b18faad14e8286a67527094654}\label{class_ogre_1_1_string_interface_aad68d8b18faad14e8286a67527094654}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!copy\+Parameters\+To@{copy\+Parameters\+To}}
\index{copy\+Parameters\+To@{copy\+Parameters\+To}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{copy\+Parameters\+To()}{copyParametersTo()}}
{\footnotesize\ttfamily void Ogre\+::\+String\+Interface\+::copy\+Parameters\+To (\begin{DoxyParamCaption}\item[{\hyperlink{class_ogre_1_1_string_interface}{String\+Interface} $\ast$}]{dest }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [inherited]}}



Method for copying this object\textquotesingle{}s parameters to another object. 

\begin{DoxyRemark}{Remarks}
This method takes the values of all the object\textquotesingle{}s parameters and tries to set the same values on the destination object. This provides a completely type independent way to copy parameters to other objects. Note that because of the String manipulation involved, this should not be regarded as an efficient process and should be saved for times outside of the rendering loop. 
\end{DoxyRemark}
\begin{DoxyParagraph}{}
\hyperlink{class_ogre_1_1_any}{Any} unrecognised parameters will be ignored as with set\+Parameter method. 
\end{DoxyParagraph}

\begin{DoxyParams}{Parameters}
{\em dest} & Pointer to object to have it\textquotesingle{}s parameters set the same as this object. \\
\hline
\end{DoxyParams}


References Ogre\+::\+String\+Interface\+::set\+Parameter().

\mbox{\Hypertarget{class_ogre_1_1_string_interface_a1bea65fa2b3c2ac5a9f3be59b46a80e8}\label{class_ogre_1_1_string_interface_a1bea65fa2b3c2ac5a9f3be59b46a80e8}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!cleanup\+Dictionary@{cleanup\+Dictionary}}
\index{cleanup\+Dictionary@{cleanup\+Dictionary}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{cleanup\+Dictionary()}{cleanupDictionary()}}
{\footnotesize\ttfamily static void Ogre\+::\+String\+Interface\+::cleanup\+Dictionary (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [static]}, {\ttfamily [inherited]}}



Cleans up the static \textquotesingle{}ms\+Dictionary\textquotesingle{} required to reset \hyperlink{namespace_ogre}{Ogre}, otherwise the containers are left with invalid pointers, which will lead to a crash as soon as one of the \hyperlink{class_ogre_1_1_resource_manager}{Resource\+Manager} implementers (e.\+g. 

\hyperlink{class_ogre_1_1_material_manager}{Material\+Manager}) initializes. \mbox{\Hypertarget{class_ogre_1_1_manual_resource_loader_a7b4afd007622d165efbcc362e5566922}\label{class_ogre_1_1_manual_resource_loader_a7b4afd007622d165efbcc362e5566922}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!prepare\+Resource@{prepare\+Resource}}
\index{prepare\+Resource@{prepare\+Resource}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{prepare\+Resource()}{prepareResource()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Manual\+Resource\+Loader\+::prepare\+Resource (\begin{DoxyParamCaption}\item[{\hyperlink{class_ogre_1_1_resource}{Resource} $\ast$}]{resource }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}, {\ttfamily [inherited]}}



Called when a resource wishes to load. 

Note that this could get called in a background thread even in just a semithreaded ogre (O\+G\+R\+E\+\_\+\+T\+H\+R\+E\+A\+D\+\_\+\+S\+U\+P\+P\+O\+RT==2). Thus, you must not access the rendersystem from this callback. Do that stuff in load\+Resource. 
\begin{DoxyParams}{Parameters}
{\em resource} & The resource which wishes to load \\
\hline
\end{DoxyParams}


\subsection{Member Data Documentation}
\mbox{\Hypertarget{class_ogre_1_1_resource_a104d9db8bfcff1f37b29157bbe070f7a}\label{class_ogre_1_1_resource_a104d9db8bfcff1f37b29157bbe070f7a}} 
\index{Ogre\+::\+Font@{Ogre\+::\+Font}!O\+G\+R\+E\+\_\+\+A\+U\+T\+O\+\_\+\+M\+U\+T\+EX@{O\+G\+R\+E\+\_\+\+A\+U\+T\+O\+\_\+\+M\+U\+T\+EX}}
\index{O\+G\+R\+E\+\_\+\+A\+U\+T\+O\+\_\+\+M\+U\+T\+EX@{O\+G\+R\+E\+\_\+\+A\+U\+T\+O\+\_\+\+M\+U\+T\+EX}!Ogre\+::\+Font@{Ogre\+::\+Font}}
\subsubsection{\texorpdfstring{O\+G\+R\+E\+\_\+\+A\+U\+T\+O\+\_\+\+M\+U\+T\+EX}{OGRE\_AUTO\_MUTEX}}
{\footnotesize\ttfamily Ogre\+::\+Resource\+::\+O\+G\+R\+E\+\_\+\+A\+U\+T\+O\+\_\+\+M\+U\+T\+EX\hspace{0.3cm}{\ttfamily [inherited]}}



The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
\item 
\hyperlink{_ogre_font_8h}{Ogre\+Font.\+h}\end{DoxyCompactItemize}
