distance

Description

Vector distance. Returns the distance between two points.

Signature

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

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

Generic Parameters

T: __BuiltinFloatingPointType

N : int

Parameters

x : vector<T, N>

The first point.

y : vector<T, N>

The second point.

x : T

The first point.

y : T

The second point.

Return value

The distance between x and y.

Remarks

This function is equivalent to length(x-y). When x and y are scalars, this function is equivalent to abs(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.