FImage

Structure for raw image data.

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

FColor *

 

AsBGRA8()

Public function Const

const FColor...

 

AsBGRA8()

Public function

FColor *

 

AsBGRE8()

Public function Const

const FColor...

 

AsBGRE8()

Public function

uint16 *

 

AsG16()

Public function Const

const uint16...

 

AsG16()

Public function Const

const uint8 ...

 

AsG8()

Public function

uint8 *

 

AsG8()

Public function

uint16 *

 

AsRGBA16()

Public function Const

const uint16...

 

AsRGBA16()

Public function Const

const FFloat...

 

AsRGBA16F()

Public function

FFloat16Colo...

 

AsRGBA16F()

Public function Const

const FLinea...

 

AsRGBA32F()

Public function

FLinearColor...

 

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

 

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.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss