fmod

Description

Floating point remainder of x/y. The floating-point remainder is calculated such that x = i * y + f, where i is an integer, f has the same sign as x, and the absolute value of f is less than the absolute value of y.

Signature

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

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

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

Generic Parameters

T: __BuiltinFloatingPointType

N : int

M : int

Parameters

x : T

The dividend.

y : T

The divisor.

x : vector<T, N>

The dividend.

y : vector<T, N>

The divisor.

x : matrix<T, N, M>

The dividend.

y : matrix<T, N, M>

The divisor.

Return value

The floating-point remainder of x/y.

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.