\hypertarget{class_ogre_1_1_g_l3_plus_pixel_util}{}\section{Ogre\+:\+:G\+L3\+Plus\+Pixel\+Util Class Reference}
\label{class_ogre_1_1_g_l3_plus_pixel_util}\index{Ogre\+::\+G\+L3\+Plus\+Pixel\+Util@{Ogre\+::\+G\+L3\+Plus\+Pixel\+Util}}


Class to do pixel format mapping between GL and O\+G\+RE.  




{\ttfamily \#include $<$Ogre\+G\+L3\+Plus\+Pixel\+Format.\+h$>$}

\subsection*{Static Public Member Functions}
\begin{DoxyCompactItemize}
\item 
static G\+Lenum \hyperlink{class_ogre_1_1_g_l3_plus_pixel_util_a89ba138b4cc48a2227410ff0d75c34b3}{get\+Closest\+G\+L\+Image\+Internal\+Format} (\hyperlink{group___image_ga7e0353e7d36d4c2e8468641b7303d39c}{Pixel\+Format} format)
\begin{DoxyCompactList}\small\item\em Takes the O\+G\+RE pixel format and returns the type that must be provided to GL as internal format for image load/store. \end{DoxyCompactList}\item 
static \hyperlink{group___image_ga7e0353e7d36d4c2e8468641b7303d39c}{Pixel\+Format} \hyperlink{class_ogre_1_1_g_l3_plus_pixel_util_a9015dbd63fa652afdb737d7c76b1a9c9}{get\+Closest\+O\+G\+R\+E\+Format} (G\+Lenum format)
\begin{DoxyCompactList}\small\item\em Function to get the closest matching O\+G\+RE format to an internal GL format. \end{DoxyCompactList}\item 
static G\+Lenum \hyperlink{class_ogre_1_1_g_l3_plus_pixel_util_ad0994ca6326b8f313059ff57fea4020a}{get\+G\+L\+Image\+Internal\+Format} (\hyperlink{group___image_ga7e0353e7d36d4c2e8468641b7303d39c}{Pixel\+Format} format)
\begin{DoxyCompactList}\small\item\em Takes the O\+G\+RE pixel format and returns the type that must be provided to GL as internal format for image load/store. \end{DoxyCompactList}\item 
static G\+Lenum \hyperlink{class_ogre_1_1_g_l3_plus_pixel_util_a01035f821fcef56e10b3de60956f9f34}{get\+G\+L\+Internal\+Format} (\hyperlink{group___image_ga7e0353e7d36d4c2e8468641b7303d39c}{Pixel\+Format} format, bool hw\+Gamma=false)
\begin{DoxyCompactList}\small\item\em Takes the O\+G\+RE pixel format and returns the type that must be provided to GL as internal format. \end{DoxyCompactList}\item 
static G\+Lenum \hyperlink{class_ogre_1_1_g_l3_plus_pixel_util_ab76f175c4a667a1fd8c5ef0eaf4d35d4}{get\+G\+L\+Origin\+Data\+Type} (\hyperlink{group___image_ga7e0353e7d36d4c2e8468641b7303d39c}{Pixel\+Format} format)
\begin{DoxyCompactList}\small\item\em Takes the O\+G\+RE pixel format and returns type that must be provided to GL as data type for reading it into the G\+PU. \end{DoxyCompactList}\item 
static G\+Lenum \hyperlink{class_ogre_1_1_g_l3_plus_pixel_util_a71798ce5791adee96df5a6d99e24e025}{get\+G\+L\+Origin\+Format} (\hyperlink{group___image_ga7e0353e7d36d4c2e8468641b7303d39c}{Pixel\+Format} format)
\begin{DoxyCompactList}\small\item\em Takes the O\+G\+RE pixel format and returns the appropriate GL one. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
Class to do pixel format mapping between GL and O\+G\+RE. 

\subsection{Member Function Documentation}
\mbox{\Hypertarget{class_ogre_1_1_g_l3_plus_pixel_util_a71798ce5791adee96df5a6d99e24e025}\label{class_ogre_1_1_g_l3_plus_pixel_util_a71798ce5791adee96df5a6d99e24e025}} 
\index{Ogre\+::\+G\+L3\+Plus\+Pixel\+Util@{Ogre\+::\+G\+L3\+Plus\+Pixel\+Util}!get\+G\+L\+Origin\+Format@{get\+G\+L\+Origin\+Format}}
\index{get\+G\+L\+Origin\+Format@{get\+G\+L\+Origin\+Format}!Ogre\+::\+G\+L3\+Plus\+Pixel\+Util@{Ogre\+::\+G\+L3\+Plus\+Pixel\+Util}}
\subsubsection{\texorpdfstring{get\+G\+L\+Origin\+Format()}{getGLOriginFormat()}}
{\footnotesize\ttfamily static G\+Lenum Ogre\+::\+G\+L3\+Plus\+Pixel\+Util\+::get\+G\+L\+Origin\+Format (\begin{DoxyParamCaption}\item[{\hyperlink{group___image_ga7e0353e7d36d4c2e8468641b7303d39c}{Pixel\+Format}}]{format }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [static]}}



Takes the O\+G\+RE pixel format and returns the appropriate GL one. 

\begin{DoxyReturn}{Returns}
a G\+Lenum describing the format, or 0 if there is no exactly matching one (and conversion is needed) 
\end{DoxyReturn}
\mbox{\Hypertarget{class_ogre_1_1_g_l3_plus_pixel_util_ab76f175c4a667a1fd8c5ef0eaf4d35d4}\label{class_ogre_1_1_g_l3_plus_pixel_util_ab76f175c4a667a1fd8c5ef0eaf4d35d4}} 
\index{Ogre\+::\+G\+L3\+Plus\+Pixel\+Util@{Ogre\+::\+G\+L3\+Plus\+Pixel\+Util}!get\+G\+L\+Origin\+Data\+Type@{get\+G\+L\+Origin\+Data\+Type}}
\index{get\+G\+L\+Origin\+Data\+Type@{get\+G\+L\+Origin\+Data\+Type}!Ogre\+::\+G\+L3\+Plus\+Pixel\+Util@{Ogre\+::\+G\+L3\+Plus\+Pixel\+Util}}
\subsubsection{\texorpdfstring{get\+G\+L\+Origin\+Data\+Type()}{getGLOriginDataType()}}
{\footnotesize\ttfamily static G\+Lenum Ogre\+::\+G\+L3\+Plus\+Pixel\+Util\+::get\+G\+L\+Origin\+Data\+Type (\begin{DoxyParamCaption}\item[{\hyperlink{group___image_ga7e0353e7d36d4c2e8468641b7303d39c}{Pixel\+Format}}]{format }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [static]}}



Takes the O\+G\+RE pixel format and returns type that must be provided to GL as data type for reading it into the G\+PU. 

\begin{DoxyReturn}{Returns}
a G\+Lenum describing the data type, or 0 if there is no exactly matching one (and conversion is needed) 
\end{DoxyReturn}
\mbox{\Hypertarget{class_ogre_1_1_g_l3_plus_pixel_util_a01035f821fcef56e10b3de60956f9f34}\label{class_ogre_1_1_g_l3_plus_pixel_util_a01035f821fcef56e10b3de60956f9f34}} 
\index{Ogre\+::\+G\+L3\+Plus\+Pixel\+Util@{Ogre\+::\+G\+L3\+Plus\+Pixel\+Util}!get\+G\+L\+Internal\+Format@{get\+G\+L\+Internal\+Format}}
\index{get\+G\+L\+Internal\+Format@{get\+G\+L\+Internal\+Format}!Ogre\+::\+G\+L3\+Plus\+Pixel\+Util@{Ogre\+::\+G\+L3\+Plus\+Pixel\+Util}}
\subsubsection{\texorpdfstring{get\+G\+L\+Internal\+Format()}{getGLInternalFormat()}}
{\footnotesize\ttfamily static G\+Lenum Ogre\+::\+G\+L3\+Plus\+Pixel\+Util\+::get\+G\+L\+Internal\+Format (\begin{DoxyParamCaption}\item[{\hyperlink{group___image_ga7e0353e7d36d4c2e8468641b7303d39c}{Pixel\+Format}}]{format,  }\item[{bool}]{hw\+Gamma = {\ttfamily false} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [static]}}



Takes the O\+G\+RE pixel format and returns the type that must be provided to GL as internal format. 

G\+L\+\_\+\+N\+O\+NE if no match exists. 
\begin{DoxyParams}{Parameters}
{\em format} & The pixel format \\
\hline
{\em hw\+Gamma} & Whether a hardware gamma-\/corrected version is requested \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{class_ogre_1_1_g_l3_plus_pixel_util_ad0994ca6326b8f313059ff57fea4020a}\label{class_ogre_1_1_g_l3_plus_pixel_util_ad0994ca6326b8f313059ff57fea4020a}} 
\index{Ogre\+::\+G\+L3\+Plus\+Pixel\+Util@{Ogre\+::\+G\+L3\+Plus\+Pixel\+Util}!get\+G\+L\+Image\+Internal\+Format@{get\+G\+L\+Image\+Internal\+Format}}
\index{get\+G\+L\+Image\+Internal\+Format@{get\+G\+L\+Image\+Internal\+Format}!Ogre\+::\+G\+L3\+Plus\+Pixel\+Util@{Ogre\+::\+G\+L3\+Plus\+Pixel\+Util}}
\subsubsection{\texorpdfstring{get\+G\+L\+Image\+Internal\+Format()}{getGLImageInternalFormat()}}
{\footnotesize\ttfamily static G\+Lenum Ogre\+::\+G\+L3\+Plus\+Pixel\+Util\+::get\+G\+L\+Image\+Internal\+Format (\begin{DoxyParamCaption}\item[{\hyperlink{group___image_ga7e0353e7d36d4c2e8468641b7303d39c}{Pixel\+Format}}]{format }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [static]}}



Takes the O\+G\+RE pixel format and returns the type that must be provided to GL as internal format for image load/store. 

G\+L\+\_\+\+N\+O\+NE if no match exists. 
\begin{DoxyParams}{Parameters}
{\em format} & The pixel format \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{class_ogre_1_1_g_l3_plus_pixel_util_a89ba138b4cc48a2227410ff0d75c34b3}\label{class_ogre_1_1_g_l3_plus_pixel_util_a89ba138b4cc48a2227410ff0d75c34b3}} 
\index{Ogre\+::\+G\+L3\+Plus\+Pixel\+Util@{Ogre\+::\+G\+L3\+Plus\+Pixel\+Util}!get\+Closest\+G\+L\+Image\+Internal\+Format@{get\+Closest\+G\+L\+Image\+Internal\+Format}}
\index{get\+Closest\+G\+L\+Image\+Internal\+Format@{get\+Closest\+G\+L\+Image\+Internal\+Format}!Ogre\+::\+G\+L3\+Plus\+Pixel\+Util@{Ogre\+::\+G\+L3\+Plus\+Pixel\+Util}}
\subsubsection{\texorpdfstring{get\+Closest\+G\+L\+Image\+Internal\+Format()}{getClosestGLImageInternalFormat()}}
{\footnotesize\ttfamily static G\+Lenum Ogre\+::\+G\+L3\+Plus\+Pixel\+Util\+::get\+Closest\+G\+L\+Image\+Internal\+Format (\begin{DoxyParamCaption}\item[{\hyperlink{group___image_ga7e0353e7d36d4c2e8468641b7303d39c}{Pixel\+Format}}]{format }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [static]}}



Takes the O\+G\+RE pixel format and returns the type that must be provided to GL as internal format for image load/store. 

If no match exists, returns the closest match. 
\begin{DoxyParams}{Parameters}
{\em format} & The pixel format \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{class_ogre_1_1_g_l3_plus_pixel_util_a9015dbd63fa652afdb737d7c76b1a9c9}\label{class_ogre_1_1_g_l3_plus_pixel_util_a9015dbd63fa652afdb737d7c76b1a9c9}} 
\index{Ogre\+::\+G\+L3\+Plus\+Pixel\+Util@{Ogre\+::\+G\+L3\+Plus\+Pixel\+Util}!get\+Closest\+O\+G\+R\+E\+Format@{get\+Closest\+O\+G\+R\+E\+Format}}
\index{get\+Closest\+O\+G\+R\+E\+Format@{get\+Closest\+O\+G\+R\+E\+Format}!Ogre\+::\+G\+L3\+Plus\+Pixel\+Util@{Ogre\+::\+G\+L3\+Plus\+Pixel\+Util}}
\subsubsection{\texorpdfstring{get\+Closest\+O\+G\+R\+E\+Format()}{getClosestOGREFormat()}}
{\footnotesize\ttfamily static \hyperlink{group___image_ga7e0353e7d36d4c2e8468641b7303d39c}{Pixel\+Format} Ogre\+::\+G\+L3\+Plus\+Pixel\+Util\+::get\+Closest\+O\+G\+R\+E\+Format (\begin{DoxyParamCaption}\item[{G\+Lenum}]{format }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [static]}}



Function to get the closest matching O\+G\+RE format to an internal GL format. 

To be precise, the format will be chosen that is most efficient to transfer to the card without losing precision. \begin{DoxyRemark}{Remarks}
It is valid for this function to always return P\+F\+\_\+\+A8\+R8\+G8\+B8. 
\end{DoxyRemark}


The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
\item 
\hyperlink{_ogre_g_l3_plus_pixel_format_8h}{Ogre\+G\+L3\+Plus\+Pixel\+Format.\+h}\end{DoxyCompactItemize}
