1. Epic GamesDeveloper
  3. FImage

FImage

Structure for raw image data.

API > API/Runtime > API/Runtime/ImageCore

Structure for raw image data.

   
Name FImage
Type struct
Header File /Engine/Source/Runtime/ImageCore/Public/ImageCore.h
Include Path #include "ImageCore.h"

Syntax

struct FImage : public FImageInfo

Inheritance Hierarchy

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

FImage ( int32 InSizeX,
int32 InSizeY,
int32 InNumSlices,
ERawImageFormat::Type InFormat,
EGammaSpace InGammaSpace
)

 Creates and initializes a new image with the specified number of slices. ImageCore.h  

FImage ( int32 InSizeX,
int32 InSizeY,
ERawImageFormat::Type InFormat,
EGammaSpace InGammaSpace
)

 Creates and initializes a new image with a single slice. ImageCore.h  

FImage ( int32 InSizeX,
int32 InSizeY,
int32 InNumSlices,
ERawImageFormat::Type InFormat
)

 Note: changed default GammaSpace from Linear to GetDefaultGammaSpace ImageCore.h  

FImage ( int32 InSizeX,
int32 InSizeY,
ERawImageFormat::Type InFormat
)

 Note: changed default GammaSpace from Linear to GetDefaultGammaSpace ImageCore.h  

FImage ( const FImage& CopyFrom
)

   ImageCore.h  

FImage ()

 Default constructor. ImageCore.h  

FImage ( FImage&& MoveFrom
)

 Move constructor ImageCore.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
RawData TArray64< uint8 > Raw image data. ImageCore.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

TArrayView64< const FColor > AsBGRA8 ()

   ImageCore.h  

TArrayView64< FColor > AsBGRA8 ()

   ImageCore.h  

TArrayView64< const FColor > AsBGRE8 ()

   ImageCore.h  

TArrayView64< FColor > AsBGRE8 ()

   ImageCore.h  

TArrayView64< const uint16 > AsG16 ()

   ImageCore.h  

TArrayView64< uint16 > AsG16 ()

   ImageCore.h  

TArrayView64< const uint8 > AsG8 ()

   ImageCore.h  

TArrayView64< uint8 > AsG8 ()

   ImageCore.h  

TArrayView64< FFloat16 > AsR16F ()

   ImageCore.h  

TArrayView64< const FFloat16 > AsR16F ()

   ImageCore.h  

TArrayView64< const float > AsR32F ()

   ImageCore.h  

TArrayView64< float > AsR32F ()

   ImageCore.h  

TArrayView64< const uint16 > AsRGBA16 ()

   ImageCore.h  

TArrayView64< uint16 > AsRGBA16 ()

   ImageCore.h  

TArrayView64< FFloat16Color > AsRGBA16F ()

   ImageCore.h  

TArrayView64< const FFloat16Color > AsRGBA16F ()

   ImageCore.h  

TArrayView64< FLinearColor > AsRGBA32F ()

   ImageCore.h  

TArrayView64< const FLinearColor > AsRGBA32F ()

   ImageCore.h  

void ChangeFormat ( ERawImageFormat::Type DestFormat,
EGammaSpace DestGammaSpace
)

 In-place format change : does nothing if already in the desired format ImageCore.h  

void CopyTo ( FImage& DestImage,
ERawImageFormat::Type DestFormat,
EGammaSpace DestGammaSpace
) const

 Copies the image to a destination image with the specified format. ImageCore.h  

void CopyTo ( FImage& DestImage
) const

 CopyTo same format. ImageCore.h  

void FreeData ( bool bAsyncDetached
)

 Free FImage.RawData if bAsyncDetached free is done on a Task, not immediately, but the RawData member is empty upon return note that FreeData does not change the FImageInfo fields, only frees RawData, follow up with Reset() if desired ImageCore.h  

const FLinearColor GetOnePixelLinear ( int32 X,
int32 Y,
int32 Slice
) const

 Get one pixel from the image and return in Linear color. ImageCore.h  

void * GetPixelPointer ( int32 X,
int32 Y,
int32 Slice
) const

 Get a pointer to a pixel ImageCore.h  

FImageView GetSlice ( int32 SliceIndex
) const

 Get an FImageView to one 2d slice ImageCore.h  

void Init ( int32 InSizeX,
int32 InSizeY,
ERawImageFormat::Type InFormat
)

   ImageCore.h  

void Init ( int32 InSizeX,
int32 InSizeY,
ERawImageFormat::Type InFormat,
EGammaSpace InGammaSpace
)

 Initializes this image with a single slice. Allocates RawData. ImageCore.h  

void Init ( int32 InSizeX,
int32 InSizeY,
int32 InNumSlices,
ERawImageFormat::Type InFormat,
EGammaSpace InGammaSpace
)

 Initializes this image with the specified number of slices. Allocates RawData. ImageCore.h  

void Init ( const FImageInfo& Info
)

 Initializes this image with specified Info. Allocates RawData. ImageCore.h  

void Init ( int32 InSizeX,
int32 InSizeY,
int32 InNumSlices,
ERawImageFormat::Type InFormat
)

   ImageCore.h  

void Linearize ( FImage& DestImage
) const

   ImageCore.h  

void Linearize ( uint8 SourceEncoding,
FImage& DestImage
) const

 Linearize to a RGBA32F destination image by applying the decoding function that corresponds to the specified source encoding. ImageCore.h  

void Reset()

 Reset this FImage to empty default constructed state. ImageCore.h  

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

 Copies and resizes the image to a destination image with the specified size and format. ImageCore.h  

void Swap ( FImage& Other
)

 Swap the contents of this FImage with another. ImageCore.h  

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

   ImageCore.h  

Operators

Name Remarks Include Path Unreal Specifiers

operator FImageView()

 Implicit conversion to FImageView allows FImage to be passed to functions that take FImageView functions that read images should use "const FImageView &" as their argument type ImageCore.h  

FImage & operator= ( FImage&& MoveFrom
)

 Move assignment ImageCore.h  

FImage & operator= ( const FImage& CopyFrom
)

   ImageCore.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page