1. Epic GamesDeveloper
  3. FImageUtils

FImageUtils

Class of static image utility functions.

API > API/Runtime > API/Runtime/Engine

Class of static image utility functions.

Provides load/save of FImage and conversion from Texture2D/RenderTarget to/from FImage

in Engine, cannot be used by standalone texture build workers

   
Name FImageUtils
Type class
Header File /Engine/Source/Runtime/Engine/Public/ImageUtils.h
Include Path #include "ImageUtils.h"

Syntax

class FImageUtils

Functions

Static

Name Remarks Include Path Unreal Specifiers

static bool CompressImage ( TArray64< uint8 >& OutData,
const TCHAR* ToFormatExtension,
const FImageView& InImage,
int32 Quality
)

 "Compress" an image to a file format. ImageUtils.h  

static void CompressImageArray ( int32 ImageWidth,
int32 ImageHeight,
const TArray< FColor >& SrcData,
TArray< uint8 >& DstData
)

   ImageUtils.h  

static UTextureCube * CreateCheckerboardCubeTexture ( FColor ColorOne,
FColor ColorTwo,
int32 CheckerSize
)

 Creates a new UTextureCube with a checkerboard pattern. ImageUtils.h  

static UTexture2D * CreateCheckerboardTexture ( FColor ColorOne,
FColor ColorTwo,
int32 CheckerSize
)

 Creates a new UTexture2D with a checkerboard pattern. ImageUtils.h  

static UTexture2DArray * CreateCheckerboardTexture2DArray ( FColor ColorOne,
FColor ColorTwo,
int32 CheckerSize,
int32 ArraySize
)

 Creates a new UTexture2DArray with a checkerboard pattern. ImageUtils.h  

static UTextureCubeArray * CreateCheckerboardTextureCubeArray ( FColor ColorOne,
FColor ColorTwo,
int32 CheckerSize,
int32 ArraySize
)

 Creates a new UTextureCubeArray with a checkerboard pattern. ImageUtils.h  

static UVolumeTexture * CreateCheckerboardVolumeTexture ( FColor ColorOne,
FColor ColorTwo,
int32 CheckerSize
)

 Creates a new UVolumeTexture with a checkerboard pattern. ImageUtils.h  

static UTexture * CreateTexture ( ETextureClass TextureClass,
const FImageView& Image,
UObject* Outer,
const FString& Name,
EObjectFlags Flags,
bool DoPostEditChange
)

 Creates a texture of any type from an Image This is the modern preferred way to create a texture. ImageUtils.h  

static UTexture2D * CreateTexture2D ( int32 SrcWidth,
int32 SrcHeight,
const TArray< FColor >& SrcData,
UObject* Outer,
const FString& Name,
const EObjectFlags& Flags,
const FCreateTexture2DParameters& InParams
)

 Creates a 2D texture from a array of raw color data. ImageUtils.h  

static UTexture2D * CreateTexture2DFromImage ( const FImageView& Image
)

 Creates a 2D texture from an FImage ImageUtils.h  

static void CropAndScaleImage ( int32 SrcWidth,
int32 SrcHeight,
int32 DesiredWidth,
int32 DesiredHeight,
const TArray< FColor >& SrcData,
TArray< FColor >& DstData
)

 Crops, and scales an image from a raw image array. ImageUtils.h  

static bool DecompressImage ( const void* InCompressedData,
int64 InCompressedSize,
FImage& OutImage
)

 "Decompress" an image to a file format. ImageUtils.h  
Exports a UTextureRenderTarget2D as a EXR image on the disk. ImageUtils.h  
Exports a UTextureRenderTarget2D as an HDR image on the disk. ImageUtils.h  
Exports a UTextureRenderTarget2D as a PNG image on the disk. ImageUtils.h  
Exports a UTextureRenderTargetCube as an HDR image on the disk. ImageUtils.h  

static bool ExportRenderTargetToDDS ( TArray64< uint8 >& OutData,
UTextureRenderTarget* TexRT
)

 Export Texture RenderTarget (2D,Array,Cube,CubeArray,Volume) to DDS reads from texture rendertarget RHI texture ImageUtils.h  

static bool ExportTexture2DAsHDR ( UTexture2D* TexRT,
FArchive& Ar
)

 Exports a UTexture2D as an HDR image on the disk. ImageUtils.h  

static bool ExportTextureCubeAsHDR ( UTextureCube* TexRT,
FArchive& Ar
)

 Exports a UTextureCube as an HDR image on the disk. ImageUtils.h  

static bool ExportTextureSourceToDDS ( TArray64< uint8 >& OutData,
UTexture* Texture,
int BlockIndex,
int LayerIndex
)

 Export Texture (2D,Array,Cube,CubeArray,Volume) to DDS reads from texture source, not platform data ImageUtils.h  

static bool GetRawData ( UTextureRenderTarget2D* TexRT,
TArray64< uint8 >& RawData
)

   ImageUtils.h  

static bool GetRenderTargetImage ( UTextureRenderTarget* TexRT,
FImage& OutImage,
const FIntRect& Rect
)

   ImageUtils.h  

static bool GetRenderTargetImage ( UTextureRenderTarget* TexRT,
FImage& OutImage
)

 Get the contents of a RenderTarget into an Image ImageUtils.h  

static bool GetTexture2DSourceImage ( UTexture2D* Texture,
FImage& OutImage
)

 If Texture source is available, get it as an FImage ImageUtils.h  

static void ImageResize ( int32 SrcWidth,
int32 SrcHeight,
const TArrayView< const FColor >& SrcData,
int32 DstWidth,
int32 DstHeight,
const TArrayView< FColor >& DstData,
bool bResizeSRGBinLinearSpace,
bool bForceOpaqueOutput
)

 Resizes the given image using FImageCore::ResizeImage. ImageUtils.h  

static void ImageResize ( int32 SrcWidth,
int32 SrcHeight,
const TArray< FColor >& SrcData,
int32 DstWidth,
int32 DstHeight,
TArray< FColor >& DstData,
bool bResizeSRGBinLinearSpace,
bool bForceOpaqueOutput
)

 Resizes the given image using FImageCore::ResizeImage. ImageUtils.h  

static void ImageResize ( int32 SrcWidth,
int32 SrcHeight,
const TArrayView64< const FLinearColor >& SrcData,
int32 DstWidth,
int32 DstHeight,
const TArrayView64< FLinearColor >& DstData
)

 Resizes the given image using FImageCore::ResizeImage. ImageUtils.h  

static void ImageResize ( int32 SrcWidth,
int32 SrcHeight,
const TArray64< FLinearColor >& SrcData,
int32 DstWidth,
int32 DstHeight,
TArray64< FLinearColor >& DstData
)

 Resizes the given image using FImageCore::ResizeImage. ImageUtils.h  

static UTexture2D * ImportBufferAsTexture2D ( const TArray< uint8 >& Buffer
)

   ImageUtils.h  

static UTexture2D * ImportBufferAsTexture2D ( TArrayView64< const uint8 > Buffer
)

 Imports a texture a buffer and creates Texture2D from it ImageUtils.h  

static UTexture2D * ImportFileAsTexture2D ( const FString& Filename
)

 Imports a texture file from disk and creates Texture2D from it ImageUtils.h  

static bool LoadImage ( const TCHAR* Filename,
FImage& OutImage
)

 Load an image of any type supported by the ImageWrapper module ImageUtils.h  

static void PNGCompressImageArray ( int32 ImageWidth,
int32 ImageHeight,
const TArrayView64< const FColor >& SrcData,
TArray64< uint8 >& DstData
)

 Compress image to PNG format uint8 array. deprecated, use CompressImage instead ImageUtils.h  

static bool SaveImageAutoFormat ( const TCHAR* Filename,
const FImageView& InImage,
int32 Quality
)

 Save an image. ImageUtils.h  

static bool SaveImageByExtension ( const TCHAR* Filename,
const FImageView& InImage,
int32 Quality
)

 Save an image. ImageUtils.h  

static void ThumbnailCompressImageArray ( int32 ImageWidth,
int32 ImageHeight,
const TArray< FColor >& SrcData,
TArray< uint8 >& DstData
)

 Compress image to thumbnail enabled format (png or jpg) uint8 array. ImageUtils.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page