FImagePixelData

Inheritance Hierarchy

FImagePixelData

TImagePixelData

References

Module

ImageWriteQueue

Header

/Engine/Source/Runtime/ImageWriteQueue/Public/ImagePixelData.h

Include

#include "ImagePixelData.h"

Syntax

struct FImagePixelData

Constructors

Name Description

Protected function

FImagePixelData

(
    const FIntPoint& InSize,
    EImagePixelType InPixelType,
    ERGBFormat InPixelLayout,
    uint8 InBitDepth,
    uint8 InNumChannels,
    FImagePixelPayloadPtr InPayload
)

Destructors

Name Description

Public function Virtual

~FImagePixelData()

Functions

Name Description

Public function Const

TUniquePtr< ...

 

CopyImageData()

Copy this whole image buffer. This can be very costly for large images.

Public function Const

uint8

 

GetBitDepth()

Retrieve the number of bits per each channel of color in the data

Public function Const

FImageView

 

GetImageView()

Get the pixel data as an FImage

Public function Const

uint8

 

GetNumChannels()

Retrieve the number of channels in the data

Public function

T *

 

GetPayload()

Return a pointer to the Payload stored in this data.

Public function Const

const T *...

 

GetPayload()

Return a const pointer to the Payload stored in this data.

Public function Const

ERGBFormat

 

GetPixelLayout()

Retrieve the pixel layout of this data

Public function Const

bool

 

GetRawData

(
    const void*& OutRawData,
    int64& OutSizeBytes
)

Get the data and its size only if it is well formed

Public function Const

int64

 

GetRawDataSizeInBytes()

Get the size in bytes, regardless of if it is well formed.

Public function Const

FIntPoint

 

GetSize()

Retrieve the size of this data

Public function Const

bool

 

GetSRGB()

Public function Const

EImagePixelT...

 

GetType()

NOTE : before, U8 would be written to EXR linear now it will get gamma corrected if bSRGB (which is on by default) Retrieve the type of this data

Public function Const

bool

 

IsDataWellFormed()

Check that this data is the size it should be

Public function

TUniquePtr< ...

 

MoveImageDataToNew()

Move this whole image buffer to a new allocation.

Public function

void

 

SetPayload

(
    FImagePixelPayloadPtr NewPayload
)

Sets the payload after construction.

Public function

void

 

SetSRGB

(
    bool InSRGB
)

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