ImageUtils.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
/*=============================================================================
ImageUtils.h: Image/Textures utility functions 
=============================================================================*/
 
#pragma once
 
#include "CoreMinimal.h"
#include "Misc/Guid.h"
#include "ImageCore.h"
#include "Engine/Texture.h"
 
/*
 
NOTE: Please prefer to work with images through ImageCore FImage/FImageView
(not TextureSource/TextureSourceFormat or raw arrays of bytes)
 
Use FImageUtils::CompressImage/DecompressImage
 
The easiest way to load/save an image is FImageUtils::LoadImage/SaveImageByExtension
 
Typically let the user's filename choose the image format, don't hard-code them in code.
 
*/
 
class UTexture2D;
class UTexture2DArray;
class UTextureCube;
class UTextureCubeArray;
class UVolumeTexture;
class UTextureRenderTarget;
class UTextureRenderTarget2D;
class UTextureRenderTargetCube;
class IImageWrapperModule;
 
struct FCreateTexture2DParameters
{
    bool                        bUseAlpha;
 
    TextureCompressionSettings  CompressionSettings;
 
    bool                        bDeferCompression;
 
    bool                        bSRGB;
 
    bool                        bVirtualTexture;
 
    TextureMipGenSettings       MipGenSettings;
 
    TextureGroup                TextureGroup;
 
    /* The Guid hash to use part of the texture source's DDC key */
    FGuid                       SourceGuidHash;
 
    FCreateTexture2DParameters()
        :   bUseAlpha(false),
            CompressionSettings(TC_Default),
            bDeferCompression(false),
            bSRGB(true),
            bVirtualTexture(false),
            MipGenSettings(TMGS_FromTextureGroup),
            TextureGroup(TEXTUREGROUP_MAX)
    {
    }
};
 
class FImageUtils
{
public:
 
    ENGINE_API static bool LoadImage(const TCHAR * Filename, FImage & OutImage);
        
    ENGINE_API static bool SaveImageByExtension(const TCHAR * Filename, const FImageView & InImage, int32 Quality=0);
 
    ENGINE_API static bool SaveImageAutoFormat(const TCHAR * Filename, const FImageView & InImage, int32 Quality=0);
    
    ENGINE_API static bool CompressImage(TArray64<uint8> & OutData, const TCHAR * ToFormatExtension, const FImageView & InImage, int32 Quality = 0);
    
    ENGINE_API static bool DecompressImage(const void* InCompressedData, int64 InCompressedSize, FImage & OutImage);
    
    ENGINE_API static bool ExportTextureSourceToDDS(TArray64<uint8> & OutData, UTexture * Texture, int BlockIndex=0, int LayerIndex=0);
    
    ENGINE_API static bool ExportRenderTargetToDDS(TArray64<uint8> & OutData, UTextureRenderTarget * TexRT);
 
    ENGINE_API static bool GetTexture2DSourceImage( UTexture2D* Texture, FImage & OutImage);
 
    ENGINE_API static void ImageResize(int32 SrcWidth, int32 SrcHeight, const TArray<FColor> &SrcData,  int32 DstWidth, int32 DstHeight, TArray<FColor> &DstData, bool bResizeSRGBinLinearSpace, bool bForceOpaqueOutput=true);
 
    ENGINE_API static void ImageResize(int32 SrcWidth, int32 SrcHeight, const TArrayView<const FColor> &SrcData, int32 DstWidth, int32 DstHeight, const TArrayView<FColor> &DstData, bool bResizeSRGBinLinearSpace, bool bForceOpaqueOutput=true);
 
    ENGINE_API static void ImageResize(int32 SrcWidth, int32 SrcHeight, const TArray64<FLinearColor>& SrcData, int32 DstWidth, int32 DstHeight, TArray64<FLinearColor>& DstData);
 
    ENGINE_API static void ImageResize(int32 SrcWidth, int32 SrcHeight, const TArrayView64<const FLinearColor>& SrcData, int32 DstWidth, int32 DstHeight, const TArrayView64<FLinearColor>& DstData);
 
    ENGINE_API static UTexture2D* CreateTexture2D(int32 SrcWidth, int32 SrcHeight, const TArray<FColor> &SrcData, UObject* Outer, const FString& Name, const EObjectFlags &Flags, const FCreateTexture2DParameters& InParams);
    
    ENGINE_API static UTexture * CreateTexture(ETextureClass TextureClass, const FImageView & Image, UObject* Outer, const FString& Name, EObjectFlags Flags = RF_NoFlags, bool DoPostEditChange = true );
    
    ENGINE_API static UTexture2D* CreateTexture2DFromImage(const FImageView & Image);
 
    ENGINE_API static void CropAndScaleImage( int32 SrcWidth, int32 SrcHeight, int32 DesiredWidth, int32 DesiredHeight, const TArray<FColor> &SrcData, TArray<FColor> &DstData  );
 
    ENGINE_API static void ThumbnailCompressImageArray( int32 ImageWidth, int32 ImageHeight, const TArray<FColor> &SrcData, TArray<uint8> &DstData );
 
    UE_DEPRECATED(5.1, "Please use PNGCompressImageArray or ThumbnailCompressImageArray")
    static void CompressImageArray( int32 ImageWidth, int32 ImageHeight, const TArray<FColor> &SrcData, TArray<uint8> &DstData )
    {
        ThumbnailCompressImageArray(ImageWidth,ImageHeight,SrcData,DstData);
    }
 
    ENGINE_API static void PNGCompressImageArray(int32 ImageWidth, int32 ImageHeight, const TArrayView64<const FColor>& SrcData, TArray64<uint8>& DstData);
 
    ENGINE_API static UTexture2D* CreateCheckerboardTexture(FColor ColorOne = FColor(64, 64, 64), FColor ColorTwo = FColor(128, 128, 128), int32 CheckerSize = 32);
 
    ENGINE_API static UTexture2DArray* CreateCheckerboardTexture2DArray(FColor ColorOne = FColor(64, 64, 64), FColor ColorTwo = FColor(128, 128, 128), int32 CheckerSize = 32, int32 ArraySize = 1);
 
    ENGINE_API static UTextureCube* CreateCheckerboardCubeTexture(FColor ColorOne = FColor(64, 64, 64), FColor ColorTwo = FColor(128, 128, 128), int32 CheckerSize = 32);
 
    ENGINE_API static UTextureCubeArray* CreateCheckerboardTextureCubeArray(FColor ColorOne = FColor(64, 64, 64), FColor ColorTwo = FColor(128, 128, 128), int32 CheckerSize = 32, int32 ArraySize = 1);
 
    ENGINE_API static UVolumeTexture* CreateCheckerboardVolumeTexture(FColor ColorOne = FColor(64, 64, 64), FColor ColorTwo = FColor(128, 128, 128), int32 CheckerSize = 16);
 
    ENGINE_API static bool ExportRenderTarget2DAsHDR(UTextureRenderTarget2D* TexRT, FArchive& Ar);
    
    ENGINE_API static bool ExportRenderTarget2DAsEXR(UTextureRenderTarget2D* TexRT, FArchive& Ar);
 
    ENGINE_API static bool ExportRenderTarget2DAsPNG(UTextureRenderTarget2D* TexRT, FArchive& Ar);
 
    ENGINE_API static bool ExportTexture2DAsHDR(UTexture2D* TexRT, FArchive& Ar);
 
    ENGINE_API static UTexture2D* ImportFileAsTexture2D(const FString& Filename);
 
    ENGINE_API static UTexture2D* ImportBufferAsTexture2D(TArrayView64<const uint8> Buffer);
    ENGINE_API static UTexture2D* ImportBufferAsTexture2D(const TArray<uint8>& Buffer);
    
    ENGINE_API static bool ExportRenderTargetCubeAsHDR(UTextureRenderTargetCube* TexRT, FArchive& Ar);
 
    ENGINE_API static bool ExportTextureCubeAsHDR(UTextureCube* TexRT, FArchive& Ar);
 
    UE_DEPRECATED(5.5, "Use GetRenderTargetImage")
    ENGINE_API static bool GetRawData(UTextureRenderTarget2D* TexRT, TArray64<uint8>& RawData);
    
    ENGINE_API static bool GetRenderTargetImage(UTextureRenderTarget* TexRT, FImage & OutImage);
    ENGINE_API static bool GetRenderTargetImage(UTextureRenderTarget* TexRT, FImage & OutImage, const FIntRect & Rect);
 
};