Skip to content

dot.md

Latest commit

 

History

History
87 lines (54 loc) · 5.18 KB

dot.md

File metadata and controls

87 lines (54 loc) · 5.18 KB
Raw
layout stdlib-reference

dot

Description

Vector dot product. Returns the dot product of two vectors.

Signature

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

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

T dot<T, N:int>(
    vector<T, N> x,
    vector<T, N> y)
    where T : __BuiltinIntegerType;

Generic Parameters

T: __BuiltinFloatingPointType {#typeparam-T}

N : int {#decl-N}

T: __BuiltinIntegerType {#typeparam-T}

Parameters

x : T {#decl-x}

The first vector.

y : T {#decl-y}

The second vector.

x : vector<T, N> {#decl-x}

The first vector.

y : vector<T, N> {#decl-y}

The second vector.

Return value

The dot product of x and y.

Remarks

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