\hypertarget{struct_ogre_1_1_gpu_named_constants}{}\doxysection{Ogre\+::Gpu\+Named\+Constants Struct Reference}
\label{struct_ogre_1_1_gpu_named_constants}\index{Ogre::GpuNamedConstants@{Ogre::GpuNamedConstants}}


Struct collecting together the information for named constants.  




{\ttfamily \#include $<$Ogre\+Gpu\+Program\+Params.\+h$>$}



Inheritance diagram for Ogre\+::Gpu\+Named\+Constants\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=229pt]{struct_ogre_1_1_gpu_named_constants__inherit__graph}
\end{center}
\end{figure}
\doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{struct_ogre_1_1_gpu_named_constants_ac0e05654af490172ac33e0248198c5fb}{Gpu\+Named\+Constants}} ()
\item 
size\+\_\+t \mbox{\hyperlink{struct_ogre_1_1_gpu_named_constants_a8ea5fa125ab0e44fdf04b6261d938835}{calculate\+Size}} (void) const
\item 
void \mbox{\hyperlink{struct_ogre_1_1_gpu_named_constants_ad1a16f8fe55b903b77c62a5d28387d21}{generate\+Constant\+Definition\+Array\+Entries}} (const \mbox{\hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}} \&param\+Name, const \mbox{\hyperlink{struct_ogre_1_1_gpu_constant_definition}{Gpu\+Constant\+Definition}} \&base\+Def)
\begin{DoxyCompactList}\small\item\em Generate additional constant entries for arrays based on a base definition. \end{DoxyCompactList}\item 
void \mbox{\hyperlink{struct_ogre_1_1_gpu_named_constants_a8c49c555a0e99a99dee1e99d0450578b}{load}} (\mbox{\hyperlink{namespace_ogre_a8a2a961b4205aacff9c01e81e08d7781}{Data\+Stream\+Ptr}} \&stream)
\begin{DoxyCompactList}\small\item\em Loads constant definitions from a stream, compatible with \mbox{\hyperlink{class_ogre_1_1_gpu_program_af420c447afb13728b4ddfcb8d8d7d812}{Gpu\+Program\+::set\+Manual\+Named\+Constants\+File}}. \end{DoxyCompactList}\item 
void \mbox{\hyperlink{struct_ogre_1_1_gpu_named_constants_a4ce0c92c117f2c7dd91acf697821ef67}{save}} (const \mbox{\hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}} \&filename) const
\begin{DoxyCompactList}\small\item\em Saves constant definitions to a file, compatible with \mbox{\hyperlink{class_ogre_1_1_gpu_program_af420c447afb13728b4ddfcb8d8d7d812}{Gpu\+Program\+::set\+Manual\+Named\+Constants\+File}}. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection*{Static Public Member Functions}
\begin{DoxyCompactItemize}
\item 
static bool \mbox{\hyperlink{struct_ogre_1_1_gpu_named_constants_a3e1e7178a176a8e12e9e7491187885de}{get\+Generate\+All\+Constant\+Definition\+Array\+Entries}} ()
\begin{DoxyCompactList}\small\item\em Indicates whether all array entries will be generated and added to the definitions map. \end{DoxyCompactList}\item 
static void \mbox{\hyperlink{struct_ogre_1_1_gpu_named_constants_a262a2eea37cc3b2ef0973a625f624ff0}{set\+Generate\+All\+Constant\+Definition\+Array\+Entries}} (bool generate\+All)
\begin{DoxyCompactList}\small\item\em Sets whether all array entries will be generated and added to the definitions map. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection*{Public Attributes}
\begin{DoxyCompactItemize}
\item 
size\+\_\+t \mbox{\hyperlink{struct_ogre_1_1_gpu_named_constants_a752c361f1d2b41e6ef26092c5d248477}{double\+Buffer\+Size}}
\begin{DoxyCompactList}\small\item\em Total size of the double buffer required. \end{DoxyCompactList}\item 
size\+\_\+t \mbox{\hyperlink{struct_ogre_1_1_gpu_named_constants_a5558247a535928116d99c17fdbb4de6f}{float\+Buffer\+Size}}
\begin{DoxyCompactList}\small\item\em Total size of the float buffer required. \end{DoxyCompactList}\item 
size\+\_\+t \mbox{\hyperlink{struct_ogre_1_1_gpu_named_constants_a6989ab89780218c87936c55c96586a5b}{int\+Buffer\+Size}}
\begin{DoxyCompactList}\small\item\em Total size of the int buffer required. \end{DoxyCompactList}\item 
\mbox{\hyperlink{group___materials_gae4823c1377e5d4c312a3da9d1cb8534a}{Gpu\+Constant\+Definition\+Map}} \mbox{\hyperlink{struct_ogre_1_1_gpu_named_constants_af35adecba174a620edfea7ff95ad3a7e}{map}}
\begin{DoxyCompactList}\small\item\em Map of parameter names to \mbox{\hyperlink{struct_ogre_1_1_gpu_constant_definition}{Gpu\+Constant\+Definition}}. \end{DoxyCompactList}\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
Struct collecting together the information for named constants. 

\doxysubsection{Constructor \& Destructor Documentation}
\mbox{\Hypertarget{struct_ogre_1_1_gpu_named_constants_ac0e05654af490172ac33e0248198c5fb}\label{struct_ogre_1_1_gpu_named_constants_ac0e05654af490172ac33e0248198c5fb}} 
\index{Ogre::GpuNamedConstants@{Ogre::GpuNamedConstants}!GpuNamedConstants@{GpuNamedConstants}}
\index{GpuNamedConstants@{GpuNamedConstants}!Ogre::GpuNamedConstants@{Ogre::GpuNamedConstants}}
\doxysubsubsection{\texorpdfstring{GpuNamedConstants()}{GpuNamedConstants()}}
{\footnotesize\ttfamily Ogre\+::\+Gpu\+Named\+Constants\+::\+Gpu\+Named\+Constants (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



\doxysubsection{Member Function Documentation}
\mbox{\Hypertarget{struct_ogre_1_1_gpu_named_constants_ad1a16f8fe55b903b77c62a5d28387d21}\label{struct_ogre_1_1_gpu_named_constants_ad1a16f8fe55b903b77c62a5d28387d21}} 
\index{Ogre::GpuNamedConstants@{Ogre::GpuNamedConstants}!generateConstantDefinitionArrayEntries@{generateConstantDefinitionArrayEntries}}
\index{generateConstantDefinitionArrayEntries@{generateConstantDefinitionArrayEntries}!Ogre::GpuNamedConstants@{Ogre::GpuNamedConstants}}
\doxysubsubsection{\texorpdfstring{generateConstantDefinitionArrayEntries()}{generateConstantDefinitionArrayEntries()}}
{\footnotesize\ttfamily void Ogre\+::\+Gpu\+Named\+Constants\+::generate\+Constant\+Definition\+Array\+Entries (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}} \&}]{param\+Name,  }\item[{const \mbox{\hyperlink{struct_ogre_1_1_gpu_constant_definition}{Gpu\+Constant\+Definition}} \&}]{base\+Def }\end{DoxyParamCaption})}



Generate additional constant entries for arrays based on a base definition. 

\begin{DoxyRemark}{Remarks}
Array uniforms will be added just with their base name with no array suffix. This method will add named entries for array suffixes too so individual array entries can be addressed. Note that we only individually index array elements if the array size is up to 16 entries in size. Anything larger than that only gets a \mbox{[}0\mbox{]} entry as well as the main entry, to save cluttering up the name map. After all, you can address the larger arrays in a bulk fashion much more easily anyway. 
\end{DoxyRemark}
\mbox{\Hypertarget{struct_ogre_1_1_gpu_named_constants_a3e1e7178a176a8e12e9e7491187885de}\label{struct_ogre_1_1_gpu_named_constants_a3e1e7178a176a8e12e9e7491187885de}} 
\index{Ogre::GpuNamedConstants@{Ogre::GpuNamedConstants}!getGenerateAllConstantDefinitionArrayEntries@{getGenerateAllConstantDefinitionArrayEntries}}
\index{getGenerateAllConstantDefinitionArrayEntries@{getGenerateAllConstantDefinitionArrayEntries}!Ogre::GpuNamedConstants@{Ogre::GpuNamedConstants}}
\doxysubsubsection{\texorpdfstring{getGenerateAllConstantDefinitionArrayEntries()}{getGenerateAllConstantDefinitionArrayEntries()}}
{\footnotesize\ttfamily static bool Ogre\+::\+Gpu\+Named\+Constants\+::get\+Generate\+All\+Constant\+Definition\+Array\+Entries (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [static]}}



Indicates whether all array entries will be generated and added to the definitions map. 

\mbox{\Hypertarget{struct_ogre_1_1_gpu_named_constants_a262a2eea37cc3b2ef0973a625f624ff0}\label{struct_ogre_1_1_gpu_named_constants_a262a2eea37cc3b2ef0973a625f624ff0}} 
\index{Ogre::GpuNamedConstants@{Ogre::GpuNamedConstants}!setGenerateAllConstantDefinitionArrayEntries@{setGenerateAllConstantDefinitionArrayEntries}}
\index{setGenerateAllConstantDefinitionArrayEntries@{setGenerateAllConstantDefinitionArrayEntries}!Ogre::GpuNamedConstants@{Ogre::GpuNamedConstants}}
\doxysubsubsection{\texorpdfstring{setGenerateAllConstantDefinitionArrayEntries()}{setGenerateAllConstantDefinitionArrayEntries()}}
{\footnotesize\ttfamily static void Ogre\+::\+Gpu\+Named\+Constants\+::set\+Generate\+All\+Constant\+Definition\+Array\+Entries (\begin{DoxyParamCaption}\item[{bool}]{generate\+All }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [static]}}



Sets whether all array entries will be generated and added to the definitions map. 

\begin{DoxyRemark}{Remarks}
Usually, array entries can only be individually indexed if they\textquotesingle{}re up to 16 entries long, to save memory -\/ arrays larger than that can be set but only via the bulk setting methods. This option allows you to choose to individually index every array entry. 
\end{DoxyRemark}
\mbox{\Hypertarget{struct_ogre_1_1_gpu_named_constants_a4ce0c92c117f2c7dd91acf697821ef67}\label{struct_ogre_1_1_gpu_named_constants_a4ce0c92c117f2c7dd91acf697821ef67}} 
\index{Ogre::GpuNamedConstants@{Ogre::GpuNamedConstants}!save@{save}}
\index{save@{save}!Ogre::GpuNamedConstants@{Ogre::GpuNamedConstants}}
\doxysubsubsection{\texorpdfstring{save()}{save()}}
{\footnotesize\ttfamily void Ogre\+::\+Gpu\+Named\+Constants\+::save (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}} \&}]{filename }\end{DoxyParamCaption}) const}



Saves constant definitions to a file, compatible with \mbox{\hyperlink{class_ogre_1_1_gpu_program_af420c447afb13728b4ddfcb8d8d7d812}{Gpu\+Program\+::set\+Manual\+Named\+Constants\+File}}. 

\begin{DoxySeeAlso}{See also}
\mbox{\hyperlink{class_ogre_1_1_gpu_program_af420c447afb13728b4ddfcb8d8d7d812}{Gpu\+Program\+::set\+Manual\+Named\+Constants\+File}} 
\end{DoxySeeAlso}
\mbox{\Hypertarget{struct_ogre_1_1_gpu_named_constants_a8c49c555a0e99a99dee1e99d0450578b}\label{struct_ogre_1_1_gpu_named_constants_a8c49c555a0e99a99dee1e99d0450578b}} 
\index{Ogre::GpuNamedConstants@{Ogre::GpuNamedConstants}!load@{load}}
\index{load@{load}!Ogre::GpuNamedConstants@{Ogre::GpuNamedConstants}}
\doxysubsubsection{\texorpdfstring{load()}{load()}}
{\footnotesize\ttfamily void Ogre\+::\+Gpu\+Named\+Constants\+::load (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{namespace_ogre_a8a2a961b4205aacff9c01e81e08d7781}{Data\+Stream\+Ptr}} \&}]{stream }\end{DoxyParamCaption})}



Loads constant definitions from a stream, compatible with \mbox{\hyperlink{class_ogre_1_1_gpu_program_af420c447afb13728b4ddfcb8d8d7d812}{Gpu\+Program\+::set\+Manual\+Named\+Constants\+File}}. 

\begin{DoxySeeAlso}{See also}
\mbox{\hyperlink{class_ogre_1_1_gpu_program_af420c447afb13728b4ddfcb8d8d7d812}{Gpu\+Program\+::set\+Manual\+Named\+Constants\+File}} 
\end{DoxySeeAlso}
\mbox{\Hypertarget{struct_ogre_1_1_gpu_named_constants_a8ea5fa125ab0e44fdf04b6261d938835}\label{struct_ogre_1_1_gpu_named_constants_a8ea5fa125ab0e44fdf04b6261d938835}} 
\index{Ogre::GpuNamedConstants@{Ogre::GpuNamedConstants}!calculateSize@{calculateSize}}
\index{calculateSize@{calculateSize}!Ogre::GpuNamedConstants@{Ogre::GpuNamedConstants}}
\doxysubsubsection{\texorpdfstring{calculateSize()}{calculateSize()}}
{\footnotesize\ttfamily size\+\_\+t Ogre\+::\+Gpu\+Named\+Constants\+::calculate\+Size (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const}



\doxysubsection{Member Data Documentation}
\mbox{\Hypertarget{struct_ogre_1_1_gpu_named_constants_a5558247a535928116d99c17fdbb4de6f}\label{struct_ogre_1_1_gpu_named_constants_a5558247a535928116d99c17fdbb4de6f}} 
\index{Ogre::GpuNamedConstants@{Ogre::GpuNamedConstants}!floatBufferSize@{floatBufferSize}}
\index{floatBufferSize@{floatBufferSize}!Ogre::GpuNamedConstants@{Ogre::GpuNamedConstants}}
\doxysubsubsection{\texorpdfstring{floatBufferSize}{floatBufferSize}}
{\footnotesize\ttfamily size\+\_\+t Ogre\+::\+Gpu\+Named\+Constants\+::float\+Buffer\+Size}



Total size of the float buffer required. 

\mbox{\Hypertarget{struct_ogre_1_1_gpu_named_constants_a752c361f1d2b41e6ef26092c5d248477}\label{struct_ogre_1_1_gpu_named_constants_a752c361f1d2b41e6ef26092c5d248477}} 
\index{Ogre::GpuNamedConstants@{Ogre::GpuNamedConstants}!doubleBufferSize@{doubleBufferSize}}
\index{doubleBufferSize@{doubleBufferSize}!Ogre::GpuNamedConstants@{Ogre::GpuNamedConstants}}
\doxysubsubsection{\texorpdfstring{doubleBufferSize}{doubleBufferSize}}
{\footnotesize\ttfamily size\+\_\+t Ogre\+::\+Gpu\+Named\+Constants\+::double\+Buffer\+Size}



Total size of the double buffer required. 

\mbox{\Hypertarget{struct_ogre_1_1_gpu_named_constants_a6989ab89780218c87936c55c96586a5b}\label{struct_ogre_1_1_gpu_named_constants_a6989ab89780218c87936c55c96586a5b}} 
\index{Ogre::GpuNamedConstants@{Ogre::GpuNamedConstants}!intBufferSize@{intBufferSize}}
\index{intBufferSize@{intBufferSize}!Ogre::GpuNamedConstants@{Ogre::GpuNamedConstants}}
\doxysubsubsection{\texorpdfstring{intBufferSize}{intBufferSize}}
{\footnotesize\ttfamily size\+\_\+t Ogre\+::\+Gpu\+Named\+Constants\+::int\+Buffer\+Size}



Total size of the int buffer required. 

\mbox{\Hypertarget{struct_ogre_1_1_gpu_named_constants_af35adecba174a620edfea7ff95ad3a7e}\label{struct_ogre_1_1_gpu_named_constants_af35adecba174a620edfea7ff95ad3a7e}} 
\index{Ogre::GpuNamedConstants@{Ogre::GpuNamedConstants}!map@{map}}
\index{map@{map}!Ogre::GpuNamedConstants@{Ogre::GpuNamedConstants}}
\doxysubsubsection{\texorpdfstring{map}{map}}
{\footnotesize\ttfamily \mbox{\hyperlink{group___materials_gae4823c1377e5d4c312a3da9d1cb8534a}{Gpu\+Constant\+Definition\+Map}} Ogre\+::\+Gpu\+Named\+Constants\+::map}



Map of parameter names to \mbox{\hyperlink{struct_ogre_1_1_gpu_constant_definition}{Gpu\+Constant\+Definition}}. 



The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{_ogre_gpu_program_params_8h}{Ogre\+Gpu\+Program\+Params.\+h}}\end{DoxyCompactItemize}
