\hypertarget{class_ogre_1_1_pixel_box}{}\section{Ogre\+:\+:Pixel\+Box Class Reference}
\label{class_ogre_1_1_pixel_box}\index{Ogre\+::\+Pixel\+Box@{Ogre\+::\+Pixel\+Box}}


A primitive describing a volume (3D), image (2D) or line (1D) of pixels in memory.  




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



Inheritance diagram for Ogre\+:\+:Pixel\+Box\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=234pt]{class_ogre_1_1_pixel_box__inherit__graph}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hyperlink{class_ogre_1_1_pixel_box_a196c57b3cf61c1545c46896cff269efb}{Pixel\+Box} ()
\begin{DoxyCompactList}\small\item\em Parameter constructor for setting the members manually. \end{DoxyCompactList}\item 
\hyperlink{class_ogre_1_1_pixel_box_a422d941d56f9bb32134f304754e0d72d}{Pixel\+Box} (const \hyperlink{struct_ogre_1_1_box}{Box} \&extents, \hyperlink{group___image_ga7e0353e7d36d4c2e8468641b7303d39c}{Pixel\+Format} pixel\+Format, void $\ast$pixel\+Data=0)
\begin{DoxyCompactList}\small\item\em Constructor providing extents in the form of a \hyperlink{struct_ogre_1_1_box}{Box} object. \end{DoxyCompactList}\item 
\hyperlink{class_ogre_1_1_pixel_box_a94e88a47e03162fabe5eb408d3358e12}{Pixel\+Box} (\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32} width, \hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32} height, \hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32} depth, \hyperlink{group___image_ga7e0353e7d36d4c2e8468641b7303d39c}{Pixel\+Format} pixel\+Format, void $\ast$pixel\+Data=0)
\begin{DoxyCompactList}\small\item\em Constructor providing width, height and depth. \end{DoxyCompactList}\item 
\hyperlink{class_ogre_1_1_pixel_box_a5a5191d05b7ec15bb97c98807c271f35}{$\sim$\+Pixel\+Box} ()
\item 
bool \hyperlink{struct_ogre_1_1_box_a7d29d3b112980c25bd0250dc41cf6ed2}{contains} (const \hyperlink{struct_ogre_1_1_box}{Box} \&def) const
\begin{DoxyCompactList}\small\item\em Return true if the other box is a part of this one. \end{DoxyCompactList}\item 
\hyperlink{class_ogre_1_1_colour_value}{Colour\+Value} \hyperlink{class_ogre_1_1_pixel_box_a84fd367f9d768e96a98f53cd08c4ab7b}{get\+Colour\+At} (size\+\_\+t x, size\+\_\+t y, size\+\_\+t z) const
\begin{DoxyCompactList}\small\item\em Get colour value from a certain location in the \hyperlink{class_ogre_1_1_pixel_box}{Pixel\+Box}. \end{DoxyCompactList}\item 
size\+\_\+t \hyperlink{class_ogre_1_1_pixel_box_abfca78eedb6e3abb8d06ff015814a552}{get\+Consecutive\+Size} () const
\begin{DoxyCompactList}\small\item\em Return the size (in bytes) this image would take if it was laid out consecutive in memory. \end{DoxyCompactList}\item 
\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32} \hyperlink{struct_ogre_1_1_box_ae820fd38f7b51e2a907ef601642c898c}{get\+Depth} () const
\begin{DoxyCompactList}\small\item\em Get the depth of this box. \end{DoxyCompactList}\item 
\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32} \hyperlink{struct_ogre_1_1_box_a352d26dea0069f2e7f1414e8caa2328c}{get\+Height} () const
\begin{DoxyCompactList}\small\item\em Get the height of this box. \end{DoxyCompactList}\item 
size\+\_\+t \hyperlink{class_ogre_1_1_pixel_box_a1c74e261d3283aa84efca68e8bc7c717}{get\+Row\+Skip} () const
\begin{DoxyCompactList}\small\item\em Get the number of elements between one past the rightmost pixel of one row and the leftmost pixel of the next row. \end{DoxyCompactList}\item 
size\+\_\+t \hyperlink{class_ogre_1_1_pixel_box_a098dfd052183aeb4025794758ed59021}{get\+Slice\+Skip} () const
\begin{DoxyCompactList}\small\item\em Get the number of elements between one past the right bottom pixel of one slice and the left top pixel of the next slice. \end{DoxyCompactList}\item 
\hyperlink{class_ogre_1_1_pixel_box}{Pixel\+Box} \hyperlink{class_ogre_1_1_pixel_box_adcd4bcebf8ba9ac17b55f0aced8a8285}{get\+Sub\+Volume} (const \hyperlink{struct_ogre_1_1_box}{Box} \&def, bool reset\+Origin=true) const
\begin{DoxyCompactList}\small\item\em Return a subvolume of this \hyperlink{class_ogre_1_1_pixel_box}{Pixel\+Box}. \end{DoxyCompactList}\item 
\hyperlink{namespace_ogre_a07f1f7c1d84d58c9beae02e1ebb945e4}{uchar} $\ast$ \hyperlink{class_ogre_1_1_pixel_box_a9bbe10698adab93b479bded30439fb87}{get\+Top\+Left\+Front\+Pixel\+Ptr} () const
\begin{DoxyCompactList}\small\item\em Return a data pointer pointing to top left front pixel of the pixel box. \end{DoxyCompactList}\item 
\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32} \hyperlink{struct_ogre_1_1_box_a5499449ff454ff98aaa697f8854376fc}{get\+Width} () const
\begin{DoxyCompactList}\small\item\em Get the width of this box. \end{DoxyCompactList}\item 
bool \hyperlink{class_ogre_1_1_pixel_box_ac24a3ceef06a3e9426d3832d1ba69c6f}{is\+Consecutive} () const
\begin{DoxyCompactList}\small\item\em Return whether this buffer is laid out consecutive in memory (ie the pitches are equal to the dimensions) \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_pixel_box_ad9be8442d595e5208ea80e59041b59d8}{set\+Colour\+At} (\hyperlink{class_ogre_1_1_colour_value}{Colour\+Value} const \&cv, size\+\_\+t x, size\+\_\+t y, size\+\_\+t z)
\begin{DoxyCompactList}\small\item\em Set colour value at a certain location in the \hyperlink{class_ogre_1_1_pixel_box}{Pixel\+Box}. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_pixel_box_a69fea3b4fed6726ee578519ec05bd246}{set\+Consecutive} ()
\begin{DoxyCompactList}\small\item\em Set the row\+Pitch and slice\+Pitch so that the buffer is laid out consecutive in memory. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Public Attributes}
\begin{DoxyCompactItemize}
\item 
\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32} \hyperlink{struct_ogre_1_1_box_a19a7351210e086309a74461d8b4c5cb1}{back}
\item 
\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32} \hyperlink{struct_ogre_1_1_box_ae46fa4954b4d29f4d051f947fe45c142}{bottom}
\item 
\hyperlink{namespace_ogre_a07f1f7c1d84d58c9beae02e1ebb945e4}{uchar} $\ast$ \hyperlink{class_ogre_1_1_pixel_box_a59624c7c33ade5365428473a1f3dc85a}{data}
\begin{DoxyCompactList}\small\item\em The data pointer. \end{DoxyCompactList}\item 
\hyperlink{group___image_ga7e0353e7d36d4c2e8468641b7303d39c}{Pixel\+Format} \hyperlink{class_ogre_1_1_pixel_box_aa4101fdc288dc41dddac88440b4d0818}{format}
\begin{DoxyCompactList}\small\item\em The pixel format. \end{DoxyCompactList}\item 
\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32} \hyperlink{struct_ogre_1_1_box_a5e545a9bd1bc4151a113267c6529d84f}{front}
\item 
\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32} \hyperlink{struct_ogre_1_1_box_a88fa61f841bc444d92075d8b6cb2b43b}{left}
\item 
\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32} \hyperlink{struct_ogre_1_1_box_ac2c94e2d364dfabe7e4406ff8f41ab9e}{right}
\item 
size\+\_\+t \hyperlink{class_ogre_1_1_pixel_box_aacf8f1ebed40c557389d9d1e9dda3b68}{row\+Pitch}
\begin{DoxyCompactList}\small\item\em Number of elements between the leftmost pixel of one row and the left pixel of the next. \end{DoxyCompactList}\item 
size\+\_\+t \hyperlink{class_ogre_1_1_pixel_box_a5f4ac4f2e735678fc8b3ddc1068674dd}{slice\+Pitch}
\begin{DoxyCompactList}\small\item\em Number of elements between the top left pixel of one (depth) slice and the top left pixel of the next. \end{DoxyCompactList}\item 
\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32} \hyperlink{struct_ogre_1_1_box_a7c317f774697dbd65dd77e49a0448d2d}{top}
\end{DoxyCompactItemize}


\subsection{Detailed Description}
A primitive describing a volume (3D), image (2D) or line (1D) of pixels in memory. 

In case of a rectangle, depth must be 1. Pixels are stored as a succession of \char`\"{}depth\char`\"{} slices, each containing \char`\"{}height\char`\"{} rows of \char`\"{}width\char`\"{} pixels.

Note that the left, top, and front edges are included but the right, bottom and back ones are not. 

\subsection{Constructor \& Destructor Documentation}
\mbox{\Hypertarget{class_ogre_1_1_pixel_box_a196c57b3cf61c1545c46896cff269efb}\label{class_ogre_1_1_pixel_box_a196c57b3cf61c1545c46896cff269efb}} 
\index{Ogre\+::\+Pixel\+Box@{Ogre\+::\+Pixel\+Box}!Pixel\+Box@{Pixel\+Box}}
\index{Pixel\+Box@{Pixel\+Box}!Ogre\+::\+Pixel\+Box@{Ogre\+::\+Pixel\+Box}}
\subsubsection{\texorpdfstring{Pixel\+Box()}{PixelBox()}\hspace{0.1cm}{\footnotesize\ttfamily [1/3]}}
{\footnotesize\ttfamily Ogre\+::\+Pixel\+Box\+::\+Pixel\+Box (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Parameter constructor for setting the members manually. 

\mbox{\Hypertarget{class_ogre_1_1_pixel_box_a5a5191d05b7ec15bb97c98807c271f35}\label{class_ogre_1_1_pixel_box_a5a5191d05b7ec15bb97c98807c271f35}} 
\index{Ogre\+::\+Pixel\+Box@{Ogre\+::\+Pixel\+Box}!````~Pixel\+Box@{$\sim$\+Pixel\+Box}}
\index{````~Pixel\+Box@{$\sim$\+Pixel\+Box}!Ogre\+::\+Pixel\+Box@{Ogre\+::\+Pixel\+Box}}
\subsubsection{\texorpdfstring{$\sim$\+Pixel\+Box()}{~PixelBox()}}
{\footnotesize\ttfamily Ogre\+::\+Pixel\+Box\+::$\sim$\+Pixel\+Box (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}

\mbox{\Hypertarget{class_ogre_1_1_pixel_box_a422d941d56f9bb32134f304754e0d72d}\label{class_ogre_1_1_pixel_box_a422d941d56f9bb32134f304754e0d72d}} 
\index{Ogre\+::\+Pixel\+Box@{Ogre\+::\+Pixel\+Box}!Pixel\+Box@{Pixel\+Box}}
\index{Pixel\+Box@{Pixel\+Box}!Ogre\+::\+Pixel\+Box@{Ogre\+::\+Pixel\+Box}}
\subsubsection{\texorpdfstring{Pixel\+Box()}{PixelBox()}\hspace{0.1cm}{\footnotesize\ttfamily [2/3]}}
{\footnotesize\ttfamily Ogre\+::\+Pixel\+Box\+::\+Pixel\+Box (\begin{DoxyParamCaption}\item[{const \hyperlink{struct_ogre_1_1_box}{Box} \&}]{extents,  }\item[{\hyperlink{group___image_ga7e0353e7d36d4c2e8468641b7303d39c}{Pixel\+Format}}]{pixel\+Format,  }\item[{void $\ast$}]{pixel\+Data = {\ttfamily 0} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Constructor providing extents in the form of a \hyperlink{struct_ogre_1_1_box}{Box} object. 

This constructor assumes the pixel data is laid out consecutively in memory. (this means row after row, slice after slice, with no space in between) 
\begin{DoxyParams}{Parameters}
{\em extents} & Extents of the region defined by data \\
\hline
{\em pixel\+Format} & Format of this buffer \\
\hline
{\em pixel\+Data} & Pointer to the actual data \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{class_ogre_1_1_pixel_box_a94e88a47e03162fabe5eb408d3358e12}\label{class_ogre_1_1_pixel_box_a94e88a47e03162fabe5eb408d3358e12}} 
\index{Ogre\+::\+Pixel\+Box@{Ogre\+::\+Pixel\+Box}!Pixel\+Box@{Pixel\+Box}}
\index{Pixel\+Box@{Pixel\+Box}!Ogre\+::\+Pixel\+Box@{Ogre\+::\+Pixel\+Box}}
\subsubsection{\texorpdfstring{Pixel\+Box()}{PixelBox()}\hspace{0.1cm}{\footnotesize\ttfamily [3/3]}}
{\footnotesize\ttfamily Ogre\+::\+Pixel\+Box\+::\+Pixel\+Box (\begin{DoxyParamCaption}\item[{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}}]{width,  }\item[{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}}]{height,  }\item[{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}}]{depth,  }\item[{\hyperlink{group___image_ga7e0353e7d36d4c2e8468641b7303d39c}{Pixel\+Format}}]{pixel\+Format,  }\item[{void $\ast$}]{pixel\+Data = {\ttfamily 0} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Constructor providing width, height and depth. 

This constructor assumes the pixel data is laid out consecutively in memory. (this means row after row, slice after slice, with no space in between) 
\begin{DoxyParams}{Parameters}
{\em width} & Width of the region \\
\hline
{\em height} & Height of the region \\
\hline
{\em depth} & Depth of the region \\
\hline
{\em pixel\+Format} & Format of this buffer \\
\hline
{\em pixel\+Data} & Pointer to the actual data \\
\hline
\end{DoxyParams}


\subsection{Member Function Documentation}
\mbox{\Hypertarget{class_ogre_1_1_pixel_box_a69fea3b4fed6726ee578519ec05bd246}\label{class_ogre_1_1_pixel_box_a69fea3b4fed6726ee578519ec05bd246}} 
\index{Ogre\+::\+Pixel\+Box@{Ogre\+::\+Pixel\+Box}!set\+Consecutive@{set\+Consecutive}}
\index{set\+Consecutive@{set\+Consecutive}!Ogre\+::\+Pixel\+Box@{Ogre\+::\+Pixel\+Box}}
\subsubsection{\texorpdfstring{set\+Consecutive()}{setConsecutive()}}
{\footnotesize\ttfamily void Ogre\+::\+Pixel\+Box\+::set\+Consecutive (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Set the row\+Pitch and slice\+Pitch so that the buffer is laid out consecutive in memory. 

\mbox{\Hypertarget{class_ogre_1_1_pixel_box_a1c74e261d3283aa84efca68e8bc7c717}\label{class_ogre_1_1_pixel_box_a1c74e261d3283aa84efca68e8bc7c717}} 
\index{Ogre\+::\+Pixel\+Box@{Ogre\+::\+Pixel\+Box}!get\+Row\+Skip@{get\+Row\+Skip}}
\index{get\+Row\+Skip@{get\+Row\+Skip}!Ogre\+::\+Pixel\+Box@{Ogre\+::\+Pixel\+Box}}
\subsubsection{\texorpdfstring{get\+Row\+Skip()}{getRowSkip()}}
{\footnotesize\ttfamily size\+\_\+t Ogre\+::\+Pixel\+Box\+::get\+Row\+Skip (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Get the number of elements between one past the rightmost pixel of one row and the leftmost pixel of the next row. 

(IE this is zero if rows are consecutive). \mbox{\Hypertarget{class_ogre_1_1_pixel_box_a098dfd052183aeb4025794758ed59021}\label{class_ogre_1_1_pixel_box_a098dfd052183aeb4025794758ed59021}} 
\index{Ogre\+::\+Pixel\+Box@{Ogre\+::\+Pixel\+Box}!get\+Slice\+Skip@{get\+Slice\+Skip}}
\index{get\+Slice\+Skip@{get\+Slice\+Skip}!Ogre\+::\+Pixel\+Box@{Ogre\+::\+Pixel\+Box}}
\subsubsection{\texorpdfstring{get\+Slice\+Skip()}{getSliceSkip()}}
{\footnotesize\ttfamily size\+\_\+t Ogre\+::\+Pixel\+Box\+::get\+Slice\+Skip (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Get the number of elements between one past the right bottom pixel of one slice and the left top pixel of the next slice. 

(IE this is zero if slices are consecutive). \mbox{\Hypertarget{class_ogre_1_1_pixel_box_ac24a3ceef06a3e9426d3832d1ba69c6f}\label{class_ogre_1_1_pixel_box_ac24a3ceef06a3e9426d3832d1ba69c6f}} 
\index{Ogre\+::\+Pixel\+Box@{Ogre\+::\+Pixel\+Box}!is\+Consecutive@{is\+Consecutive}}
\index{is\+Consecutive@{is\+Consecutive}!Ogre\+::\+Pixel\+Box@{Ogre\+::\+Pixel\+Box}}
\subsubsection{\texorpdfstring{is\+Consecutive()}{isConsecutive()}}
{\footnotesize\ttfamily bool Ogre\+::\+Pixel\+Box\+::is\+Consecutive (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Return whether this buffer is laid out consecutive in memory (ie the pitches are equal to the dimensions) 

\mbox{\Hypertarget{class_ogre_1_1_pixel_box_abfca78eedb6e3abb8d06ff015814a552}\label{class_ogre_1_1_pixel_box_abfca78eedb6e3abb8d06ff015814a552}} 
\index{Ogre\+::\+Pixel\+Box@{Ogre\+::\+Pixel\+Box}!get\+Consecutive\+Size@{get\+Consecutive\+Size}}
\index{get\+Consecutive\+Size@{get\+Consecutive\+Size}!Ogre\+::\+Pixel\+Box@{Ogre\+::\+Pixel\+Box}}
\subsubsection{\texorpdfstring{get\+Consecutive\+Size()}{getConsecutiveSize()}}
{\footnotesize\ttfamily size\+\_\+t Ogre\+::\+Pixel\+Box\+::get\+Consecutive\+Size (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const}



Return the size (in bytes) this image would take if it was laid out consecutive in memory. 

\mbox{\Hypertarget{class_ogre_1_1_pixel_box_adcd4bcebf8ba9ac17b55f0aced8a8285}\label{class_ogre_1_1_pixel_box_adcd4bcebf8ba9ac17b55f0aced8a8285}} 
\index{Ogre\+::\+Pixel\+Box@{Ogre\+::\+Pixel\+Box}!get\+Sub\+Volume@{get\+Sub\+Volume}}
\index{get\+Sub\+Volume@{get\+Sub\+Volume}!Ogre\+::\+Pixel\+Box@{Ogre\+::\+Pixel\+Box}}
\subsubsection{\texorpdfstring{get\+Sub\+Volume()}{getSubVolume()}}
{\footnotesize\ttfamily \hyperlink{class_ogre_1_1_pixel_box}{Pixel\+Box} Ogre\+::\+Pixel\+Box\+::get\+Sub\+Volume (\begin{DoxyParamCaption}\item[{const \hyperlink{struct_ogre_1_1_box}{Box} \&}]{def,  }\item[{bool}]{reset\+Origin = {\ttfamily true} }\end{DoxyParamCaption}) const}



Return a subvolume of this \hyperlink{class_ogre_1_1_pixel_box}{Pixel\+Box}. 


\begin{DoxyParams}{Parameters}
{\em def} & Defines the bounds of the subregion to return \\
\hline
{\em reset\+Origin} & Whether to reset left/top/front of returned \hyperlink{class_ogre_1_1_pixel_box}{Pixel\+Box} to zero together with adjusting data pointer to compensate this, or do nothing so that returned \hyperlink{class_ogre_1_1_pixel_box}{Pixel\+Box} will have left/top/front of requested \hyperlink{struct_ogre_1_1_box}{Box} \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
A pixel box describing the region and the data in it 
\end{DoxyReturn}
\begin{DoxyRemark}{Remarks}
This function does not copy any data, it just returns a \hyperlink{class_ogre_1_1_pixel_box}{Pixel\+Box} object with a data pointer pointing somewhere inside the data of object. 
\end{DoxyRemark}

\begin{DoxyExceptions}{Exceptions}
{\em Exception(\+E\+R\+R\+\_\+\+I\+N\+V\+A\+L\+I\+D\+P\+A\+R\+A\+M\+S)} & if def is not fully contained \\
\hline
\end{DoxyExceptions}
\mbox{\Hypertarget{class_ogre_1_1_pixel_box_a9bbe10698adab93b479bded30439fb87}\label{class_ogre_1_1_pixel_box_a9bbe10698adab93b479bded30439fb87}} 
\index{Ogre\+::\+Pixel\+Box@{Ogre\+::\+Pixel\+Box}!get\+Top\+Left\+Front\+Pixel\+Ptr@{get\+Top\+Left\+Front\+Pixel\+Ptr}}
\index{get\+Top\+Left\+Front\+Pixel\+Ptr@{get\+Top\+Left\+Front\+Pixel\+Ptr}!Ogre\+::\+Pixel\+Box@{Ogre\+::\+Pixel\+Box}}
\subsubsection{\texorpdfstring{get\+Top\+Left\+Front\+Pixel\+Ptr()}{getTopLeftFrontPixelPtr()}}
{\footnotesize\ttfamily \hyperlink{namespace_ogre_a07f1f7c1d84d58c9beae02e1ebb945e4}{uchar}$\ast$ Ogre\+::\+Pixel\+Box\+::get\+Top\+Left\+Front\+Pixel\+Ptr (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const}



Return a data pointer pointing to top left front pixel of the pixel box. 

\begin{DoxyRemark}{Remarks}
Non consecutive pixel boxes are supported. 
\end{DoxyRemark}
\mbox{\Hypertarget{class_ogre_1_1_pixel_box_a84fd367f9d768e96a98f53cd08c4ab7b}\label{class_ogre_1_1_pixel_box_a84fd367f9d768e96a98f53cd08c4ab7b}} 
\index{Ogre\+::\+Pixel\+Box@{Ogre\+::\+Pixel\+Box}!get\+Colour\+At@{get\+Colour\+At}}
\index{get\+Colour\+At@{get\+Colour\+At}!Ogre\+::\+Pixel\+Box@{Ogre\+::\+Pixel\+Box}}
\subsubsection{\texorpdfstring{get\+Colour\+At()}{getColourAt()}}
{\footnotesize\ttfamily \hyperlink{class_ogre_1_1_colour_value}{Colour\+Value} Ogre\+::\+Pixel\+Box\+::get\+Colour\+At (\begin{DoxyParamCaption}\item[{size\+\_\+t}]{x,  }\item[{size\+\_\+t}]{y,  }\item[{size\+\_\+t}]{z }\end{DoxyParamCaption}) const}



Get colour value from a certain location in the \hyperlink{class_ogre_1_1_pixel_box}{Pixel\+Box}. 

The z coordinate is only valid for cubemaps and volume textures. This uses the first (largest) mipmap. \mbox{\Hypertarget{class_ogre_1_1_pixel_box_ad9be8442d595e5208ea80e59041b59d8}\label{class_ogre_1_1_pixel_box_ad9be8442d595e5208ea80e59041b59d8}} 
\index{Ogre\+::\+Pixel\+Box@{Ogre\+::\+Pixel\+Box}!set\+Colour\+At@{set\+Colour\+At}}
\index{set\+Colour\+At@{set\+Colour\+At}!Ogre\+::\+Pixel\+Box@{Ogre\+::\+Pixel\+Box}}
\subsubsection{\texorpdfstring{set\+Colour\+At()}{setColourAt()}}
{\footnotesize\ttfamily void Ogre\+::\+Pixel\+Box\+::set\+Colour\+At (\begin{DoxyParamCaption}\item[{\hyperlink{class_ogre_1_1_colour_value}{Colour\+Value} const \&}]{cv,  }\item[{size\+\_\+t}]{x,  }\item[{size\+\_\+t}]{y,  }\item[{size\+\_\+t}]{z }\end{DoxyParamCaption})}



Set colour value at a certain location in the \hyperlink{class_ogre_1_1_pixel_box}{Pixel\+Box}. 

The z coordinate is only valid for cubemaps and volume textures. This uses the first (largest) mipmap. \mbox{\Hypertarget{struct_ogre_1_1_box_a7d29d3b112980c25bd0250dc41cf6ed2}\label{struct_ogre_1_1_box_a7d29d3b112980c25bd0250dc41cf6ed2}} 
\index{Ogre\+::\+Pixel\+Box@{Ogre\+::\+Pixel\+Box}!contains@{contains}}
\index{contains@{contains}!Ogre\+::\+Pixel\+Box@{Ogre\+::\+Pixel\+Box}}
\subsubsection{\texorpdfstring{contains()}{contains()}}
{\footnotesize\ttfamily bool Ogre\+::\+Box\+::contains (\begin{DoxyParamCaption}\item[{const \hyperlink{struct_ogre_1_1_box}{Box} \&}]{def }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [inherited]}}



Return true if the other box is a part of this one. 



References Ogre\+::\+Box\+::back, Ogre\+::\+Box\+::bottom, Ogre\+::\+Box\+::front, Ogre\+::\+Box\+::left, Ogre\+::\+Box\+::right, and Ogre\+::\+Box\+::top.

\mbox{\Hypertarget{struct_ogre_1_1_box_a5499449ff454ff98aaa697f8854376fc}\label{struct_ogre_1_1_box_a5499449ff454ff98aaa697f8854376fc}} 
\index{Ogre\+::\+Pixel\+Box@{Ogre\+::\+Pixel\+Box}!get\+Width@{get\+Width}}
\index{get\+Width@{get\+Width}!Ogre\+::\+Pixel\+Box@{Ogre\+::\+Pixel\+Box}}
\subsubsection{\texorpdfstring{get\+Width()}{getWidth()}}
{\footnotesize\ttfamily \hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32} Ogre\+::\+Box\+::get\+Width (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [inherited]}}



Get the width of this box. 

\mbox{\Hypertarget{struct_ogre_1_1_box_a352d26dea0069f2e7f1414e8caa2328c}\label{struct_ogre_1_1_box_a352d26dea0069f2e7f1414e8caa2328c}} 
\index{Ogre\+::\+Pixel\+Box@{Ogre\+::\+Pixel\+Box}!get\+Height@{get\+Height}}
\index{get\+Height@{get\+Height}!Ogre\+::\+Pixel\+Box@{Ogre\+::\+Pixel\+Box}}
\subsubsection{\texorpdfstring{get\+Height()}{getHeight()}}
{\footnotesize\ttfamily \hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32} Ogre\+::\+Box\+::get\+Height (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [inherited]}}



Get the height of this box. 

\mbox{\Hypertarget{struct_ogre_1_1_box_ae820fd38f7b51e2a907ef601642c898c}\label{struct_ogre_1_1_box_ae820fd38f7b51e2a907ef601642c898c}} 
\index{Ogre\+::\+Pixel\+Box@{Ogre\+::\+Pixel\+Box}!get\+Depth@{get\+Depth}}
\index{get\+Depth@{get\+Depth}!Ogre\+::\+Pixel\+Box@{Ogre\+::\+Pixel\+Box}}
\subsubsection{\texorpdfstring{get\+Depth()}{getDepth()}}
{\footnotesize\ttfamily \hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32} Ogre\+::\+Box\+::get\+Depth (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [inherited]}}



Get the depth of this box. 



References Ogre\+::find\+Command\+Line\+Opts(), and Ogre\+::\+Hashed\+Vector$<$ T $>$\+::front().



\subsection{Member Data Documentation}
\mbox{\Hypertarget{class_ogre_1_1_pixel_box_a59624c7c33ade5365428473a1f3dc85a}\label{class_ogre_1_1_pixel_box_a59624c7c33ade5365428473a1f3dc85a}} 
\index{Ogre\+::\+Pixel\+Box@{Ogre\+::\+Pixel\+Box}!data@{data}}
\index{data@{data}!Ogre\+::\+Pixel\+Box@{Ogre\+::\+Pixel\+Box}}
\subsubsection{\texorpdfstring{data}{data}}
{\footnotesize\ttfamily \hyperlink{namespace_ogre_a07f1f7c1d84d58c9beae02e1ebb945e4}{uchar}$\ast$ Ogre\+::\+Pixel\+Box\+::data}



The data pointer. 

\mbox{\Hypertarget{class_ogre_1_1_pixel_box_aa4101fdc288dc41dddac88440b4d0818}\label{class_ogre_1_1_pixel_box_aa4101fdc288dc41dddac88440b4d0818}} 
\index{Ogre\+::\+Pixel\+Box@{Ogre\+::\+Pixel\+Box}!format@{format}}
\index{format@{format}!Ogre\+::\+Pixel\+Box@{Ogre\+::\+Pixel\+Box}}
\subsubsection{\texorpdfstring{format}{format}}
{\footnotesize\ttfamily \hyperlink{group___image_ga7e0353e7d36d4c2e8468641b7303d39c}{Pixel\+Format} Ogre\+::\+Pixel\+Box\+::format}



The pixel format. 

\mbox{\Hypertarget{class_ogre_1_1_pixel_box_aacf8f1ebed40c557389d9d1e9dda3b68}\label{class_ogre_1_1_pixel_box_aacf8f1ebed40c557389d9d1e9dda3b68}} 
\index{Ogre\+::\+Pixel\+Box@{Ogre\+::\+Pixel\+Box}!row\+Pitch@{row\+Pitch}}
\index{row\+Pitch@{row\+Pitch}!Ogre\+::\+Pixel\+Box@{Ogre\+::\+Pixel\+Box}}
\subsubsection{\texorpdfstring{row\+Pitch}{rowPitch}}
{\footnotesize\ttfamily size\+\_\+t Ogre\+::\+Pixel\+Box\+::row\+Pitch}



Number of elements between the leftmost pixel of one row and the left pixel of the next. 

This value must always be equal to \hyperlink{struct_ogre_1_1_box_a5499449ff454ff98aaa697f8854376fc}{get\+Width()} (consecutive) for compressed formats. \mbox{\Hypertarget{class_ogre_1_1_pixel_box_a5f4ac4f2e735678fc8b3ddc1068674dd}\label{class_ogre_1_1_pixel_box_a5f4ac4f2e735678fc8b3ddc1068674dd}} 
\index{Ogre\+::\+Pixel\+Box@{Ogre\+::\+Pixel\+Box}!slice\+Pitch@{slice\+Pitch}}
\index{slice\+Pitch@{slice\+Pitch}!Ogre\+::\+Pixel\+Box@{Ogre\+::\+Pixel\+Box}}
\subsubsection{\texorpdfstring{slice\+Pitch}{slicePitch}}
{\footnotesize\ttfamily size\+\_\+t Ogre\+::\+Pixel\+Box\+::slice\+Pitch}



Number of elements between the top left pixel of one (depth) slice and the top left pixel of the next. 

This can be a negative value. Must be a multiple of row\+Pitch. This value must always be equal to \hyperlink{struct_ogre_1_1_box_a5499449ff454ff98aaa697f8854376fc}{get\+Width()}$\ast$get\+Height() (consecutive) for compressed formats. \mbox{\Hypertarget{struct_ogre_1_1_box_a88fa61f841bc444d92075d8b6cb2b43b}\label{struct_ogre_1_1_box_a88fa61f841bc444d92075d8b6cb2b43b}} 
\index{Ogre\+::\+Pixel\+Box@{Ogre\+::\+Pixel\+Box}!left@{left}}
\index{left@{left}!Ogre\+::\+Pixel\+Box@{Ogre\+::\+Pixel\+Box}}
\subsubsection{\texorpdfstring{left}{left}}
{\footnotesize\ttfamily \hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32} Ogre\+::\+Box\+::left\hspace{0.3cm}{\ttfamily [inherited]}}



Referenced by Ogre\+::\+Box\+::contains().

\mbox{\Hypertarget{struct_ogre_1_1_box_a7c317f774697dbd65dd77e49a0448d2d}\label{struct_ogre_1_1_box_a7c317f774697dbd65dd77e49a0448d2d}} 
\index{Ogre\+::\+Pixel\+Box@{Ogre\+::\+Pixel\+Box}!top@{top}}
\index{top@{top}!Ogre\+::\+Pixel\+Box@{Ogre\+::\+Pixel\+Box}}
\subsubsection{\texorpdfstring{top}{top}}
{\footnotesize\ttfamily \hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32} Ogre\+::\+Box\+::top\hspace{0.3cm}{\ttfamily [inherited]}}



Referenced by Ogre\+::\+Box\+::contains().

\mbox{\Hypertarget{struct_ogre_1_1_box_ac2c94e2d364dfabe7e4406ff8f41ab9e}\label{struct_ogre_1_1_box_ac2c94e2d364dfabe7e4406ff8f41ab9e}} 
\index{Ogre\+::\+Pixel\+Box@{Ogre\+::\+Pixel\+Box}!right@{right}}
\index{right@{right}!Ogre\+::\+Pixel\+Box@{Ogre\+::\+Pixel\+Box}}
\subsubsection{\texorpdfstring{right}{right}}
{\footnotesize\ttfamily \hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32} Ogre\+::\+Box\+::right\hspace{0.3cm}{\ttfamily [inherited]}}



Referenced by Ogre\+::\+Box\+::contains().

\mbox{\Hypertarget{struct_ogre_1_1_box_ae46fa4954b4d29f4d051f947fe45c142}\label{struct_ogre_1_1_box_ae46fa4954b4d29f4d051f947fe45c142}} 
\index{Ogre\+::\+Pixel\+Box@{Ogre\+::\+Pixel\+Box}!bottom@{bottom}}
\index{bottom@{bottom}!Ogre\+::\+Pixel\+Box@{Ogre\+::\+Pixel\+Box}}
\subsubsection{\texorpdfstring{bottom}{bottom}}
{\footnotesize\ttfamily \hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32} Ogre\+::\+Box\+::bottom\hspace{0.3cm}{\ttfamily [inherited]}}



Referenced by Ogre\+::\+Box\+::contains().

\mbox{\Hypertarget{struct_ogre_1_1_box_a5e545a9bd1bc4151a113267c6529d84f}\label{struct_ogre_1_1_box_a5e545a9bd1bc4151a113267c6529d84f}} 
\index{Ogre\+::\+Pixel\+Box@{Ogre\+::\+Pixel\+Box}!front@{front}}
\index{front@{front}!Ogre\+::\+Pixel\+Box@{Ogre\+::\+Pixel\+Box}}
\subsubsection{\texorpdfstring{front}{front}}
{\footnotesize\ttfamily \hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32} Ogre\+::\+Box\+::front\hspace{0.3cm}{\ttfamily [inherited]}}



Referenced by Ogre\+::\+Box\+::contains().

\mbox{\Hypertarget{struct_ogre_1_1_box_a19a7351210e086309a74461d8b4c5cb1}\label{struct_ogre_1_1_box_a19a7351210e086309a74461d8b4c5cb1}} 
\index{Ogre\+::\+Pixel\+Box@{Ogre\+::\+Pixel\+Box}!back@{back}}
\index{back@{back}!Ogre\+::\+Pixel\+Box@{Ogre\+::\+Pixel\+Box}}
\subsubsection{\texorpdfstring{back}{back}}
{\footnotesize\ttfamily \hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32} Ogre\+::\+Box\+::back\hspace{0.3cm}{\ttfamily [inherited]}}



Referenced by Ogre\+::\+Box\+::contains().



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