1. Epic GamesDeveloper
  3. FImageUtils

FImageUtils

Class of static image utility functions.

Unreal Engine C++ API Reference > Runtime > Engine

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Public/ImageUtils.h
Include #include "ImageUtils.h"

Syntax

class FImageUtils

Remarks

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

Functions

  Type Name Description
Public function Static bool

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

 "Compress" an image to a file format.
Public function Static UTextureCube *

CreateCheckerboardCubeTexture ( FColor ColorOne,
FColor ColorTwo,
int32 CheckerSize
)

 Creates a new UTextureCube with a checkerboard pattern.
Public function Static UTexture2D *

CreateCheckerboardTexture ( FColor ColorOne,
FColor ColorTwo,
int32 CheckerSize
)

 Creates a new UTexture2D with a checkerboard pattern.
Public function Static UTexture2DArray *

CreateCheckerboardTexture2DArray ( FColor ColorOne,
FColor ColorTwo,
int32 CheckerSize,
int32 ArraySize
)

 Creates a new UTexture2DArray with a checkerboard pattern.
Public function Static UTextureCubeArray *

CreateCheckerboardTextureCubeArray ( FColor ColorOne,
FColor ColorTwo,
int32 CheckerSize,
int32 ArraySize
)

 Creates a new UTextureCubeArray with a checkerboard pattern.
Public function Static UVolumeTexture *

CreateCheckerboardVolumeTexture ( FColor ColorOne,
FColor ColorTwo,
int32 CheckerSize
)

 Creates a new UVolumeTexture with a checkerboard pattern.
Public function 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.
Public function Static UTexture2D * Creates a 2D texture from an FImage
Public function 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.
Public function Static bool

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

 "Decompress" an image to a file format.
Public function Static bool Exports a UTextureRenderTarget2D as a EXR image on the disk.
Public function Static bool Exports a UTextureRenderTarget2D as an HDR image on the disk.
Public function Static bool Exports a UTextureRenderTarget2D as a PNG image on the disk.
Public function Static bool Exports a UTextureRenderTargetCube as an HDR image on the disk.
Public function Static bool Exports a UTexture2D as an HDR image on the disk.
Public function Static bool Exports a UTextureCube as an HDR image on the disk.
Public function 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
Public function Static bool

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

 Should be removed from public API.
Public function Static bool Get the contents of a RenderTarget into an Image
Public function Static bool

GetTexture2DSourceImage ( UTexture2D* Texture,
FImage& OutImage
)

 If Texture source is available, get it as an FImage
Public function Static void

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

 Resizes the given image using a simple average filter and stores it in the destination array.
Public function 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 a simple average filter and stores it in the destination array.
Public function Static void

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

 Resizes the given image using a simple average filter and stores it in the destination array.
Public function Static void

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

 Resizes the given image using a simple average filter and stores it in the destination array.
Public function Static UTexture2D *

ImportBufferAsTexture2D ( TArrayView64< const uint8 > Buffer
)

 Imports a texture a buffer and creates Texture2D from it
Public function Static UTexture2D *

ImportBufferAsTexture2D ( const TArray< uint8 >& Buffer
)

 Imports a texture a buffer and creates Texture2D from it
Public function Static UTexture2D *

ImportFileAsTexture2D ( const FString& Filename
)

 Imports a texture file from disk and creates Texture2D from it
Public function Static bool

LoadImage ( const TCHAR* Filename,
FImage& OutImage
)

 Load an image of any type supported by the ImageWrapper module
Public function 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
Public function Static bool

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

 Save an image.
Public function Static bool

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

 Save an image.
Public function 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.

Deprecated Functions

  Type Name Description
Public function Static void

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

 Please use PNGCompressImageArray or ThumbnailCompressImageArray

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page