glm/doc/html/a00112_source.html

262 lines
23 KiB
HTML
Raw Normal View History

2010-04-29 10:54:07 +00:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>GLM: type_vec1.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File&nbsp;List</span></a></li>
</ul>
</div>
<h1>type_vec1.hpp</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001
<a name="l00002"></a>00002 <span class="comment">// OpenGL Mathematics Copyright (c) 2005 - 2009 G-Truc Creation (www.g-truc.net)</span>
<a name="l00004"></a>00004 <span class="comment"></span><span class="comment">// Created : 2008-08-25</span>
<a name="l00005"></a>00005 <span class="comment">// Updated : 2008-08-31</span>
<a name="l00006"></a>00006 <span class="comment">// Licence : This source is under MIT License</span>
<a name="l00007"></a>00007 <span class="comment">// File : glm/core/type_vec1.h</span>
<a name="l00009"></a>00009 <span class="comment"></span>
<a name="l00010"></a>00010 <span class="preprocessor">#ifndef glm_core_type_gentype1</span>
<a name="l00011"></a>00011 <span class="preprocessor"></span><span class="preprocessor">#define glm_core_type_gentype1</span>
<a name="l00012"></a>00012 <span class="preprocessor"></span>
<a name="l00013"></a>00013 <span class="preprocessor">#include &quot;type_float.hpp&quot;</span>
<a name="l00014"></a>00014 <span class="preprocessor">#include &quot;type_int.hpp&quot;</span>
<a name="l00015"></a>00015 <span class="preprocessor">#include &quot;type_size.hpp&quot;</span>
<a name="l00016"></a>00016 <span class="preprocessor">#include &quot;_swizzle.hpp&quot;</span>
<a name="l00017"></a>00017
<a name="l00018"></a>00018 <span class="keyword">namespace </span>glm
<a name="l00019"></a>00019 {
<a name="l00020"></a>00020 <span class="keyword">namespace </span>test
<a name="l00021"></a>00021 {
<a name="l00022"></a>00022 <span class="keywordtype">void</span> main_vec1();
<a name="l00023"></a>00023 }<span class="comment">//namespace test</span>
<a name="l00024"></a>00024
<a name="l00025"></a>00025 <span class="keyword">namespace </span>detail
<a name="l00026"></a>00026 {
<a name="l00027"></a>00027 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt; <span class="keyword">struct </span>tref1;
<a name="l00028"></a>00028 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt; <span class="keyword">struct </span>tref2;
<a name="l00029"></a>00029 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt; <span class="keyword">struct </span>tref3;
<a name="l00030"></a>00030 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt; <span class="keyword">struct </span>tref4;
<a name="l00031"></a>00031 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt; <span class="keyword">struct </span>tvec1;
<a name="l00032"></a>00032 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt; <span class="keyword">struct </span>tvec2;
<a name="l00033"></a>00033 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt; <span class="keyword">struct </span>tvec3;
<a name="l00034"></a>00034 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt; <span class="keyword">struct </span>tvec4;
<a name="l00035"></a>00035
<a name="l00036"></a>00036 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> valType&gt;
<a name="l00037"></a>00037 <span class="keyword">struct </span>tvec1
<a name="l00038"></a>00038 {
<a name="l00040"></a>00040 <span class="comment">// Typedef (Implementation details)</span>
<a name="l00041"></a>00041
<a name="l00042"></a>00042 <span class="keyword">typedef</span> valType value_type;
<a name="l00043"></a>00043 <span class="keyword">typedef</span> valType&amp; value_reference;
<a name="l00044"></a>00044 <span class="keyword">typedef</span> valType* value_pointer;
<a name="l00045"></a>00045 <span class="keyword">typedef</span> tvec1&lt;bool&gt; bool_type;
<a name="l00046"></a>00046
<a name="l00047"></a>00047 <span class="keyword">typedef</span> glm::sizeType size_type;
<a name="l00048"></a>00048 <span class="keyword">static</span> size_type value_size();
<a name="l00049"></a>00049 <span class="keyword">static</span> <span class="keywordtype">bool</span> is_vector();
<a name="l00050"></a>00050
<a name="l00051"></a>00051 <span class="keyword">typedef</span> tvec1&lt;valType&gt; type;
<a name="l00052"></a>00052 <span class="keyword">typedef</span> tvec1&lt;valType&gt;* pointer;
<a name="l00053"></a>00053 <span class="keyword">typedef</span> <span class="keyword">const</span> tvec1&lt;valType&gt;* const_pointer;
<a name="l00054"></a>00054 <span class="keyword">typedef</span> <span class="keyword">const</span> tvec1&lt;valType&gt;*<span class="keyword">const</span> const_pointer_const;
<a name="l00055"></a>00055 <span class="keyword">typedef</span> tvec1&lt;valType&gt;*<span class="keyword">const</span> pointer_const;
<a name="l00056"></a>00056 <span class="keyword">typedef</span> tvec1&lt;valType&gt;&amp; reference;
<a name="l00057"></a>00057 <span class="keyword">typedef</span> <span class="keyword">const</span> tvec1&lt;valType&gt;&amp; const_reference;
<a name="l00058"></a>00058 <span class="keyword">typedef</span> <span class="keyword">const</span> tvec1&lt;valType&gt;&amp; param_type;
<a name="l00059"></a>00059
<a name="l00061"></a>00061 <span class="comment">// Data</span>
<a name="l00062"></a>00062
<a name="l00063"></a>00063 <span class="preprocessor"># if defined(GLM_USE_ONLY_XYZW)</span>
<a name="l00064"></a>00064 <span class="preprocessor"></span> value_type x, y;
<a name="l00065"></a>00065 <span class="preprocessor"># else//GLM_USE_ONLY_XYZW</span>
<a name="l00066"></a>00066 <span class="preprocessor"></span> <span class="keyword">union </span>{value_type x, r, s;};
<a name="l00067"></a>00067 <span class="preprocessor"># endif//GLM_USE_ONLY_XYZW</span>
<a name="l00068"></a>00068 <span class="preprocessor"></span>
<a name="l00070"></a>00070 <span class="comment">// Accesses</span>
<a name="l00071"></a>00071
<a name="l00072"></a>00072 valType&amp; operator[](size_type i);
<a name="l00073"></a>00073 valType <span class="keyword">const</span> &amp; operator[](size_type i) <span class="keyword">const</span>;
<a name="l00074"></a>00074
<a name="l00076"></a>00076 <span class="comment">// Address (Implementation details)</span>
<a name="l00077"></a>00077
<a name="l00078"></a>00078 <span class="keyword">const</span> value_type* _address()<span class="keyword"> const</span>{<span class="keywordflow">return</span> (value_type*)(<span class="keyword">this</span>);}
<a name="l00079"></a>00079 value_type* _address(){<span class="keywordflow">return</span> (value_type*)(<span class="keyword">this</span>);}
<a name="l00080"></a>00080
<a name="l00082"></a>00082 <span class="comment">// Implicit basic constructors</span>
<a name="l00083"></a>00083
<a name="l00084"></a>00084 tvec1();
<a name="l00085"></a>00085 tvec1(<span class="keyword">const</span> tvec1&lt;valType&gt;&amp; v);
<a name="l00086"></a>00086
<a name="l00088"></a>00088 <span class="comment">// Explicit basic constructors</span>
<a name="l00089"></a>00089
<a name="l00090"></a>00090 tvec1(valType s);
<a name="l00091"></a>00091
<a name="l00093"></a>00093 <span class="comment">// Swizzle constructors</span>
<a name="l00094"></a>00094
<a name="l00095"></a>00095 tvec1(<span class="keyword">const</span> tref1&lt;valType&gt;&amp; r);
<a name="l00096"></a>00096
<a name="l00098"></a>00098 <span class="comment">// Convertion scalar constructors</span>
<a name="l00099"></a>00099
<a name="l00101"></a>00101 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> U&gt;
<a name="l00102"></a>00102 <span class="keyword">explicit</span> tvec1(U x);
<a name="l00103"></a>00103
<a name="l00105"></a>00105 <span class="comment">// Convertion vector constructors</span>
<a name="l00106"></a>00106
<a name="l00108"></a>00108 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> U&gt;
<a name="l00109"></a>00109 <span class="keyword">explicit</span> tvec1(<span class="keyword">const</span> tvec2&lt;U&gt;&amp; v);
<a name="l00111"></a>00111 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> U&gt;
<a name="l00112"></a>00112 <span class="keyword">explicit</span> tvec1(<span class="keyword">const</span> tvec3&lt;U&gt;&amp; v);
<a name="l00114"></a>00114 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> U&gt;
<a name="l00115"></a>00115 <span class="keyword">explicit</span> tvec1(<span class="keyword">const</span> tvec4&lt;U&gt;&amp; v);
<a name="l00116"></a>00116
<a name="l00118"></a>00118 <span class="comment">// Unary arithmetic operators</span>
<a name="l00119"></a>00119
<a name="l00120"></a>00120 tvec1&lt;valType&gt;&amp; operator= (<span class="keyword">const</span> tvec1&lt;valType&gt;&amp; v);
<a name="l00121"></a>00121
<a name="l00122"></a>00122 tvec1&lt;valType&gt;&amp; operator+=(valType <span class="keyword">const</span> &amp; s);
<a name="l00123"></a>00123 tvec1&lt;valType&gt;&amp; operator+=(<span class="keyword">const</span> tvec1&lt;valType&gt;&amp; v);
<a name="l00124"></a>00124 tvec1&lt;valType&gt;&amp; operator-=(valType <span class="keyword">const</span> &amp; s);
<a name="l00125"></a>00125 tvec1&lt;valType&gt;&amp; operator-=(<span class="keyword">const</span> tvec1&lt;valType&gt;&amp; v);
<a name="l00126"></a>00126 tvec1&lt;valType&gt;&amp; operator*=(valType <span class="keyword">const</span> &amp; s);
<a name="l00127"></a>00127 tvec1&lt;valType&gt;&amp; operator*=(<span class="keyword">const</span> tvec1&lt;valType&gt;&amp; v);
<a name="l00128"></a>00128 tvec1&lt;valType&gt;&amp; operator/=(valType <span class="keyword">const</span> &amp; s);
<a name="l00129"></a>00129 tvec1&lt;valType&gt;&amp; operator/=(<span class="keyword">const</span> tvec1&lt;valType&gt;&amp; v);
<a name="l00130"></a>00130 tvec1&lt;valType&gt;&amp; operator++();
<a name="l00131"></a>00131 tvec1&lt;valType&gt;&amp; operator--();
<a name="l00132"></a>00132
<a name="l00134"></a>00134 <span class="comment">// Unary bit operators</span>
<a name="l00135"></a>00135
<a name="l00136"></a>00136 tvec1&lt;valType&gt;&amp; operator%=(valType <span class="keyword">const</span> &amp; s);
<a name="l00137"></a>00137 tvec1&lt;valType&gt;&amp; operator%=(<span class="keyword">const</span> tvec1&lt;valType&gt;&amp; v);
<a name="l00138"></a>00138 tvec1&lt;valType&gt;&amp; operator&amp;=(valType <span class="keyword">const</span> &amp; s);
<a name="l00139"></a>00139 tvec1&lt;valType&gt;&amp; operator&amp;=(<span class="keyword">const</span> tvec1&lt;valType&gt;&amp; v);
<a name="l00140"></a>00140 tvec1&lt;valType&gt;&amp; operator|=(valType <span class="keyword">const</span> &amp; s);
<a name="l00141"></a>00141 tvec1&lt;valType&gt;&amp; operator|=(<span class="keyword">const</span> tvec1&lt;valType&gt;&amp; v);
<a name="l00142"></a>00142 tvec1&lt;valType&gt;&amp; operator^=(valType <span class="keyword">const</span> &amp; s);
<a name="l00143"></a>00143 tvec1&lt;valType&gt;&amp; operator^=(<span class="keyword">const</span> tvec1&lt;valType&gt;&amp; v);
<a name="l00144"></a>00144 tvec1&lt;valType&gt;&amp; operator&lt;&lt;=(valType <span class="keyword">const</span> &amp; s);
<a name="l00145"></a>00145 tvec1&lt;valType&gt;&amp; operator&lt;&lt;=(const tvec1&lt;valType&gt;&amp; v);
<a name="l00146"></a>00146 tvec1&lt;valType&gt;&amp; operator&gt;&gt;=(valType <span class="keyword">const</span> &amp; s);
<a name="l00147"></a>00147 tvec1&lt;valType&gt;&amp; operator&gt;&gt;=(<span class="keyword">const</span> tvec1&lt;valType&gt;&amp; v);
<a name="l00148"></a>00148
<a name="l00150"></a>00150 <span class="comment">// Swizzle operators</span>
<a name="l00151"></a>00151
<a name="l00152"></a>00152 valType swizzle(comp X) <span class="keyword">const</span>;
<a name="l00153"></a>00153 tvec2&lt;valType&gt; swizzle(comp X, comp Y) <span class="keyword">const</span>;
<a name="l00154"></a>00154 tvec3&lt;valType&gt; swizzle(comp X, comp Y, comp Z) <span class="keyword">const</span>;
<a name="l00155"></a>00155 tvec4&lt;valType&gt; swizzle(comp X, comp Y, comp Z, comp W) <span class="keyword">const</span>;
<a name="l00156"></a>00156 tref1&lt;valType&gt; swizzle(comp X);
<a name="l00157"></a>00157 };
<a name="l00158"></a>00158
<a name="l00159"></a>00159 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;
<a name="l00160"></a>00160 <span class="keyword">struct </span>tref1
<a name="l00161"></a>00161 {
<a name="l00162"></a>00162 tref1(T&amp; x);
<a name="l00163"></a>00163 tref1(<span class="keyword">const</span> tref1&lt;T&gt;&amp; r);
<a name="l00164"></a>00164 tref1(<span class="keyword">const</span> tvec1&lt;T&gt;&amp; v);
<a name="l00165"></a>00165
<a name="l00166"></a>00166 tref1&lt;T&gt;&amp; operator= (<span class="keyword">const</span> tref1&lt;T&gt;&amp; r);
<a name="l00167"></a>00167 tref1&lt;T&gt;&amp; operator= (<span class="keyword">const</span> tvec1&lt;T&gt;&amp; v);
<a name="l00168"></a>00168
<a name="l00169"></a>00169 T&amp; x;
<a name="l00170"></a>00170 };
<a name="l00171"></a>00171 } <span class="comment">//namespace detail</span>
<a name="l00172"></a>00172
<a name="l00173"></a>00173 <span class="keyword">namespace </span>core{
<a name="l00174"></a>00174 <span class="keyword">namespace </span>type{
<a name="l00175"></a><a class="code" href="a00139.html">00175</a> <span class="keyword">namespace </span>vector{
<a name="l00176"></a>00176
<a name="l00178"></a>00178 <span class="comment">// Boolean definition</span>
<a name="l00179"></a>00179
<a name="l00180"></a>00180 <span class="keyword">typedef</span> detail::tvec1&lt;bool&gt; bvec1;
<a name="l00181"></a>00181
<a name="l00183"></a>00183 <span class="comment">// Float definition</span>
<a name="l00184"></a>00184
<a name="l00185"></a>00185 <span class="preprocessor">#ifndef GLM_PRECISION </span>
<a name="l00186"></a>00186 <span class="preprocessor"></span> <span class="keyword">typedef</span> detail::tvec1&lt;mediump_float&gt; vec1;
<a name="l00187"></a>00187 <span class="preprocessor">#elif(GLM_PRECISION &amp; GLM_PRECISION_HIGHP_FLOAT)</span>
<a name="l00188"></a>00188 <span class="preprocessor"></span> <span class="keyword">typedef</span> detail::tvec1&lt;highp_float&gt; vec1;
<a name="l00189"></a>00189 <span class="preprocessor">#elif(GLM_PRECISION &amp; GLM_PRECISION_MEDIUMP_FLOAT)</span>
<a name="l00190"></a>00190 <span class="preprocessor"></span> <span class="keyword">typedef</span> detail::tvec1&lt;mediump_float&gt; vec1;
<a name="l00191"></a>00191 <span class="preprocessor">#elif(GLM_PRECISION &amp; GLM_PRECISION_LOWP_FLOAT)</span>
<a name="l00192"></a>00192 <span class="preprocessor"></span> <span class="keyword">typedef</span> detail::tvec1&lt;lowp_float&gt; vec1;
<a name="l00193"></a>00193 <span class="preprocessor">#else</span>
<a name="l00194"></a>00194 <span class="preprocessor"></span> <span class="keyword">typedef</span> detail::tvec1&lt;mediump_float&gt; vec1;
<a name="l00195"></a>00195 <span class="preprocessor">#endif//GLM_PRECISION</span>
<a name="l00196"></a>00196 <span class="preprocessor"></span>
<a name="l00197"></a><a class="code" href="a00140.html">00197</a> <span class="keyword">namespace </span>precision
<a name="l00198"></a>00198 {
<a name="l00199"></a>00199 <span class="keyword">typedef</span> detail::tvec1&lt;highp_float&gt; highp_vec1;
<a name="l00200"></a>00200 <span class="keyword">typedef</span> detail::tvec1&lt;mediump_float&gt; mediump_vec1;
<a name="l00201"></a>00201 <span class="keyword">typedef</span> detail::tvec1&lt;lowp_float&gt; lowp_vec1;
<a name="l00202"></a>00202 }
<a name="l00203"></a>00203 <span class="comment">//namespace precision</span>
<a name="l00204"></a>00204
<a name="l00206"></a>00206 <span class="comment">// Signed integer definition</span>
<a name="l00207"></a>00207
<a name="l00208"></a>00208 <span class="preprocessor">#ifndef GLM_PRECISION </span>
<a name="l00209"></a>00209 <span class="preprocessor"></span> <span class="keyword">typedef</span> detail::tvec1&lt;mediump_int&gt; ivec1;
<a name="l00210"></a>00210 <span class="preprocessor">#elif(GLM_PRECISION &amp; GLM_PRECISION_HIGHP_INT)</span>
<a name="l00211"></a>00211 <span class="preprocessor"></span> <span class="keyword">typedef</span> detail::tvec1&lt;highp_int&gt; ivec1;
<a name="l00212"></a>00212 <span class="preprocessor">#elif(GLM_PRECISION &amp; GLM_PRECISION_MEDIUMP_INT)</span>
<a name="l00213"></a>00213 <span class="preprocessor"></span> <span class="keyword">typedef</span> detail::tvec1&lt;mediump_int&gt; ivec1;
<a name="l00214"></a>00214 <span class="preprocessor">#elif(GLM_PRECISION &amp; GLM_PRECISION_LOWP_INT)</span>
<a name="l00215"></a>00215 <span class="preprocessor"></span> <span class="keyword">typedef</span> detail::tvec1&lt;lowp_int&gt; ivec1;
<a name="l00216"></a>00216 <span class="preprocessor">#endif//GLM_PRECISION</span>
<a name="l00217"></a>00217 <span class="preprocessor"></span>
<a name="l00218"></a>00218 <span class="keyword">namespace </span>precision
<a name="l00219"></a>00219 {
<a name="l00220"></a>00220 <span class="keyword">typedef</span> detail::tvec1&lt;highp_int&gt; highp_ivec1;
<a name="l00221"></a>00221 <span class="keyword">typedef</span> detail::tvec1&lt;mediump_int&gt; mediump_ivec1;
<a name="l00222"></a>00222 <span class="keyword">typedef</span> detail::tvec1&lt;lowp_int&gt; lowp_ivec1;
<a name="l00223"></a>00223 }
<a name="l00224"></a>00224 <span class="comment">//namespace precision</span>
<a name="l00225"></a>00225
<a name="l00227"></a>00227 <span class="comment">// Unsigned integer definition</span>
<a name="l00228"></a>00228
<a name="l00229"></a>00229 <span class="preprocessor">#ifndef GLM_PRECISION </span>
<a name="l00230"></a>00230 <span class="preprocessor"></span> <span class="keyword">typedef</span> detail::tvec1&lt;mediump_uint&gt; uvec1;
<a name="l00231"></a>00231 <span class="preprocessor">#elif(GLM_PRECISION &amp; GLM_PRECISION_HIGHP_UINT)</span>
<a name="l00232"></a>00232 <span class="preprocessor"></span> <span class="keyword">typedef</span> detail::tvec1&lt;highp_uint&gt; uvec1;
<a name="l00233"></a>00233 <span class="preprocessor">#elif(GLM_PRECISION &amp; GLM_PRECISION_MEDIUMP_UINT)</span>
<a name="l00234"></a>00234 <span class="preprocessor"></span> <span class="keyword">typedef</span> detail::tvec1&lt;mediump_uint&gt; uvec1;
<a name="l00235"></a>00235 <span class="preprocessor">#elif(GLM_PRECISION &amp; GLM_PRECISION_LOWP_UINT)</span>
<a name="l00236"></a>00236 <span class="preprocessor"></span> <span class="keyword">typedef</span> detail::tvec1&lt;lowp_uint&gt; uvec1;
<a name="l00237"></a>00237 <span class="preprocessor">#endif//GLM_PRECISION</span>
<a name="l00238"></a>00238 <span class="preprocessor"></span>
<a name="l00239"></a>00239 <span class="keyword">namespace </span>precision
<a name="l00240"></a>00240 {
<a name="l00241"></a>00241 <span class="keyword">typedef</span> detail::tvec1&lt;highp_uint&gt; highp_uvec1;
<a name="l00242"></a>00242 <span class="keyword">typedef</span> detail::tvec1&lt;mediump_uint&gt; mediump_uvec1;
<a name="l00243"></a>00243 <span class="keyword">typedef</span> detail::tvec1&lt;lowp_uint&gt; lowp_uvec1;
<a name="l00244"></a>00244 }
<a name="l00245"></a>00245 <span class="comment">//namespace precision</span>
<a name="l00246"></a>00246
<a name="l00247"></a>00247 }<span class="comment">//namespace vector</span>
<a name="l00248"></a>00248 }<span class="comment">//namespace type</span>
<a name="l00249"></a>00249 }<span class="comment">//namespace core</span>
<a name="l00250"></a>00250 }<span class="comment">//namespace glm</span>
<a name="l00251"></a>00251
<a name="l00252"></a>00252 <span class="preprocessor">#include &quot;type_vec1.inl&quot;</span>
<a name="l00253"></a>00253
<a name="l00254"></a>00254 <span class="preprocessor">#endif//glm_core_type_gentype1</span>
</pre></div></div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Mon Nov 16 11:23:23 2009 for GLM by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>