mod()

구문

const mod: <K extends FloatKey>(
  x: ReadonlyNode<K>,
  y: NoInfer<ArithArg<K>>,
) => Node<K>

매개변수

x ReadonlyNode<K>

the value to wrap.

y NoInfer<ArithArg<K>>

the modulus, a vector of the same shape or a scalar to broadcast.

반환값

Node<K>

the wrapped value, in [0, y) for a positive y.

설명

Use it wherever a negative operand is possible, which is what domain repetition and angle folds need: the result takes the sign of y, so for a positive y every input wraps into [0, y) and mod(-1, 4) is 3.

The .mod method and % are the other modulo, truncated modulo, whose result takes the sign of x: there (-1) % 4 is -1. That is WGSL’s % semantics, and since GLSL ES 3.00 keeps % for integers only, the GLSL writer spells the float case as a - b * trunc(a / b). This free function is the portable float modulo of the two. It is deliberately not named fmod, which in C and HLSL means the truncated one.

Component-wise. y may be a scalar broadcast over a vector x.

예제

import { fn, mod, f32T } from 'typeshade'

// Fold an angle into one revolution, whatever sign it arrives with.
const wrap = fn('wrap_angle', { a: f32T }, ({ a }) => mod(a, 6.283185307179586))

대상별 지원

관련 가이드

• 값과 변경
• GLSL 셰이더 옮기기

함께 보기

• floor

소스

src/core/ir/node.ts, 1695행, 커밋 c66579bf 기준