SIMD.%type%.subSaturate()

The static SIMD.%type%.subSaturate() method returns a new instance with the lane values subtracted (a - b) and saturating behavior on overflow.

Note: This operation is not defined on Uint32x4 and Int32x4, because it is not accelerated by current hardware on those types.

Syntax

SIMD.Int8x16.subSaturate(a, b)
SIMD.Int16x8.subSaturate(a, b)

SIMD.Uint8x16.subSaturate(a, b) 
SIMD.Uint16x8.subSaturate(a, b)

Parameters

a

An instance of a SIMD type.

b

Another instance of a SIMD type.

Return value

A new corresponding SIMD data type with the lane values of a and b subtracted (a - b).

Examples

The following example demonstrates the saturating behavior for Uint16 (maximum value 65535, minimum value 0) and Int16 (maximum value 32767, minimum value -32678). If the subtraction overflows, the lanes will have the minimum/maximum possible value.

var a = SIMD.Uint16x8(5, 1, 1, 1, 1, 1, 1, 1); 
var b = SIMD.Uint16x8(10, 1, 1, 1, 1, 1, 1, 1); 
SIMD.Uint16x8.subSaturate(a, b); 
// Uint16x8[0, 0, 0, 0, 0, 0, 0, 0]

var c = SIMD.Int16x8(-100, 0, 0, 0, 0, 0, 0, 0);
var d = SIMD.Int16x8(32767, 0, 0, 0, 0, 0, 0, 0);
SIMD.Int16x8.subSaturate(c, d);
// Int16x8[-32768, 0, 0, 0, 0, 0, 0, 0, 0]

Specifications

Browser compatibility

See also

• SIMD