min

Description

Minimum.

Signature

T min<T>(
    T x,
    T y)
    where T : __BuiltinIntegerType;

vector<T, N> min<T, N:int>(
    vector<T, N> x,
    vector<T, N> y)
    where T : __BuiltinIntegerType;

matrix<T, N, M> min<T, N:int, M:int>(
    matrix<T, N, M> x,
    matrix<T, N, M> y)
    where T : __BuiltinIntegerType;

T min<T>(
    T x,
    T y)
    where T : __BuiltinFloatingPointType;

vector<T, N> min<T, N:int>(
    vector<T, N> x,
    vector<T, N> y)
    where T : __BuiltinFloatingPointType;

matrix<T, N, M> min<T, N:int, M:int>(
    matrix<T, N, M> x,
    matrix<T, N, M> y)
    where T : __BuiltinFloatingPointType;

Generic Parameters

T: __BuiltinIntegerType

N : int

M : int

T: __BuiltinFloatingPointType

Parameters

x : T

The first value to compare.

y : T

The second value to compare.

x : vector<T, N>

The first value to compare.

y : vector<T, N>

The second value to compare.

x : matrix<T, N, M>

The first value to compare.

y : matrix<T, N, M>

The second value to compare.

Return value

The smaller of the two values, element-wise if vector typed.

Remarks

For HLSL, GLSL, and metal targets, this is implemented with the min() intrinsic. For SPIR-V, it is implemented with the UMin or SMin instruction, depending on the signedness of the type.

Availability and Requirements

Defined for the following targets:

hlsl

Available in all stages.

glsl

Available in all stages.

cpp

Available in all stages.

cuda

Available in all stages.

metal

Available in all stages.

wgsl

Available in all stages.

spirv

Available in all stages.