Clamp

Navigation

API > API/Runtime > API/Runtime/Core > API/Runtime/Core/FMath

Overloads

Clamp(const T, const T, const T)

Description

Clamps X to be between Min and Max, inclusive

template<class T>  
static T Clamp  
(  
    const T X,  
    const T MinValue,  
    const T MaxValue  
)  
Copy full snippet

template<class T> static T Clamp (     const T X,     const T MinValue,     const T MaxValue )

Clamp(Arg1, Arg2, Arg3)

Description

Allow mixing float/double arguments, promoting to highest precision type.

template<typename Arg1, typename Arg2, typename Arg3, std::enable_if_t<((std::is_floating_point_v< Arg1 >||std::is_floating_point_v< Arg2 >||std::is_floating_point_v< Arg3 >) &&(!std::is_same_v< Arg1, Arg2 >||!std::is_same_v< Arg2, Arg3 >||!std::is_same_v< Arg1, Arg3 >)), int >>  
static decltype(X *Y *Z) Clamp  
(  
    Arg1 X,  
    Arg2 Y,  
    Arg3 Z  
)  
Copy full snippet

template<typename Arg1, typename Arg2, typename Arg3, std::enable_if_t<((std::is_floating_point_v< Arg1 >||std::is_floating_point_v< Arg2 >||std::is_floating_point_v< Arg3 >) &&(!std::is_same_v< Arg1, Arg2 >||!std::is_same_v< Arg2, Arg3 >||!std::is_same_v< Arg1, Arg3 >)), int >> static decltype(X *Y *Z) Clamp (     Arg1 X,     Arg2 Y,     Arg3 Z )

Clamp(const float, const float, const float)

Description

Clamps X to be between Min and Max, inclusive. Explicitly defined here for floats/doubles because static analysis gets confused between template and int versions.

static float Clamp  
(  
    const float X,  
    const float Min,  
    const float Max  
)  
Copy full snippet

static float Clamp (     const float X,     const float Min,     const float Max )

Clamp(const double, const double, const double)

static double Clamp  
(  
    const double X,  
    const double Min,  
    const double Max  
)  
Copy full snippet

static double Clamp (     const double X,     const double Min,     const double Max )

Clamp(const int64, const int32, const int32)

Description

Clamps X to be between Min and Max, inclusive. Overload to support mixed int64/int32 types.

static int64 Clamp  
(  
    const int64 X,  
    const int32 Min,  
    const int32 Max  
)  
Copy full snippet

static int64 Clamp (     const int64 X,     const int32 Min,     const int32 Max )