1. Epic GamesDeveloper
  3. FImage

FImage

Structure for raw image data.

API > API/Runtime > API/Runtime/ImageCore

Inheritance Hierarchy

References

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

Syntax

struct FImage : public FImageInfo

Remarks

Structure for raw image data.

Variables

  Type Name Description
Public variable TArray64< uint8 > RawData Raw image data.

Constructors

  Type Name Description
Public function  

FImage ()

 Default constructor.
Public function  

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

 Note: changed default GammaSpace from Linear to GetDefaultGammaSpace
Public function  

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

 Note: changed default GammaSpace from Linear to GetDefaultGammaSpace
Public function  

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

 Creates and initializes a new image with a single slice.
Public function  

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

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

Functions

  Type Name Description
Public function Const TArrayView64< const FColor >

AsBGRA8 ()

  
Public function TArrayView64< FColor >

AsBGRA8 ()

  
Public function Const TArrayView64< const FColor >

AsBGRE8 ()

  
Public function TArrayView64< FColor >

AsBGRE8 ()

  
Public function Const TArrayView64< const uint16 >

AsG16 ()

  
Public function TArrayView64< uint16 >

AsG16 ()

  
Public function TArrayView64< uint8 >

AsG8 ()

  
Public function Const TArrayView64< const uint8 >

AsG8 ()

  
Public function Const TArrayView64< const FFloat16 >

AsR16F ()

  
Public function TArrayView64< FFloat16 >

AsR16F ()

  
Public function TArrayView64< float >

AsR32F ()

  
Public function Const TArrayView64< const float >

AsR32F ()

  
Public function TArrayView64< uint16 >  
Public function Const TArrayView64< const uint16 >  
Public function TArrayView64< FFloat16Color >  
Public function Const TArrayView64< const FFloat16Color >  
Public function TArrayView64< FLinearColor >  
Public function Const TArrayView64< const FLinearColor >  
Public function void

ChangeFormat ( ERawImageFormat::Type DestFormat,
EGammaSpace DestGammaSpace
)

 In-place format change : does nothing if already in the desired format
Public function Const void

CopyTo ( FImage& DestImage
)

 CopyTo same format.
Public function Const void

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

 Copies the image to a destination image with the specified format.
Public function 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
Public function Const const FLinearColor Get one pixel from the image and return in Linear color.
Public function Const void *

GetPixelPointer ( int32 X,
int32 Y,
int32 Slice
)

 Get a pointer to a pixel
Public function Const FImageView

GetSlice ( int32 SliceIndex
)

 Get an FImageView to one 2d slice
Public function void

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

 Initializes this image with the specified number of slices. Allocates RawData.
Public function void

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

 Initializes this image with a single slice. Allocates RawData.
Public function void

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

  
Public function void

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

  
Public function void

Init ( const FImageInfo& Info
)

 Initializes this image with specified Info. Allocates RawData.
Public function Const void

Linearize ( uint8 SourceEncoding,
FImage& DestImage
)

 Linearize to a RGBA32F destination image by applying the decoding function that corresponds to the specified source encoding.
Public function Const void

Linearize ( FImage& DestImage
)

  
Public function Const void

ResizeTo ( 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

Swap ( FImage& Other
)

 Swap the contents of this FImage with another.
Public function void

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

  

Operators

  Type Name Description
Public function Const   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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page