Navigation
API > API/Runtime > API/Runtime/ImageWriteQueue
| Name | FImagePixelData |
| Type | struct |
| Header File | /Engine/Source/Runtime/ImageWriteQueue/Public/ImagePixelData.h |
| Include Path | #include "ImagePixelData.h" |
Syntax
struct FImagePixelData
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FImagePixelData
(
const FIntPoint& InSize, |
ImagePixelData.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FImagePixelData() |
ImagePixelData.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| BitDepth | uint8 | The number of bits per each channel of color in the data | ImagePixelData.h | |
| bSRGB | bool | Is FColor SRGB or Linear? Floats are always Linear and ignore this | ImagePixelData.h | |
| NumChannels | uint8 | Number of channels in the data | ImagePixelData.h | |
| Payload | FImagePixelPayloadPtr | Optional user-specified payload | ImagePixelData.h | |
| PixelLayout | ERGBFormat | The pixel layout of this data | ImagePixelData.h | |
| Size | FIntPoint | The size of the pixel data | ImagePixelData.h | |
| Type | EImagePixelType | The type of the derived data | ImagePixelData.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TUniquePtr< FImagePixelData > CopyImageData() |
Copy this whole image buffer. This can be very costly for large images. | ImagePixelData.h | |
uint8 GetBitDepth() |
Retrieve the number of bits per each channel of color in the data | ImagePixelData.h | |
FImageView GetImageView() |
Get the pixel data as an FImage | ImagePixelData.h | |
uint8 GetNumChannels() |
Retrieve the number of channels in the data | ImagePixelData.h | |
T * GetPayload () |
Return a pointer to the Payload stored in this data. | ImagePixelData.h | |
const T * GetPayload () |
Return a const pointer to the Payload stored in this data. | ImagePixelData.h | |
ERGBFormat GetPixelLayout() |
Retrieve the pixel layout of this data | ImagePixelData.h | |
bool GetRawData
(
const void*& OutRawData, |
Get the data and its size only if it is well formed | ImagePixelData.h | |
int64 GetRawDataSizeInBytes() |
Get the size in bytes, regardless of if it is well formed. | ImagePixelData.h | |
FIntPoint GetSize() |
Retrieve the size of this data | ImagePixelData.h | |
bool GetSRGB() |
ImagePixelData.h | ||
EImagePixelType 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 | ImagePixelData.h | |
bool IsDataWellFormed() |
Check that this data is the size it should be | ImagePixelData.h | |
TUniquePtr< FImagePixelData > MoveImageDataToNew() |
Move this whole image buffer to a new allocation. | ImagePixelData.h | |
void SetAlphaOpaque() |
Change the alpha channel to opaque | ImagePixelData.h | |
void SetPayload
(
FImagePixelPayloadPtr NewPayload |
Sets the payload after construction. | ImagePixelData.h | |
void SetSRGB
(
bool InSRGB |
ImagePixelData.h |