Navigation
API > API/Runtime > API/Runtime/ImageWrapper
Inheritance Hierarchy
- IImageWrapper
- FHdrImageWrapper
References
| Module | ImageWrapper |
| Header | /Engine/Source/Runtime/ImageWrapper/Public/IImageWrapper.h |
| Include | #include "IImageWrapper.h" |
Syntax
class IImageWrapper
Remarks
Interface for image wrappers.
to Encode: SetRaw() then GetCompressed() to Decode : SetCompressed() then GetRaw()
in general, direct use of the IImageWrapper interface is now discouraged use ImageWrapperModule CompressImage/DecompressImage instead.
Variables
| Type | Name | Description | |
|---|---|---|---|
 |
const TCHAR * | DebugImageName | Debug image name string for any errors or warnings |
Destructors
| Type | Name | Description | |
|---|---|---|---|
  |
Virtual destructor. |
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
bool | CanSetRawFormat
(
const ERGBFormat InFormat, |
CanSetRawFormat returns true if SetRaw will accept this format |
  |
void | ConvertRawImageFormat
(
ERawImageFormat::Type RawFormat, |
External users call these from ImageWrapperModule.h , see documentation there |
  |
ERawImageFormat::Type | ConvertRGBFormat
(
ERGBFormat RGBFormat, |
|
  |
int32 | GetBitDepth () |
Gets the bit depth of the image. |
  |
ERawImageFormat::Type | GetClosestRawImageFormat
(
bool* bIsExactMatch |
Get the current image format, mapped to an ERawImageFormat if ! *bIsExactMatch , conversion is needed can call after SetCompressed() |
 |
TArray64< uint8 > | GetCompressed
(
int32 Quality |
Gets the compressed data. |
  |
ERGBFormat | GetFormat () |
Gets the format of the image. |
  |
int64 | GetHeight () |
Gets the height of the image. |
 |
bool | GetRaw
(
const ERGBFormat InFormat, |
Gets the raw data. |
 |
bool | GetRaw
(
TArray64< uint8 >& OutRawData |
GetRaw after SetCompressed fills the raw data in the native format/depth contained in the file Do not use the GetRaw() variants that take format/depth arguments. |
 |
bool | GetRaw
(
const ERGBFormat InFormat, |
Get the raw version of the image and write to the array view (Note: It may consume the data set in the SetRaw function if it was set before) |
 |
bool | Gets the raw data in a TArray. | |
 |
bool | GetRawImage
(
FImage& OutImage |
Decode the image file data from SetCompressed() into an FImage OutImage is allocated and attributes are filled any previous passed-in contents of OutImage are destroyed OutImage.Format is ignored, a new format is set from the loaded image |
  |
int64 | GetRGBFormatBytesPerPel
(
ERGBFormat RGBFormat, |
|
  |
bool | GetSRGB () |
Should the pixels be treated as sRGB encoded? (or Linear) |
  |
ERawImageFormat::Type | GetSupportedRawFormat
(
const ERawImageFormat::Type InFormat |
Returns InFormat if supported, else maps to something supported the returned format will pass CanSetRawFormat() |
  |
int64 | GetWidth () |
Gets the width of the image. |
 |
bool | SetCompressed
(
const void* InCompressedData, |
Sets the compressed data. |
 |
void | SetDebugImageName
(
const TCHAR* InDebugImageName |
Set the debug image name |
 |
bool | SetRaw
(
const void* InRawData, |
Sets the raw image data. |