1. Epic GamesDeveloper
  3. ImageCore

ImageCore

API > API/Runtime

Classes

  Type Name Description
Public struct FDDSFile Metadata structure for a DDS file, with access pointers for the raw texture data (i.e. unconverted from the DXGI format).  
Public struct FDDSMip One of these for each mip of a DDS.  
Public struct FImage Structure for raw image data.  
Public struct FImageInfo FImageInfo describes a 2d pixel surface it can be used by FImage or FImageView  
Public struct FImageView    

Enums

  Type Name Description
Public enum ERawImageFormat::Type Enumerates supported raw image formats. should map one-to-one with ETextureSourceFormat  
Public enum FImageCore::ProcessLinearPixelsAction The easy and efficient way to write a pixel processing loop that supports all pixel formats is to use  
Public enum UE::DDS::EChannelOrder Channel ordering for 8-bit formats.  
Public enum UE::DDS::EDDSError Error codes.  
Public enum UE::DDS::EDDSFormatVersion What version of DDS file to write.  
Public enum UE::DDS::EDXGIFormat Complete list of formats.  

Functions

  Type Name Description
Public function int64 RGBA -> G8 takes from the R channel G8 -> RGBA replicated to gray
Public function EGammaSpace When converting from pixel bags that don't store gamma to FImage you can use this to guess the gamma they probably wanted do not use when a real gamma flag is available!
Public function bool G8 and BGRA8 are affected by Gamma 16/32 is NOT
Public function const TCHAR *  
Public function const FLinearColor

ERawImageFormat::GetOnePixelLinear ( const void* PixelData,
Type Format,
EGammaSpace Gamma
)

 Get one pixel of Format type from PixelData and return in Linear color.
Public function const FLinearColor

ERawImageFormat::GetOnePixelLinear ( const void* PixelData,
Type Format,
bool bSRGB
)

 Get one pixel of Format type from PixelData and return in Linear color.
Public function bool  
Public function void Compute the min/max of each channel to get value ranges Colors are converted to float Linear Gamma
Public function FLinearColor ComputeImageLinearAverage compute the average linear color of the image image can be any pixel format parallel processing is used, but the result is not machine-dependent
Public function void

FImageCore::CopyImage ( const FImageView& SrcImage,
const FImageView& DestImage
)

 Copy FImageView data, converting pixels if necessary.
Public function void

FImageCore::CopyImageRGBABGRA ( const FImageView& SrcImage,
const FImageView& DestImage
)

 Copy Image, swapping RB, SrcImage must be BGRA8 or RGBA16.
Public function void

FImageCore::CopyImageTo2U16 ( const FImageView& SrcImage,
const FImageView& DestImage
)

 Copy Image to 2xU16 ; Dest Image should be allocated as BGRA8 but is actually 2xU16 Sizes must match.
Public function bool Detects whether or not the image contains an alpha channel where at least one texel is != 255.
Public function void

FImageCore::ImageParallelFor ( const TCHAR* DebugName,
const FImageView& Image,
const Lambda& Func
)

 Lambda is a functor that works on an FImageView() it will be called with portions of the image each portion will be a 2d FImageView (NumSlices == 1) use like : FImageCore::ImageParallelFor( TEXT("Texture.AdjustImageColorsFunc.PF"),Image, & {
Public function int32

FImageCore::ImageParallelForComputeNumJobs ( const FImageView& Image,
int64* pRowsPerJob
)

 FImage is tight packed in memory with slices adjacent to each other so we can just treat it was a 2d image with Height *= NumSlices
Public function void

FImageCore::ImageParallelForMakePart ( FImageView* Part,
const FImageView& Whole,
int64 JobIndex,
int64 RowsPerJob
)

  
Public function void

FImageCore::ImageParallelProcessLinearPixels ( const TCHAR* DebugName,
const FImageView& Image,
const Lambda& Func
)

 Parallel process image as TArrayView64 your lambda is called on one row at a time so that the grouping is machine invariant
Public function void

FImageCore::ProcessLinearPixels ( const FImageView& Image,
const Lambda& Func
)

 ProcessLinearPixels act on image pixels as TArrayView64 Colors pass a lambda that is : ProcessLinearPixelsAction ProcessPixels(TArrayView64 Colors) return ProcessLinearPixelsAction::Modified if you modify colors return ProcessLinearPixelsAction::ReadOnly if you only read and don't change colors your lambda will be called on one row at a time
Public function void

FImageCore::ResizeTo ( const FImageView& SourceImage,
FImage& DestImage,
int32 DestSizeX,
int32 DestSizeY,
ERawImageFormat::Type DestFormat,
EGammaSpace DestGammaSpace
)

 Copies and resizes the image to a destination image with the specified size and format.
Public function void Clamp Float16 colors which aren't encodable in the BC6H format RGB is clamped to non-negative and finite A is set to 1.0
Public function void Change alpha channel to opaque, if present
Public function void

FImageCore::TransformToWorkingColorSpace ( const FImageView& InLinearImage,
const FVector2d& SourceRedChromaticity,
const FVector2d& SourceGreenChromaticity,
const FVector2d& SourceBlueChromaticity,
const FVector2d& SourceWhiteChromaticity,
UE::Color::EChromaticAdaptationMethod Method,
double EqualityTolerance
)

 Apply a color space transformation from the source chromaticities to the engine's working color space.
Public function void Swap RB channels on Image. Image must be BGRA8 or RGBA16.
Public function ERawImageFormat::Type

FImageCoreUtils::ConvertToRawImageFormat ( ETextureSourceFormat Format
)

 ETextureSourceFormat and ERawImageFormat::Type are one-to-one :
Public function ETextureSourceFormat  
Public function FName  
Public function ETextureSourceFormat

FImageCoreUtils::GetCommonSourceFormat ( ETextureSourceFormat Format1,
ETextureSourceFormat Format2
)

 Returns ETextureSourceFormat which can be used to efficiently store data encoded in both input formats.
Public function int32

FImageCoreUtils::GetMipCountFromDimensions ( int32 InSizeX,
int32 InSizeY,
int32 InVolumeZ,
bool bInIsVolume
)

 Returns the number of mips that constitute a full mip chain for the given top level mip size.
Public function EPixelFormat EPixelFormat is the graphics texture pixel format it is a much larger superset of ERawImageFormat GetPixelFormatForRawImageFormat does not map to the very closest EPixelFormat instead map to a close one that is actually usable as Texture if *pOutEquivalentFormat != InFormat , then conversion is needed and conversion can be done using CopyImage to OutEquivalentFormat
Public function bool

FImageCoreUtils::IsImageImportPossible ( int64 Width,
int64 Height
)

 IsImageImportPossible returns false if the image dimensions are not supported to import if this function returns true, image import might still fail due to further constraints (this constraint is weaker than the one actually required) (see IsImportResolutionValid, which is also still weaker than the final constraint) IsImageImportPossible does not check current Engine config or platform limits, only hard-coded absolute limits

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page