Navigation
API > API/Plugins > API/Plugins/MutableRuntime
2D image resource with mipmaps.
| Name | FImage |
| Type | class |
| Header File | /Engine/Plugins/Mutable/Source/MutableRuntime/Public/MuR/Image.h |
| Include Path | #include "MuR/Image.h" |
Syntax
class FImage : public mu::FResource
Inheritance Hierarchy
- FImageInfo → FImage
- FResource → FImage
- FImage
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FImage
(
uint32 SizeX, |
Constructor from the size and format. | MuR/Image.h | |
FImage () |
Life cycle. | MuR/Image.h |
Enums
Public
| Name | Remarks |
|---|---|
| EImageFlags | These set of flags are used to cache information for images at runtime. |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| DataStorage | FImageDataStorage | Pixel data for all lods. | MuR/Image.h | |
| Flags | uint8 | Persistent flags with some image properties. The meaning will depend of every context. | MuR/Image.h | |
| ReferenceID | uint32 | Only valid if the right flags are set, this identifies a referenced image. | MuR/Image.h | |
| RelevancyMaxY | uint16 | MuR/Image.h | ||
| RelevancyMinY | uint16 | Non-persistent relevancy map. | MuR/Image.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FIntVector2 CalculateMipSize
(
int32 LOD |
Calculate the size in pixels of a particular mipmap of this image. | MuR/Image.h | |
TSharedPtr< FImage > Clone() |
Deep clone. | MuR/Image.h | |
void Copy
(
const FImage* Other |
Copy another image. | MuR/Image.h | |
void CopyMove
(
FImage* Other |
MuR/Image.h | ||
EImageFormat GetFormat() |
Return the pixel format of the image. | MuR/Image.h | |
int32 GetLODCount () |
Return the number of levels of detail (mipmaps) in the texture. | MuR/Image.h | |
uint8 * GetLODData
(
int32 LODIndex |
MuR/Image.h | ||
const uint8 * GetLODData
(
int32 LODIndex |
Return a pointer to a instance-owned buffer where the image pixels are. | MuR/Image.h | |
int32 GetLODDataSize
(
int32 LODIndex |
Return the size in bytes of a specific LOD of the image. | MuR/Image.h | |
const uint8 * GetMipData
(
int32 Mip |
MuR/Image.h | ||
uint8 * GetMipData
(
int32 Mip |
Return a pointer to the beginning of the data for a particular mip. | MuR/Image.h | |
int32 GetMipsDataSize () |
Return the size of the resident mips. | MuR/Image.h | |
void GetNonBlackRect
(
FImageRect& OutRect |
Get the rect inside the image bounding the non-black content of the image. | MuR/Image.h | |
void GetNonBlackRect_Reference
(
FImageRect& OutRect |
MuR/Image.h | ||
uint32 GetReferencedTexture() |
Return the id of the engine referenced texture. Only valid if IsReference. | MuR/Image.h | |
const FImageSize & GetSize() |
MuR/Image.h | ||
uint16 GetSizeX() |
Return the width of the image. | MuR/Image.h | |
uint16 GetSizeY() |
Return the height of the image. | MuR/Image.h | |
void Init
(
uint32 SizeX, |
MuR/Image.h | ||
void InitToBlack() |
Clear the image to black colour. | MuR/Image.h | |
bool IsForceLoad() |
If true, this is a reference that must be resolved at compile time. | MuR/Image.h | |
bool IsFullAlpha() |
See if all the pixels in the alpha channel are the max value of the pixel format (white). | MuR/Image.h | |
bool IsPlainColour
(
FVector4f& Colour |
See if all the pixels in the image are equal and return the colour. | MuR/Image.h | |
bool IsReference() |
Return true if this is a reference to an engine image. | MuR/Image.h | |
void ReduceLODs
(
int32 LODsToSkip |
MuR/Image.h | ||
void ReduceLODsTo
(
int32 NewLODCount |
Reduce the LODs of the image to the given amount. | MuR/Image.h | |
FVector4f Sample
(
FVector2f Coords |
Sample the image and return an RGB colour. | MuR/Image.h | |
void Serialise
(
FOutputArchive& |
MuR/Image.h | ||
void Unserialise
(
FInputArchive& |
MuR/Image.h |
Overridden from FResource
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual int32 GetDataSize() |
Return the size in bytes of all the LODs of the image. | MuR/Image.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static int32 CalculateDataSize
(
int32 SizeX, |
Calculate the size of the image data in bytes, regardless of what is allocated in m_data, only using the image descriptions. | MuR/Image.h | |
static TSharedPtr< FImage > CreateAsReference
(
uint32 ID, |
Create a new empty image that repreents an external resource image. | MuR/Image.h | |
static int32 GetMipmapCount
(
int32 SizeX, |
Calculate the number of mipmaps for a particular image size. | MuR/Image.h | |
static void Serialise
(
const FImage*, |
Serialisation. | MuR/Image.h | |
static TSharedPtr< FImage > StaticUnserialise
(
FInputArchive& |
MuR/Image.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool operator==
(
const FImage& Other |
MuR/Image.h |