fmin

Description

Floating-point minimum.

Signature

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

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

Generic Parameters

T: __BuiltinFloatingPointType

N : int

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.

Return value

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

Remarks

Result is x if x < y, either x or y if both x and y are zeros, otherwise y. Which operand is the result is undefined if one of the operands is a NaN.

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.

spirv

Available in all stages.

llvm

Available in all stages.