AlignmentTemplates.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreTypes.h"
#include "Templates/IsIntegral.h"
#include "Templates/IsPointer.h"
 
template <typename T>
inline constexpr T Align(T Val, uint64 Alignment)
{
    static_assert(TIsIntegral<T>::Value || TIsPointer<T>::Value, "Align expects an integer or pointer type");
 
    return (T)(((uint64)Val + Alignment - 1) & ~(Alignment - 1));
}
 
template <typename T>
inline constexpr T AlignDown(T Val, uint64 Alignment)
{
    static_assert(TIsIntegral<T>::Value || TIsPointer<T>::Value, "AlignDown expects an integer or pointer type");
 
    return (T)(((uint64)Val) & ~(Alignment - 1));
}
 
template <typename T>
inline constexpr bool IsAligned(T Val, uint64 Alignment)
{
    static_assert(TIsIntegral<T>::Value || TIsPointer<T>::Value, "IsAligned expects an integer or pointer type");
 
    return !((uint64)Val & (Alignment - 1));
}
 
template <typename T>
inline constexpr T AlignArbitrary(T Val, uint64 Alignment)
{
    static_assert(TIsIntegral<T>::Value || TIsPointer<T>::Value, "AlignArbitrary expects an integer or pointer type");
 
    return (T)((((uint64)Val + Alignment - 1) / Alignment) * Alignment);
}