\hypertarget{class_ogre_1_1_sampler}{}\doxysection{Ogre\+::Sampler Class Reference}
\label{class_ogre_1_1_sampler}\index{Ogre::Sampler@{Ogre::Sampler}}


Class which determines how a \mbox{\hyperlink{class_ogre_1_1_texture_unit_state}{Texture\+Unit\+State}} accesses data from a \mbox{\hyperlink{class_ogre_1_1_texture}{Texture}}.  




{\ttfamily \#include $<$Ogre\+Texture\+Unit\+State.\+h$>$}



Inheritance diagram for Ogre\+::Sampler\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=205pt]{class_ogre_1_1_sampler__inherit__graph}
\end{center}
\end{figure}
\doxysubsection*{Classes}
\begin{DoxyCompactItemize}
\item 
struct \mbox{\hyperlink{struct_ogre_1_1_sampler_1_1_u_v_w_addressing_mode}{U\+V\+W\+Addressing\+Mode}}
\begin{DoxyCompactList}\small\item\em \mbox{\hyperlink{class_ogre_1_1_texture}{Texture}} addressing mode for each texture coordinate. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{class_ogre_1_1_sampler_acbcfa9b8dae52f12cc077eff425af6a2}{Sampler}} ()
\item 
virtual \mbox{\hyperlink{class_ogre_1_1_sampler_a4606d7efa1a28108b224645d69d359a2}{$\sim$\+Sampler}} ()
\item 
const \mbox{\hyperlink{struct_ogre_1_1_sampler_1_1_u_v_w_addressing_mode}{U\+V\+W\+Addressing\+Mode}} \& \mbox{\hyperlink{class_ogre_1_1_sampler_afef71e6b6ce5b1764c15a47940784221}{get\+Addressing\+Mode}} () const
\begin{DoxyCompactList}\small\item\em Gets the texture addressing mode for a given coordinate, i.\+e. \end{DoxyCompactList}\item 
unsigned int \mbox{\hyperlink{class_ogre_1_1_sampler_a807dc33eb657b6d8aca9731f3fb6f134}{get\+Anisotropy}} () const
\begin{DoxyCompactList}\small\item\em Get this layer texture anisotropy level. \end{DoxyCompactList}\item 
const \mbox{\hyperlink{class_ogre_1_1_colour_value}{Colour\+Value}} \& \mbox{\hyperlink{class_ogre_1_1_sampler_a17090adaa3810bc1a6f5b7cf7fd7349f}{get\+Border\+Colour}} (void) const
\item 
bool \mbox{\hyperlink{class_ogre_1_1_sampler_a38050b777e3c0a30269c815d531c21c7}{get\+Compare\+Enabled}} () const
\item 
\mbox{\hyperlink{group___general_ga0212b4eb264f207d84c1df9425208c7a}{Compare\+Function}} \mbox{\hyperlink{class_ogre_1_1_sampler_ac37c40e787eedaca8c4d54b8a2eb1172}{get\+Compare\+Function}} () const
\item 
\mbox{\hyperlink{group___general_ga02306c6246268d35f45ad22278bd5d3d}{Filter\+Options}} \mbox{\hyperlink{class_ogre_1_1_sampler_a75e30d62b25037911d46759fcbdfae9d}{get\+Filtering}} (\mbox{\hyperlink{group___general_gac1fc36ec2f4df4b2afa9fa39f9c66c06}{Filter\+Type}} ftype) const
\begin{DoxyCompactList}\small\item\em Get the texture filtering for the given type. \end{DoxyCompactList}\item 
float \mbox{\hyperlink{class_ogre_1_1_sampler_ad400f0dacb45dd2aad61bafdddffb0ba}{get\+Mipmap\+Bias}} (void) const
\begin{DoxyCompactList}\small\item\em Gets the bias value applied to the mipmap calculation. \end{DoxyCompactList}\item 
void \mbox{\hyperlink{class_ogre_1_1_sampler_a09a88359485c4b4c6ad99b281b251a7d}{set\+Addressing\+Mode}} (const \mbox{\hyperlink{struct_ogre_1_1_sampler_1_1_u_v_w_addressing_mode}{U\+V\+W\+Addressing\+Mode}} \&uvw)
\begin{DoxyCompactList}\small\item\em This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. \end{DoxyCompactList}\item 
void \mbox{\hyperlink{class_ogre_1_1_sampler_a26a2da4bc7463a2629420a3e87714dd4}{set\+Addressing\+Mode}} (\mbox{\hyperlink{group___general_gac224d1943fe269a125e10f02c8b8bc8a}{Texture\+Addressing\+Mode}} tam)
\begin{DoxyCompactList}\small\item\em Sets the texture addressing mode, i.\+e. \end{DoxyCompactList}\item 
void \mbox{\hyperlink{class_ogre_1_1_sampler_aae19b4212e010b077c6d1234026a8537}{set\+Addressing\+Mode}} (\mbox{\hyperlink{group___general_gac224d1943fe269a125e10f02c8b8bc8a}{Texture\+Addressing\+Mode}} u, \mbox{\hyperlink{group___general_gac224d1943fe269a125e10f02c8b8bc8a}{Texture\+Addressing\+Mode}} v, \mbox{\hyperlink{group___general_gac224d1943fe269a125e10f02c8b8bc8a}{Texture\+Addressing\+Mode}} w)
\begin{DoxyCompactList}\small\item\em Sets the texture addressing mode, i.\+e. \end{DoxyCompactList}\item 
void \mbox{\hyperlink{class_ogre_1_1_sampler_a6a00ddb7a41d57cd8e74b34bb605ea49}{set\+Anisotropy}} (unsigned int max\+Aniso)
\begin{DoxyCompactList}\small\item\em Sets the anisotropy level to be used for this texture level. \end{DoxyCompactList}\item 
void \mbox{\hyperlink{class_ogre_1_1_sampler_a12464c79799bab9cc9369ea2e75c14c4}{set\+Border\+Colour}} (const \mbox{\hyperlink{class_ogre_1_1_colour_value}{Colour\+Value}} \&colour)
\begin{DoxyCompactList}\small\item\em Sets the texture border colour. \end{DoxyCompactList}\item 
void \mbox{\hyperlink{class_ogre_1_1_sampler_aa1d394f6b2d85a7cbed7084658a0d036}{set\+Compare\+Enabled}} (bool enabled)
\begin{DoxyCompactList}\small\item\em Enables or disables the comparison test for depth textures. \end{DoxyCompactList}\item 
void \mbox{\hyperlink{class_ogre_1_1_sampler_a9b6200638e877393c6b2f17fa6b92dc7}{set\+Compare\+Function}} (\mbox{\hyperlink{group___general_ga0212b4eb264f207d84c1df9425208c7a}{Compare\+Function}} function)
\item 
void \mbox{\hyperlink{class_ogre_1_1_sampler_abc85e0e16702922d8b32cd096ab45381}{set\+Filtering}} (\mbox{\hyperlink{group___general_ga02306c6246268d35f45ad22278bd5d3d}{Filter\+Options}} min\+Filter, \mbox{\hyperlink{group___general_ga02306c6246268d35f45ad22278bd5d3d}{Filter\+Options}} mag\+Filter, \mbox{\hyperlink{group___general_ga02306c6246268d35f45ad22278bd5d3d}{Filter\+Options}} mip\+Filter)
\begin{DoxyCompactList}\small\item\em Set a the detailed filtering options on this texture unit. \end{DoxyCompactList}\item 
void \mbox{\hyperlink{class_ogre_1_1_sampler_ad92bea43ae76f2dc73c8c555472bbc2d}{set\+Filtering}} (\mbox{\hyperlink{group___general_gac1fc36ec2f4df4b2afa9fa39f9c66c06}{Filter\+Type}} ftype, \mbox{\hyperlink{group___general_ga02306c6246268d35f45ad22278bd5d3d}{Filter\+Options}} opts)
\begin{DoxyCompactList}\small\item\em Set a single filtering option on this texture unit. \end{DoxyCompactList}\item 
void \mbox{\hyperlink{class_ogre_1_1_sampler_ab312ebf1f95a692d266ad99ff2923bb7}{set\+Filtering}} (\mbox{\hyperlink{group___general_ga21a0186392e9c9ce16d29c5568a773c5}{Texture\+Filter\+Options}} filter\+Type)
\begin{DoxyCompactList}\small\item\em Set the texture filtering for this unit, using the simplified interface. \end{DoxyCompactList}\item 
void \mbox{\hyperlink{class_ogre_1_1_sampler_a8486e32aaa07278882e46877b3fc3d17}{set\+Mipmap\+Bias}} (float bias)
\begin{DoxyCompactList}\small\item\em Sets the bias value applied to the mipmap calculation. \end{DoxyCompactList}\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
Class which determines how a \mbox{\hyperlink{class_ogre_1_1_texture_unit_state}{Texture\+Unit\+State}} accesses data from a \mbox{\hyperlink{class_ogre_1_1_texture}{Texture}}. 

There are a number of parameters affecting how texture data is featched. Most notably \mbox{\hyperlink{group___general_ga02306c6246268d35f45ad22278bd5d3d}{Filter\+Options}} and \mbox{\hyperlink{group___general_gac224d1943fe269a125e10f02c8b8bc8a}{Texture\+Addressing\+Mode}}. 

\doxysubsection{Constructor \& Destructor Documentation}
\mbox{\Hypertarget{class_ogre_1_1_sampler_acbcfa9b8dae52f12cc077eff425af6a2}\label{class_ogre_1_1_sampler_acbcfa9b8dae52f12cc077eff425af6a2}} 
\index{Ogre::Sampler@{Ogre::Sampler}!Sampler@{Sampler}}
\index{Sampler@{Sampler}!Ogre::Sampler@{Ogre::Sampler}}
\doxysubsubsection{\texorpdfstring{Sampler()}{Sampler()}}
{\footnotesize\ttfamily Ogre\+::\+Sampler\+::\+Sampler (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}

\mbox{\Hypertarget{class_ogre_1_1_sampler_a4606d7efa1a28108b224645d69d359a2}\label{class_ogre_1_1_sampler_a4606d7efa1a28108b224645d69d359a2}} 
\index{Ogre::Sampler@{Ogre::Sampler}!````~Sampler@{$\sim$Sampler}}
\index{````~Sampler@{$\sim$Sampler}!Ogre::Sampler@{Ogre::Sampler}}
\doxysubsubsection{\texorpdfstring{$\sim$Sampler()}{~Sampler()}}
{\footnotesize\ttfamily virtual Ogre\+::\+Sampler\+::$\sim$\+Sampler (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



\doxysubsection{Member Function Documentation}
\mbox{\Hypertarget{class_ogre_1_1_sampler_ab312ebf1f95a692d266ad99ff2923bb7}\label{class_ogre_1_1_sampler_ab312ebf1f95a692d266ad99ff2923bb7}} 
\index{Ogre::Sampler@{Ogre::Sampler}!setFiltering@{setFiltering}}
\index{setFiltering@{setFiltering}!Ogre::Sampler@{Ogre::Sampler}}
\doxysubsubsection{\texorpdfstring{setFiltering()}{setFiltering()}\hspace{0.1cm}{\footnotesize\ttfamily [1/3]}}
{\footnotesize\ttfamily void Ogre\+::\+Sampler\+::set\+Filtering (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group___general_ga21a0186392e9c9ce16d29c5568a773c5}{Texture\+Filter\+Options}}}]{filter\+Type }\end{DoxyParamCaption})}



Set the texture filtering for this unit, using the simplified interface. 

You also have the option of specifying the minification, magnification and mip filter individually if you want more control over filtering options. See the alternative set\+Texture\+Filtering methods for details. 
\begin{DoxyParams}{Parameters}
{\em filter\+Type} & The high-\/level filter type to use. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{class_ogre_1_1_sampler_ad92bea43ae76f2dc73c8c555472bbc2d}\label{class_ogre_1_1_sampler_ad92bea43ae76f2dc73c8c555472bbc2d}} 
\index{Ogre::Sampler@{Ogre::Sampler}!setFiltering@{setFiltering}}
\index{setFiltering@{setFiltering}!Ogre::Sampler@{Ogre::Sampler}}
\doxysubsubsection{\texorpdfstring{setFiltering()}{setFiltering()}\hspace{0.1cm}{\footnotesize\ttfamily [2/3]}}
{\footnotesize\ttfamily void Ogre\+::\+Sampler\+::set\+Filtering (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group___general_gac1fc36ec2f4df4b2afa9fa39f9c66c06}{Filter\+Type}}}]{ftype,  }\item[{\mbox{\hyperlink{group___general_ga02306c6246268d35f45ad22278bd5d3d}{Filter\+Options}}}]{opts }\end{DoxyParamCaption})}



Set a single filtering option on this texture unit. 


\begin{DoxyParams}{Parameters}
{\em ftype} & The filtering type to set. \\
\hline
{\em opts} & The filtering option to set. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{class_ogre_1_1_sampler_abc85e0e16702922d8b32cd096ab45381}\label{class_ogre_1_1_sampler_abc85e0e16702922d8b32cd096ab45381}} 
\index{Ogre::Sampler@{Ogre::Sampler}!setFiltering@{setFiltering}}
\index{setFiltering@{setFiltering}!Ogre::Sampler@{Ogre::Sampler}}
\doxysubsubsection{\texorpdfstring{setFiltering()}{setFiltering()}\hspace{0.1cm}{\footnotesize\ttfamily [3/3]}}
{\footnotesize\ttfamily void Ogre\+::\+Sampler\+::set\+Filtering (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group___general_ga02306c6246268d35f45ad22278bd5d3d}{Filter\+Options}}}]{min\+Filter,  }\item[{\mbox{\hyperlink{group___general_ga02306c6246268d35f45ad22278bd5d3d}{Filter\+Options}}}]{mag\+Filter,  }\item[{\mbox{\hyperlink{group___general_ga02306c6246268d35f45ad22278bd5d3d}{Filter\+Options}}}]{mip\+Filter }\end{DoxyParamCaption})}



Set a the detailed filtering options on this texture unit. 


\begin{DoxyParams}{Parameters}
{\em min\+Filter} & The filtering to use when reducing the size of the texture. Can be \mbox{\hyperlink{group___general_gga02306c6246268d35f45ad22278bd5d3dad299986d6ba4f220cc628a1b9a4f6a52}{Ogre\+::\+F\+O\+\_\+\+P\+O\+I\+NT}}, \mbox{\hyperlink{group___general_gga02306c6246268d35f45ad22278bd5d3da6b0e1f92a9531879e2f0acfe5e5183c6}{Ogre\+::\+F\+O\+\_\+\+L\+I\+N\+E\+AR}} or \mbox{\hyperlink{group___general_gga02306c6246268d35f45ad22278bd5d3da0ced0c8e18f83505a73c7275563d4372}{Ogre\+::\+F\+O\+\_\+\+A\+N\+I\+S\+O\+T\+R\+O\+P\+IC}}. \\
\hline
{\em mag\+Filter} & The filtering to use when increasing the size of the texture. Can be \mbox{\hyperlink{group___general_gga02306c6246268d35f45ad22278bd5d3dad299986d6ba4f220cc628a1b9a4f6a52}{Ogre\+::\+F\+O\+\_\+\+P\+O\+I\+NT}}, \mbox{\hyperlink{group___general_gga02306c6246268d35f45ad22278bd5d3da6b0e1f92a9531879e2f0acfe5e5183c6}{Ogre\+::\+F\+O\+\_\+\+L\+I\+N\+E\+AR}} or \mbox{\hyperlink{group___general_gga02306c6246268d35f45ad22278bd5d3da0ced0c8e18f83505a73c7275563d4372}{Ogre\+::\+F\+O\+\_\+\+A\+N\+I\+S\+O\+T\+R\+O\+P\+IC}}. \\
\hline
{\em mip\+Filter} & The filtering to use between mip levels. Can be \mbox{\hyperlink{group___general_gga02306c6246268d35f45ad22278bd5d3da0be36e268ed5d2d25fe91ba5b5f769b5}{Ogre\+::\+F\+O\+\_\+\+N\+O\+NE}} (turns off mipmapping), \mbox{\hyperlink{group___general_gga02306c6246268d35f45ad22278bd5d3dad299986d6ba4f220cc628a1b9a4f6a52}{Ogre\+::\+F\+O\+\_\+\+P\+O\+I\+NT}} or \mbox{\hyperlink{group___general_gga02306c6246268d35f45ad22278bd5d3da6b0e1f92a9531879e2f0acfe5e5183c6}{Ogre\+::\+F\+O\+\_\+\+L\+I\+N\+E\+AR}} (trilinear filtering). \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{class_ogre_1_1_sampler_a75e30d62b25037911d46759fcbdfae9d}\label{class_ogre_1_1_sampler_a75e30d62b25037911d46759fcbdfae9d}} 
\index{Ogre::Sampler@{Ogre::Sampler}!getFiltering@{getFiltering}}
\index{getFiltering@{getFiltering}!Ogre::Sampler@{Ogre::Sampler}}
\doxysubsubsection{\texorpdfstring{getFiltering()}{getFiltering()}}
{\footnotesize\ttfamily \mbox{\hyperlink{group___general_ga02306c6246268d35f45ad22278bd5d3d}{Filter\+Options}} Ogre\+::\+Sampler\+::get\+Filtering (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group___general_gac1fc36ec2f4df4b2afa9fa39f9c66c06}{Filter\+Type}}}]{ftype }\end{DoxyParamCaption}) const}



Get the texture filtering for the given type. 

\mbox{\Hypertarget{class_ogre_1_1_sampler_afef71e6b6ce5b1764c15a47940784221}\label{class_ogre_1_1_sampler_afef71e6b6ce5b1764c15a47940784221}} 
\index{Ogre::Sampler@{Ogre::Sampler}!getAddressingMode@{getAddressingMode}}
\index{getAddressingMode@{getAddressingMode}!Ogre::Sampler@{Ogre::Sampler}}
\doxysubsubsection{\texorpdfstring{getAddressingMode()}{getAddressingMode()}}
{\footnotesize\ttfamily const \mbox{\hyperlink{struct_ogre_1_1_sampler_1_1_u_v_w_addressing_mode}{U\+V\+W\+Addressing\+Mode}}\& Ogre\+::\+Sampler\+::get\+Addressing\+Mode (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Gets the texture addressing mode for a given coordinate, i.\+e. 

what happens at uv values above 1.\+0. \begin{DoxyNote}{Note}
The default is T\+A\+M\+\_\+\+W\+R\+AP i.\+e. the texture repeats over values of 1.\+0. 
\end{DoxyNote}
\mbox{\Hypertarget{class_ogre_1_1_sampler_a26a2da4bc7463a2629420a3e87714dd4}\label{class_ogre_1_1_sampler_a26a2da4bc7463a2629420a3e87714dd4}} 
\index{Ogre::Sampler@{Ogre::Sampler}!setAddressingMode@{setAddressingMode}}
\index{setAddressingMode@{setAddressingMode}!Ogre::Sampler@{Ogre::Sampler}}
\doxysubsubsection{\texorpdfstring{setAddressingMode()}{setAddressingMode()}\hspace{0.1cm}{\footnotesize\ttfamily [1/3]}}
{\footnotesize\ttfamily void Ogre\+::\+Sampler\+::set\+Addressing\+Mode (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group___general_gac224d1943fe269a125e10f02c8b8bc8a}{Texture\+Addressing\+Mode}}}]{tam }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Sets the texture addressing mode, i.\+e. 

what happens at uv values above 1.\+0.

The default is T\+A\+M\+\_\+\+W\+R\+AP i.\+e. the texture repeats over values of 1.\+0. This is a shortcut method which sets the addressing mode for all coordinates at once; you can also call the more specific method to set the addressing mode per coordinate.

This is a shortcut method which sets the addressing mode for all coordinates at once; you can also call the more specific method to set the addressing mode per coordinate. 

References set\+Addressing\+Mode().



Referenced by set\+Addressing\+Mode().

\mbox{\Hypertarget{class_ogre_1_1_sampler_aae19b4212e010b077c6d1234026a8537}\label{class_ogre_1_1_sampler_aae19b4212e010b077c6d1234026a8537}} 
\index{Ogre::Sampler@{Ogre::Sampler}!setAddressingMode@{setAddressingMode}}
\index{setAddressingMode@{setAddressingMode}!Ogre::Sampler@{Ogre::Sampler}}
\doxysubsubsection{\texorpdfstring{setAddressingMode()}{setAddressingMode()}\hspace{0.1cm}{\footnotesize\ttfamily [2/3]}}
{\footnotesize\ttfamily void Ogre\+::\+Sampler\+::set\+Addressing\+Mode (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group___general_gac224d1943fe269a125e10f02c8b8bc8a}{Texture\+Addressing\+Mode}}}]{u,  }\item[{\mbox{\hyperlink{group___general_gac224d1943fe269a125e10f02c8b8bc8a}{Texture\+Addressing\+Mode}}}]{v,  }\item[{\mbox{\hyperlink{group___general_gac224d1943fe269a125e10f02c8b8bc8a}{Texture\+Addressing\+Mode}}}]{w }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Sets the texture addressing mode, i.\+e. 

what happens at uv values above 1.\+0.

The default is \mbox{\hyperlink{group___general_ggac224d1943fe269a125e10f02c8b8bc8aa3bb58c51abf3cfc17a3a161a8ad2e69c}{T\+A\+M\+\_\+\+W\+R\+AP}} i.\+e. the texture repeats over values of 1.\+0. \mbox{\Hypertarget{class_ogre_1_1_sampler_a09a88359485c4b4c6ad99b281b251a7d}\label{class_ogre_1_1_sampler_a09a88359485c4b4c6ad99b281b251a7d}} 
\index{Ogre::Sampler@{Ogre::Sampler}!setAddressingMode@{setAddressingMode}}
\index{setAddressingMode@{setAddressingMode}!Ogre::Sampler@{Ogre::Sampler}}
\doxysubsubsection{\texorpdfstring{setAddressingMode()}{setAddressingMode()}\hspace{0.1cm}{\footnotesize\ttfamily [3/3]}}
{\footnotesize\ttfamily void Ogre\+::\+Sampler\+::set\+Addressing\+Mode (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{struct_ogre_1_1_sampler_1_1_u_v_w_addressing_mode}{U\+V\+W\+Addressing\+Mode}} \&}]{uvw }\end{DoxyParamCaption})}



This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. 

\mbox{\Hypertarget{class_ogre_1_1_sampler_a6a00ddb7a41d57cd8e74b34bb605ea49}\label{class_ogre_1_1_sampler_a6a00ddb7a41d57cd8e74b34bb605ea49}} 
\index{Ogre::Sampler@{Ogre::Sampler}!setAnisotropy@{setAnisotropy}}
\index{setAnisotropy@{setAnisotropy}!Ogre::Sampler@{Ogre::Sampler}}
\doxysubsubsection{\texorpdfstring{setAnisotropy()}{setAnisotropy()}}
{\footnotesize\ttfamily void Ogre\+::\+Sampler\+::set\+Anisotropy (\begin{DoxyParamCaption}\item[{unsigned int}]{max\+Aniso }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Sets the anisotropy level to be used for this texture level. 

The degree of anisotropy is the ratio between the height of the texture segment visible in a screen space region versus the width -\/ so for example a floor plane, which stretches on into the distance and thus the vertical texture coordinates change much faster than the horizontal ones, has a higher anisotropy than a wall which is facing you head on (which has an anisotropy of 1 if your line of sight is perfectly perpendicular to it).The maximum value is determined by the hardware, but it is usually 8 or 16.

In order for this to be used, you have to set the minification and/or the magnification option on this texture to \mbox{\hyperlink{group___general_gga02306c6246268d35f45ad22278bd5d3da0ced0c8e18f83505a73c7275563d4372}{Ogre\+::\+F\+O\+\_\+\+A\+N\+I\+S\+O\+T\+R\+O\+P\+IC}}. 
\begin{DoxyParams}{Parameters}
{\em max\+Aniso} & The maximal anisotropy level, should be between 2 and the maximum supported by hardware (1 is the default, ie. no anisotrophy). \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{class_ogre_1_1_sampler_a807dc33eb657b6d8aca9731f3fb6f134}\label{class_ogre_1_1_sampler_a807dc33eb657b6d8aca9731f3fb6f134}} 
\index{Ogre::Sampler@{Ogre::Sampler}!getAnisotropy@{getAnisotropy}}
\index{getAnisotropy@{getAnisotropy}!Ogre::Sampler@{Ogre::Sampler}}
\doxysubsubsection{\texorpdfstring{getAnisotropy()}{getAnisotropy()}}
{\footnotesize\ttfamily unsigned int Ogre\+::\+Sampler\+::get\+Anisotropy (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Get this layer texture anisotropy level. 

\mbox{\Hypertarget{class_ogre_1_1_sampler_a8486e32aaa07278882e46877b3fc3d17}\label{class_ogre_1_1_sampler_a8486e32aaa07278882e46877b3fc3d17}} 
\index{Ogre::Sampler@{Ogre::Sampler}!setMipmapBias@{setMipmapBias}}
\index{setMipmapBias@{setMipmapBias}!Ogre::Sampler@{Ogre::Sampler}}
\doxysubsubsection{\texorpdfstring{setMipmapBias()}{setMipmapBias()}}
{\footnotesize\ttfamily void Ogre\+::\+Sampler\+::set\+Mipmap\+Bias (\begin{DoxyParamCaption}\item[{float}]{bias }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Sets the bias value applied to the mipmap calculation. 

You can alter the mipmap calculation by biasing the result with a single floating point value. After the mip level has been calculated, this bias value is added to the result to give the final mip level. Lower mip levels are larger (higher detail), so a negative bias will force the larger mip levels to be used, and a positive bias will cause smaller mip levels to be used. The bias values are in mip levels, so a -\/1 bias will force mip levels one larger than by the default calculation.

In order for this option to be used, your hardware has to support mipmap biasing (exposed through \mbox{\hyperlink{group___render_system_gga3d2965b7f378ebdcfe8a4a6cf74c3de7a059362950c064bfe870e5fe60b56a3ca}{Ogre\+::\+R\+S\+C\+\_\+\+M\+I\+P\+M\+A\+P\+\_\+\+L\+O\+D\+\_\+\+B\+I\+AS}}), and your minification filtering has to be set to point or linear. \mbox{\Hypertarget{class_ogre_1_1_sampler_ad400f0dacb45dd2aad61bafdddffb0ba}\label{class_ogre_1_1_sampler_ad400f0dacb45dd2aad61bafdddffb0ba}} 
\index{Ogre::Sampler@{Ogre::Sampler}!getMipmapBias@{getMipmapBias}}
\index{getMipmapBias@{getMipmapBias}!Ogre::Sampler@{Ogre::Sampler}}
\doxysubsubsection{\texorpdfstring{getMipmapBias()}{getMipmapBias()}}
{\footnotesize\ttfamily float Ogre\+::\+Sampler\+::get\+Mipmap\+Bias (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Gets the bias value applied to the mipmap calculation. 

\begin{DoxySeeAlso}{See also}
\mbox{\hyperlink{class_ogre_1_1_texture_unit_state_acfe54cc0ec2c1247a90094d004d77db1}{Texture\+Unit\+State\+::set\+Texture\+Mipmap\+Bias}} 
\end{DoxySeeAlso}
\mbox{\Hypertarget{class_ogre_1_1_sampler_aa1d394f6b2d85a7cbed7084658a0d036}\label{class_ogre_1_1_sampler_aa1d394f6b2d85a7cbed7084658a0d036}} 
\index{Ogre::Sampler@{Ogre::Sampler}!setCompareEnabled@{setCompareEnabled}}
\index{setCompareEnabled@{setCompareEnabled}!Ogre::Sampler@{Ogre::Sampler}}
\doxysubsubsection{\texorpdfstring{setCompareEnabled()}{setCompareEnabled()}}
{\footnotesize\ttfamily void Ogre\+::\+Sampler\+::set\+Compare\+Enabled (\begin{DoxyParamCaption}\item[{bool}]{enabled }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Enables or disables the comparison test for depth textures. 

When enabled, sampling the texture returns how the sampled value compares against a reference value instead of the sampled value itself. Combined with linear filtering this can be used to implement hardware P\+CF for shadow maps. \mbox{\Hypertarget{class_ogre_1_1_sampler_a38050b777e3c0a30269c815d531c21c7}\label{class_ogre_1_1_sampler_a38050b777e3c0a30269c815d531c21c7}} 
\index{Ogre::Sampler@{Ogre::Sampler}!getCompareEnabled@{getCompareEnabled}}
\index{getCompareEnabled@{getCompareEnabled}!Ogre::Sampler@{Ogre::Sampler}}
\doxysubsubsection{\texorpdfstring{getCompareEnabled()}{getCompareEnabled()}}
{\footnotesize\ttfamily bool Ogre\+::\+Sampler\+::get\+Compare\+Enabled (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}

\mbox{\Hypertarget{class_ogre_1_1_sampler_a9b6200638e877393c6b2f17fa6b92dc7}\label{class_ogre_1_1_sampler_a9b6200638e877393c6b2f17fa6b92dc7}} 
\index{Ogre::Sampler@{Ogre::Sampler}!setCompareFunction@{setCompareFunction}}
\index{setCompareFunction@{setCompareFunction}!Ogre::Sampler@{Ogre::Sampler}}
\doxysubsubsection{\texorpdfstring{setCompareFunction()}{setCompareFunction()}}
{\footnotesize\ttfamily void Ogre\+::\+Sampler\+::set\+Compare\+Function (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{group___general_ga0212b4eb264f207d84c1df9425208c7a}{Compare\+Function}}}]{function }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}

\mbox{\Hypertarget{class_ogre_1_1_sampler_ac37c40e787eedaca8c4d54b8a2eb1172}\label{class_ogre_1_1_sampler_ac37c40e787eedaca8c4d54b8a2eb1172}} 
\index{Ogre::Sampler@{Ogre::Sampler}!getCompareFunction@{getCompareFunction}}
\index{getCompareFunction@{getCompareFunction}!Ogre::Sampler@{Ogre::Sampler}}
\doxysubsubsection{\texorpdfstring{getCompareFunction()}{getCompareFunction()}}
{\footnotesize\ttfamily \mbox{\hyperlink{group___general_ga0212b4eb264f207d84c1df9425208c7a}{Compare\+Function}} Ogre\+::\+Sampler\+::get\+Compare\+Function (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}

\mbox{\Hypertarget{class_ogre_1_1_sampler_a12464c79799bab9cc9369ea2e75c14c4}\label{class_ogre_1_1_sampler_a12464c79799bab9cc9369ea2e75c14c4}} 
\index{Ogre::Sampler@{Ogre::Sampler}!setBorderColour@{setBorderColour}}
\index{setBorderColour@{setBorderColour}!Ogre::Sampler@{Ogre::Sampler}}
\doxysubsubsection{\texorpdfstring{setBorderColour()}{setBorderColour()}}
{\footnotesize\ttfamily void Ogre\+::\+Sampler\+::set\+Border\+Colour (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{class_ogre_1_1_colour_value}{Colour\+Value}} \&}]{colour }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Sets the texture border colour. 

The default is \mbox{\hyperlink{class_ogre_1_1_colour_value_a7f8a06f2a9dd645417c36b560f496c1a}{Colour\+Value\+::\+Black}}, and this value only used when addressing mode is T\+A\+M\+\_\+\+B\+O\+R\+D\+ER. \mbox{\Hypertarget{class_ogre_1_1_sampler_a17090adaa3810bc1a6f5b7cf7fd7349f}\label{class_ogre_1_1_sampler_a17090adaa3810bc1a6f5b7cf7fd7349f}} 
\index{Ogre::Sampler@{Ogre::Sampler}!getBorderColour@{getBorderColour}}
\index{getBorderColour@{getBorderColour}!Ogre::Sampler@{Ogre::Sampler}}
\doxysubsubsection{\texorpdfstring{getBorderColour()}{getBorderColour()}}
{\footnotesize\ttfamily const \mbox{\hyperlink{class_ogre_1_1_colour_value}{Colour\+Value}}\& Ogre\+::\+Sampler\+::get\+Border\+Colour (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{_ogre_texture_unit_state_8h}{Ogre\+Texture\+Unit\+State.\+h}}\end{DoxyCompactItemize}
