FImage

Structure for raw image data.

Choose your operating system:

Windows

macOS

Linux

References

Module

ImageCore

Header

/Engine/Source/Runtime/ImageCore/Public/ImageCore.h

Include

#include "ImageCore.h"

Syntax

struct FImage

Remarks

Structure for raw image data.

Variables

Name Description

Public variable

ERawImageFormat...

 

Format

Format in which the image is stored.

Public variable

EGammaSpace

 

GammaSpace

The gamma space the image is stored in.

Public variable

int32

 

NumSlices

Number of image slices.

Public variable

TArray64< uint8...

 

RawData

Raw image data.

Public variable

int32

 

SizeX

Width of the image.

Public variable

int32

 

SizeY

Height of the image.

Constructors

Name Description

Public function

FImage()

Default constructor.

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

Name Description

Public function

TArrayView64...

 

AsBGRA8()

Public function Const

TArrayView64...

 

AsBGRA8()

Public function

TArrayView64...

 

AsBGRE8()

Public function Const

TArrayView64...

 

AsBGRE8()

Public function

TArrayView64...

 

AsG16()

Public function Const

TArrayView64...

 

AsG16()

Public function Const

TArrayView64...

 

AsG8()

Public function

TArrayView64...

 

AsG8()

Public function

TArrayView64...

 

AsR16F()

Public function Const

TArrayView64...

 

AsR16F()

Public function Const

TArrayView64...

 

AsRGBA16()

Public function

TArrayView64...

 

AsRGBA16()

Public function Const

TArrayView64...

 

AsRGBA16F()

Public function

TArrayView64...

 

AsRGBA16F()

Public function Const

TArrayView64...

 

AsRGBA32F()

Public function

TArrayView64...

 

AsRGBA32F()

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 Const

int32

 

GetBytesPerPixel()

Gets the number of bytes per pixel.

Public function

void

 

Init

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

Initializes this image with a single 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.

Public function Const

bool

 

IsGammaCorrected()

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

 

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

 

TransformToWorkingColorSpace

(
    const FVector2D& SourceRedChromati...,
    const FVector2D& SourceGreenChroma...,
    const FVector2D& SourceBlueChromat...,
    const FVector2D& SourceWhiteChroma...,
    UE::Color::EChromaticAdaptationMeth...,
    double EqualityTolerance
)

Apply a color space transformation from the source chromaticities to the engine's working color space.