Edit

Share via

distance

  • Article

Returns a distance scalar between two vectors.

ret distance(x, y)

Parameters

Item Description
x
 [in] The first floating-point vector to compare.
y
 [in] The second floating-point vector to compare.

Return Value

A floating-point, scalar value that represents the distance between the x parameter and the y parameter.

Type Description

Name Template Type Component Type Size
x vector float any
y vector float same dimension(s) as input x
ret scalar float 1

Minimum Shader Model

This function is supported in the following shader models.

Shader Model Supported
Shader Model 2 (DirectX HLSL) and higher shader models yes
Shader Model 1 (DirectX HLSL) vs_1_1

See also

Intrinsic Functions (DirectX HLSL)