copysign

Description

Copy-sign. Returns a value whose magnitude is from one operand and whose sign is from another operand.

Signature

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

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

Generic Parameters

T: __BuiltinFloatingPointType

N : int

Parameters

x : vector<T, N>

The value to use as the magnitude.

y : vector<T, N>

The value to use as the sign.

x : T

The value to use as the magnitude.

y : T

The value to use as the sign.

Return value

A value whose magnitude is from x and whose sign is from 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.

spirv

Available in all stages.