Revision 1017101 of SIMD.Uint8x16

<div>{{JSRef}} {{SeeCompatTable}}</div>

<p>The <strong><code>SIMD.Uint8x16</code></strong> data type is a 128-bit vector divided into 16 lanes storing 8-bit unsigned integer values.</p>

<h2 id="Syntax">Syntax</h2>

<pre class="syntaxbox">
SIMD.Uint8x16(s0,s1,s2,s3,s4,s5,s6,s7,s8,s9,s10,s11,s12,s13,s14,s15);</pre>

<h3 id="Parameters">Parameters</h3>

<dl>
 <dt><code>s[0-15]</code> {{optional_inline}}</dt>
 <dd>An integer specifying the value of the lane. Defaults to 0.</dd>
</dl>

<h2 id="Constructor_functions">Constructor functions</h2>

<p>In addition to the simple creator functions, the SIMD API provides the following constructor functions:</p>

<dl>
 <dt>{{jsxref("SIMD.splat", "SIMD.Int8x16.splat()")}}</dt>
 <dd>Creates a Uint8x16 with all lanes set to a given value.</dd>
</dl>

<p>Note that you can also <a href="#Data_conversions">convert from another SIMD data type to Uint8x16</a>.</p>

<div class="note">
<p><strong>Note:</strong> SIMD types don't work with <code>new</code>, as SIMD values are no "boxed" objects (comparable to <code>String(s)</code> vs. <code>new String(s)</code>, which creates a String object).</p>

<pre class="brush: js example-bad">
var v = new SIMD.Uint8x16(1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16); 
// TypeError: SIMD.Uint8x16 is not a constructor
var w = new SIMD.Uint8x16.splat(3); 
// TypeError: SIMD.Uint8x16.splat is not a constructor
</pre>

<p>Instead, you just write:</p>

<pre class="brush: js example-good">
var v = SIMD.Uint8x16(1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16);
var w = SIMD.Uint8x16.splat(3); 
</pre>
</div>

<h2 id="Operations">Operations</h2>

<p>To actually do something with SIMD types, SIMD operations are needed that work on SIMD data types.</p>

<h3 id="Checking_SIMD_types">Checking SIMD types</h3>

<dl>
 <dt>{{jsxref("SIMD.check", "SIMD.Uint8x16.check()")}}</dt>
 <dd>Returns a new Uint8x16 if the parameter is a valid Int8x16 data type. Throws a {{jsxref("TypeError")}} otherwise.</dd>
</dl>

<h3 id="Accessing_and_mutating_lanes">Accessing and mutating lanes</h3>

<dl>
 <dt>{{jsxref("SIMD.extractLane", "SIMD.Uint8x16.extractLane()")}}</dt>
 <dd>Returns the value of the given lane.</dd>
 <dt>{{jsxref("SIMD.replaceLane", "SIMD.Uint8x16.replaceLane()")}}</dt>
 <dd>Returns a new Uint8x16 with the given lane value replaced.</dd>
</dl>

<h3 id="Loading_from_and_storing_into_typed_arrays">Loading from and storing into typed arrays</h3>

<dl>
 <dt>{{jsxref("SIMD.load", "SIMD.Uint8x16.load()")}}</dt>
 <dd>Returns a new Uint8x16 with the lane values loaded from a <a href="/en-US/docs/Web/JavaScript/Typed_arrays">typed array</a>.</dd>
 <dt>{{jsxref("SIMD.store", "SIMD.Uint8x16.store()")}}</dt>
 <dd>Stores a Uint8x16 into a <a href="/en-US/docs/Web/JavaScript/Typed_arrays">typed array</a>.</dd>
</dl>

<h3 id="Arithmetic_operations">Arithmetic operations</h3>

<dl>
 <dt>{{jsxref("SIMD.add", "SIMD.Uint8x16.add()")}}</dt>
 <dd>Returns a new Uint8x16 with the lane values added (<code>a + b</code>).</dd>
 <dt>{{jsxref("SIMD.addSaturate", "SIMD.Uint8x16.addSaturate()")}}</dt>
 <dd>Returns a new Uint8x16 with the lane values added (<code>a + b</code>) and saturating behavior on overflow.</dd>
 <dt>{{jsxref("SIMD.mul", "SIMD.Uint8x16.mul()")}}</dt>
 <dd>Returns a new Uint8x16 with the lane values multiplied (<code>a * b</code>).</dd>
 <dt>{{jsxref("SIMD.neg", "SIMD.Uint8x16.neg()")}}</dt>
 <dd>Returns a new Uint8x16 with the negated lane values.</dd>
 <dt>{{jsxref("SIMD.sub", "SIMD.Uint8x16.sub()")}}</dt>
 <dd>Returns a new Uint8x16 with the lane values subtracted (<code>a - b</code>).</dd>
 <dt>{{jsxref("SIMD.subSaturate", "SIMD.Uint8x16.subSaturate()")}}</dt>
 <dd>Returns a Uint8x16 instance with the lane values subtracted (<code>a - b</code>) and&nbsp;saturating behavior on overflow.</dd>
</dl>

<h3 id="Shuffling_and_swizzling">Shuffling and swizzling</h3>

<dl>
 <dt>{{jsxref("SIMD.shuffle", "SIMD.Uint8x16.shuffle()")}}</dt>
 <dd>Returns a new Uint8x16 with the lane values shuffled.</dd>
 <dt>{{jsxref("SIMD.swizzle", "SIMD.Uint8x16.swizzle()")}}</dt>
 <dd>Returns a new Uint8x16 with the lane values swizzled.</dd>
</dl>

<h3 id="Selections">Selections</h3>

<dl>
 <dt>{{jsxref("SIMD.select", "SIMD.Uint8x16.select()")}}</dt>
 <dd>Returns a new Uint8x16 with the lane values being a mix of the lanes depending on the selector mask.</dd>
</dl>

<h3 id="Comparisons">Comparisons</h3>

<dl>
 <dt>{{jsxref("SIMD.equal", "SIMD.Uint8x16.equal()")}}</dt>
 <dd>Returns a selection mask depending on <code>a == b</code>.</dd>
 <dt>{{jsxref("SIMD.notEqual", "SIMD.Uint8x16.notEqual()")}}</dt>
 <dd>Returns a selection mask depending on <code>a != b</code>.</dd>
 <dt>{{jsxref("SIMD.lessThan", "SIMD.Uint8x16.lessThan()")}}</dt>
 <dd>Returns a selection mask depending on <code>a &lt; b</code>.</dd>
 <dt>{{jsxref("SIMD.lessThanOrEqual", "SIMD.Uint8x16.lessThanOrEqual()")}}</dt>
 <dd>Returns a selection mask depending on <code>a &lt;= b</code>.</dd>
 <dt>{{jsxref("SIMD.greaterThan", "SIMD.Uint8x16.greaterThan()")}}</dt>
 <dd>Returns a selection mask depending on <code>a &gt; b</code>.</dd>
 <dt>{{jsxref("SIMD.greaterThanOrEqual", "SIMD.Uint8x16.greaterThanOrEqual()")}}</dt>
 <dd>Returns a selection mask depending on <code>a &gt;= b</code>.</dd>
</dl>

<h3 id="Bitwise_logical_operations">Bitwise logical operations</h3>

<dl>
 <dt>{{jsxref("SIMD.and", "SIMD.Uint8x16.and()")}}</dt>
 <dd>Returns a new Uint8x16 with the logical AND of the lane values (<code>a &amp; b</code>).</dd>
 <dt>{{jsxref("SIMD.or", "SIMD.Uint8x16.or()")}}</dt>
 <dd>Returns a new Uint8x16 with the logical OR of the lane values (<code>a | b</code>).</dd>
 <dt>{{jsxref("SIMD.xor", "SIMD.Uint8x16.xor()")}}</dt>
 <dd>Returns a new Uint8x16 with the logical XOR of the lane values (<code>a ^ b</code>).</dd>
 <dt>{{jsxref("SIMD.not", "SIMD.Uint8x16.not()")}}</dt>
 <dd>Returns a new Uint8x16 with lane with the logical NOT of the lane values (<code>~a</code>).</dd>
</dl>

<h3 id="Bitwise_shift_operations">Bitwise shift operations</h3>

<dl>
 <dt>{{jsxref("SIMD.shiftLeftByScalar", "SIMD.Uint8x16.shiftLeftByScalar()")}}</dt>
 <dd>Returns a new Uint8x16 with the lane values shifted left by a given bit count (<code>a &lt;&lt; bits</code>).</dd>
 <dt>{{jsxref("SIMD.shiftRightByScalar", "SIMD.Uint8x16.shiftRightByScalar()")}}</dt>
 <dd>Returns a new Uint8x16 with the lane values shifted right.</dd>
</dl>

<h3 id="Data_conversions">Data conversions</h3>

<dl>
 <dt>{{jsxref("SIMD.fromFloat32x4Bits", "SIMD.Uint8x16.fromFloat32x4Bits()")}}</dt>
 <dd>Creates a new Uint8x16 data type with a bit-wise copy from a Float32x4.</dd>
 <dt>{{jsxref("SIMD.fromFloat64x2Bits", "SIMD.Uint8x16.fromFloat64x2Bits()")}}</dt>
 <dd>Creates a new Uint8x16 data type with a bit-wise copy from a Float64x2.</dd>
 <dt>{{jsxref("SIMD.fromInt32x4Bits", "SIMD.Uint8x16.fromInt32x4Bits()")}}</dt>
 <dd>Creates a new Uint8x16 data type with a bit-wise copy from an Int32x4.</dd>
 <dt>{{jsxref("SIMD.fromInt16x8Bits", "SIMD.Uint8x16.fromInt16x8Bits()")}}</dt>
 <dd>Creates a new Uint8x16 data type with a bit-wise copy from an Int16x8.</dd>
 <dt>{{jsxref("SIMD.fromInt8x16Bits", "SIMD.Uint8x16.fromInt8x16Bits()")}}</dt>
 <dd>Creates a new Uint8x16 data type with a bit-wise copy from an Int8x16.</dd>
 <dt>{{jsxref("SIMD.fromUint32x4Bits", "SIMD.Uint8x16.fromUint32x4Bits()")}}</dt>
 <dd>Creates a new Uint8x16 data type with a bit-wise copy from a Uint32x4.</dd>
 <dt>{{jsxref("SIMD.fromUint16x8Bits", "SIMD.Uint8x16.fromUint16x8Bits()")}}</dt>
 <dd>Creates a new Uint8x16 data type with a bit-wise copy from a Uint16x8.</dd>
</dl>

<h2 id="SIMD_prototype">SIMD prototype</h2>

<p>The following methods and properties are installed on the <code>SIMD.Uint8x16.prototype</code>.</p>

<dl>
 <dt><code>SIMD.Uint8x16.prototype.constructor</code></dt>
 <dd>Specifies the function that creates a SIMD object's prototype.</dd>
 <dt>{{jsxref("SIMD.toLocaleString", "SIMD.Uint8x16.prototype.toLocaleString()")}}</dt>
 <dd>Returns a localized string representing the SIMD type and its elements. Overrides the {{jsxref("Object.prototype.toLocaleString()")}} method.</dd>
 <dt>{{jsxref("SIMD.toString", "SIMD.Uint8x16.prototype.toString()")}}</dt>
 <dd>Returns a string representing the SIMD type and its elements. Overrides the {{jsxref("Object.prototype.toString()")}} method.</dd>
 <dt>{{jsxref("SIMD.valueOf", "SIMD.Uint8x16.prototype.valueOf()")}}</dt>
 <dd>Returns the primitive value of a SIMD object.</dd>
 <dt>{{jsxref("SIMD.toSource", "SIMD.Uint8x16.prototype.toSource()")}} {{non-standard_inline}}</dt>
 <dd>Returns a string representing the source code of the object. Overrides the {{jsxref("Object.prototype.toSource()")}} method.</dd>
</dl>

<h2 id="Examples">Examples</h2>

<h3 id="Constructing_a_Uint8x16">Constructing a Uint8x16</h3>

<pre class="brush: js">
SIMD.Uint8x16(1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16);
  // Uint8x16[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16]
SIMD.Uint8x16(1,2);
  // Uint8x16[1,2,0,0,0,0,0,0,0,0,0,0,0,0,0,0]
SIMD.Uint8x16();
  // Uint8x16[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0]
</pre>

<h2 id="Specifications">Specifications</h2>

<table class="standard-table">
 <tbody>
  <tr>
   <th scope="col">Specification</th>
   <th scope="col">Status</th>
   <th scope="col">Comment</th>
  </tr>
  <tr>
   <td>{{SpecName('SIMD', '#uint8x16', 'Uint8x16')}}</td>
   <td>{{Spec2('SIMD')}}</td>
   <td>Initial definition.</td>
  </tr>
 </tbody>
</table>

<h2 id="Browser_compatibility">Browser compatibility</h2>

<p>{{CompatibilityTable}}</p>

<div id="compat-desktop">
<table class="compat-table">
 <tbody>
  <tr>
   <th>Feature</th>
   <th>Chrome</th>
   <th>Firefox (Gecko)</th>
   <th>Internet Explorer</th>
   <th>Opera</th>
   <th>Safari</th>
  </tr>
  <tr>
   <td>Basic support</td>
   <td>{{CompatNo}}</td>
   <td>{{CompatNightly("firefox")}}</td>
   <td>{{CompatNo}}</td>
   <td>{{CompatNo}}</td>
   <td>{{CompatNo}}</td>
  </tr>
 </tbody>
</table>
</div>

<div id="compat-mobile">
<table class="compat-table">
 <tbody>
  <tr>
   <th>Feature</th>
   <th>Android</th>
   <th>Chrome for Android</th>
   <th>Firefox Mobile (Gecko)</th>
   <th>IE Mobile</th>
   <th>Opera Mobile</th>
   <th>Safari Mobile</th>
  </tr>
  <tr>
   <td>Basic support</td>
   <td>{{CompatNo}}</td>
   <td>{{CompatNo}}</td>
   <td>{{CompatNightly("firefox")}}</td>
   <td>{{CompatNo}}</td>
   <td>{{CompatNo}}</td>
   <td>{{CompatNo}}</td>
  </tr>
 </tbody>
</table>
</div>

<h2 id="See_also">See also</h2>

<ul>
 <li>{{jsxref("SIMD")}}</li>
</ul>