UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
ImageCore.h File Reference
#include "Containers/ContainersFwd.h"
#include "CoreMinimal.h"
#include "CoreTypes.h"
#include "Math/Color.h"
#include "Math/Float16.h"
#include "Math/Float16Color.h"
#include "Math/Vector2D.h"
#include "Misc/AssertionMacros.h"

Go to the source code of this file.

Classes

struct  FImageInfo
 
struct  FImageView
 
struct  FImage
 
struct  FSharedImage
 
struct  FMipMapImage
 
struct  FMipMapImage::FMipInfo
 

Namespaces

namespace  ERawImageFormat
 
namespace  UE
 
namespace  UE::Color
 
namespace  FImageCore
 

Typedefs

typedef TRefCountPtr< struct FSharedImageFSharedImageRef
 
typedef TRefCountPtr< const struct FSharedImageFSharedImageConstRef
 

Enumerations

enum  ERawImageFormat::Type : uint8 {
  ERawImageFormat::G8 , ERawImageFormat::BGRA8 , ERawImageFormat::BGRE8 , ERawImageFormat::RGBA16 ,
  ERawImageFormat::RGBA16F , ERawImageFormat::RGBA32F , ERawImageFormat::G16 , ERawImageFormat::R16F ,
  ERawImageFormat::R32F , ERawImageFormat::MAX , ERawImageFormat::Invalid = 0xFF
}
 
enum class  FImageCore::EResizeImageFilter : uint32 {
  FImageCore::Default = 0 , FImageCore::PointSample , FImageCore::Box , FImageCore::Triangle ,
  FImageCore::Bilinear = Triangle , FImageCore::CubicGaussian , FImageCore::CubicSharp , FImageCore::CubicMitchell ,
  FImageCore::AdaptiveSharp , FImageCore::AdaptiveSmooth , FImageCore::MitchellOneQuarter , FImageCore::MitchellOneSixth ,
  FImageCore::MitchellNegOneSixth , FImageCore::MitchellNegOneThird , FImageCore::Lanczos4 , FImageCore::Lanczos5 ,
  FImageCore::WithoutFlagsMask = 63 , FImageCore::Flag_WrapX = 64 , FImageCore::Flag_WrapY = 128 , FImageCore::Flag_AlphaWeighted = 256
}
 

Functions

IMAGECORE_API int64 ERawImageFormat::GetBytesPerPixel (Type Format)
 
IMAGECORE_API const TCHARERawImageFormat::GetName (Type Format)
 
IMAGECORE_API const FUtf8StringView ERawImageFormat::GetNameView (Type Format)
 
IMAGECORE_API bool ERawImageFormat::GetFormatFromString (FUtf8StringView InString, Type &OutFormat)
 
IMAGECORE_API bool ERawImageFormat::IsU8Channels (Type Format)
 
IMAGECORE_API int ERawImageFormat::NumChannels (Type Format)
 
IMAGECORE_API bool ERawImageFormat::IsHDR (Type Format)
 
IMAGECORE_API bool ERawImageFormat::HasAlphaChannel (Type Format)
 
IMAGECORE_API const FLinearColor ERawImageFormat::GetOnePixelLinear (const void *PixelData, Type Format, EGammaSpace Gamma)
 
const FLinearColor ERawImageFormat::GetOnePixelLinear (const void *PixelData, Type Format, bool bSRGB)
 
bool ERawImageFormat::GetFormatNeedsGammaSpace (Type Format)
 
EGammaSpace ERawImageFormat::GetDefaultGammaSpace (Type Format)
 
IMAGECORE_API int32 ImageParallelForComputeNumJobsForPixels (int64 &OutNumPixelsPerJob, int64 NumPixels)
 
IMAGECORE_API int32 ImageParallelForComputeNumJobsForRows (int32 &OutNumItemsPerJob, int64 SizeX, int64 SizeY)
 
IMAGECORE_API void FImageCore::CopyImage (const FImageView &SrcImage, const FImageView &DestImage)
 
IMAGECORE_API void FImageCore::CopyImageRGBABGRA (const FImageView &SrcImage, const FImageView &DestImage)
 
IMAGECORE_API void FImageCore::CopyImageTo2U16 (const FImageView &SrcImage, const FImageView &DestImage)
 
IMAGECORE_API void FImageCore::TransposeImageRGBABGRA (const FImageView &Image)
 
IMAGECORE_API void FImageCore::SanitizeFloat16AndSetAlphaOpaqueForBC6H (const FImageView &InOutImage)
 
IMAGECORE_API bool FImageCore::DetectAlphaChannel (const FImageView &InImage)
 
IMAGECORE_API void FImageCore::SetAlphaOpaque (const FImageView &InImage)
 
IMAGECORE_API void FImageCore::ResizeTo (const FImageView &SourceImage, FImage &DestImage, int32 DestSizeX, int32 DestSizeY, ERawImageFormat::Type DestFormat, EGammaSpace DestGammaSpace)
 
IMAGECORE_API void FImageCore::ComputeChannelLinearMinMax (const FImageView &InImage, FLinearColor &OutMin, FLinearColor &OutMax)
 
IMAGECORE_API bool FImageCore::ScaleChannelsSoMinMaxIsInZeroToOne (const FImageView &ImageToModify)
 
IMAGECORE_API FLinearColor FImageCore::ComputeImageLinearAverage (const FImageView &Image)
 
IMAGECORE_API void FImageCore::TransformToWorkingColorSpace (const FImageView &InLinearImage, const FVector2d &SourceRedChromaticity, const FVector2d &SourceGreenChromaticity, const FVector2d &SourceBlueChromaticity, const FVector2d &SourceWhiteChromaticity, UE::Color::EChromaticAdaptationMethod Method, double EqualityTolerance=1.e-7)
 
 FImageCore::ENUM_CLASS_FLAGS (EResizeImageFilter)
 
IMAGECORE_API void FImageCore::ResizeImage (const FImageView &SourceImage, const FImageView &DestImage, EResizeImageFilter Filter=EResizeImageFilter::Default)
 
IMAGECORE_API void FImageCore::ResizeImageAllocDest (const FImageView &SourceImage, FImage &DestImage, int32 DestSizeX, int32 DestSizeY, ERawImageFormat::Type DestFormat, EGammaSpace DestGammaSpace, EResizeImageFilter Filter=EResizeImageFilter::Default)
 
IMAGECORE_API void FImageCore::ResizeImageAllocDest (const FImageView &SourceImage, FImage &DestImage, int32 DestSizeX, int32 DestSizeY, EResizeImageFilter Filter=EResizeImageFilter::Default)
 
IMAGECORE_API void FImageCore::ResizeImageInPlace (FImage &Image, int32 DestSizeX, int32 DestSizeY, ERawImageFormat::Type DestFormat, EGammaSpace DestGammaSpace, EResizeImageFilter Filter=EResizeImageFilter::Default)
 
IMAGECORE_API void FImageCore::ResizeImageInPlace (FImage &Image, int32 DestSizeX, int32 DestSizeY, EResizeImageFilter Filter=EResizeImageFilter::Default)
 

Typedef Documentation

◆ FSharedImageConstRef

◆ FSharedImageRef

Function Documentation

◆ ImageParallelForComputeNumJobsForPixels()

IMAGECORE_API int32 ImageParallelForComputeNumJobsForPixels ( int64 OutNumPixelsPerJob,
int64  NumPixels 
)

◆ ImageParallelForComputeNumJobsForRows()

IMAGECORE_API int32 ImageParallelForComputeNumJobsForRows ( int32 OutNumItemsPerJob,
int64  SizeX,
int64  SizeY 
)