Navigation
API > API/Runtime > API/Runtime/Core > API/Runtime/Core/FGenericPlatformMath
Overloads
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Max of Array | GenericPlatform/GenericPlatformMath.h | ||
static T Max
(
T A, |
Returns higher value in a generic way | GenericPlatform/GenericPlatformMath.h | |
static T Max
(
T A, |
GenericPlatform/GenericPlatformMath.h | ||
static decltype(X *Y) Max
(
Arg1 X, |
Allow mixing of float types to promote to highest precision type. | GenericPlatform/GenericPlatformMath.h | |
static decltype(X *Y) Max
(
Arg1 X, |
Allow mixing of signed integral types. | GenericPlatform/GenericPlatformMath.h | |
| Max of Array | GenericPlatform/GenericPlatformMath.h | ||
| Returns the larger of the two values (operates on each component individually) | |||
Max(const TArray< T > &)
Description
Max of Array
| Name | Max |
| Type | function |
| Header File | /Engine/Source/Runtime/Core/Public/GenericPlatform/GenericPlatformMath.h |
| Include Path | #include "GenericPlatform/GenericPlatformMath.h" |
template<class T>
static T Max
(
const TArray < T > & Values
)
The max value found in the array or default value if the array was empty
Parameters
| Name | Remarks |
|---|---|
| Values | Array of templated type |
Max(T, T)
Description
Returns higher value in a generic way
| Name | Max |
| Type | function |
| Header File | /Engine/Source/Runtime/Core/Public/GenericPlatform/GenericPlatformMath.h |
| Include Path | #include "GenericPlatform/GenericPlatformMath.h" |
template<typename T>
static T Max
(
T A,
T B
)
Max(T, OtherTypes...)
| Name | Max |
| Type | function |
| Header File | /Engine/Source/Runtime/Core/Public/GenericPlatform/GenericPlatformMath.h |
| Include Path | #include "GenericPlatform/GenericPlatformMath.h" |
template<typename T, typename... OtherTypes, std::enable_if_t<((std::is_same_v< T, OtherTypes > &&...)), int >>
static T Max
(
T A,
OtherTypes... Others
)
Max(Arg1, Arg2)
Description
Allow mixing of float types to promote to highest precision type.
| Name | Max |
| Type | function |
| Header File | /Engine/Source/Runtime/Core/Public/GenericPlatform/GenericPlatformMath.h |
| Include Path | #include "GenericPlatform/GenericPlatformMath.h" |
template<typename Arg1, typename Arg2, std::enable_if_t<((std::is_floating_point_v< Arg1 >||std::is_floating_point_v< Arg2 >) &&!std::is_same_v< Arg1, Arg2 >), int >>
static decltype(X *Y) Max
(
Arg1 X,
Arg2 Y
)
Max(Arg1, Arg2)
Description
Allow mixing of signed integral types.
| Name | Max |
| Type | function |
| Header File | /Engine/Source/Runtime/Core/Public/GenericPlatform/GenericPlatformMath.h |
| Include Path | #include "GenericPlatform/GenericPlatformMath.h" |
template<typename Arg1, typename Arg2, std::enable_if_t<(!std::is_same_v< Arg1, Arg2 > &&std::is_signed_v< Arg1 > &&std::is_integral_v< Arg1 > &&std::is_signed_v< Arg2 > &&std::is_integral_v< Arg2 >), int >>
static decltype(X *Y) Max
(
Arg1 X,
Arg2 Y
)
Max(const TArray< T > &, int32 *)
Description
Max of Array
| Name | Max |
| Type | function |
| Header File | /Engine/Source/Runtime/Core/Public/GenericPlatform/GenericPlatformMath.h |
| Include Path | #include "GenericPlatform/GenericPlatformMath.h" |
template<class T>
static T Max
(
const TArray < T > & Values,
int32 * MaxIndex
)
The max value found in the array or default value if the array was empty
Parameters
| Name | Remarks |
|---|---|
| Values | Array of templated type |
| MaxIndex | Optional pointer for returning the index of the maximum element, if multiple maximum elements the first index is returned |
Max(VectorRegister4Float, VectorRegister4Float)
Description
Returns the larger of the two values (operates on each component individually)
| Name | Max |
| Type | function |
| Header File | /Engine/Source/Runtime/Core/Public/Math/UnrealMathVectorCommon.h.inl |
| Include Path | #include "Math/UnrealMathVectorCommon.h.inl" |
template<>
VectorRegister4Float Max
(
VectorRegister4Float A,
VectorRegister4Float B
)
Max(VectorRegister4Double, VectorRegister4Double)
| Name | Max |
| Type | function |
| Header File | /Engine/Source/Runtime/Core/Public/Math/UnrealMathVectorCommon.h.inl |
| Include Path | #include "Math/UnrealMathVectorCommon.h.inl" |
template<>
VectorRegister4Double Max
(
VectorRegister4Double A,
VectorRegister4Double B
)