UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FSharedImage Struct Reference

#include <ImageCore.h>

+ Inheritance diagram for FSharedImage:

Public Member Functions

 FSharedImage ()=default
 
virtual ~FSharedImage ()=default
 
- Public Member Functions inherited from FImage
 FImage ()
 
 FImage (const FImage &CopyFrom)=default
 
FImageoperator= (const FImage &CopyFrom)=default
 
 FImage (FImage &&MoveFrom)
 
FImageoperator= (FImage &&MoveFrom)
 
IMAGECORE_API FImage (int32 InSizeX, int32 InSizeY, int32 InNumSlices, ERawImageFormat::Type InFormat, EGammaSpace InGammaSpace)
 
 FImage (int32 InSizeX, int32 InSizeY, int32 InNumSlices, ERawImageFormat::Type InFormat)
 
 FImage (int32 InSizeX, int32 InSizeY, ERawImageFormat::Type InFormat, EGammaSpace InGammaSpace)
 
 FImage (int32 InSizeX, int32 InSizeY, ERawImageFormat::Type InFormat)
 
IMAGECORE_API void FreeData (bool bAsyncDetached)
 
void Swap (FImage &Other)
 
void Reset ()
 
 operator FImageView () const
 
IMAGECORE_API FImageView GetSlice (int32 SliceIndex) const
 
IMAGECORE_API void CopyTo (FImage &DestImage, ERawImageFormat::Type DestFormat, EGammaSpace DestGammaSpace) const
 
void CopyTo (FImage &DestImage) const
 
IMAGECORE_API void ChangeFormat (ERawImageFormat::Type DestFormat, EGammaSpace DestGammaSpace)
 
IMAGECORE_API void ResizeTo (FImage &DestImage, int32 DestSizeX, int32 DestSizeY, ERawImageFormat::Type DestFormat, EGammaSpace DestGammaSpace) const
 
IMAGECORE_API void Linearize (uint8 SourceEncoding, FImage &DestImage) const
 
void Linearize (FImage &DestImage) const
 
IMAGECORE_API void TransformToWorkingColorSpace (const FVector2d &SourceRedChromaticity, const FVector2d &SourceGreenChromaticity, const FVector2d &SourceBlueChromaticity, const FVector2d &SourceWhiteChromaticity, UE::Color::EChromaticAdaptationMethod Method, double EqualityTolerance=1.e-7)
 
IMAGECORE_API void Init (int32 InSizeX, int32 InSizeY, int32 InNumSlices, ERawImageFormat::Type InFormat, EGammaSpace InGammaSpace)
 
void Init (int32 InSizeX, int32 InSizeY, int32 InNumSlices, ERawImageFormat::Type InFormat)
 
IMAGECORE_API void Init (int32 InSizeX, int32 InSizeY, ERawImageFormat::Type InFormat, EGammaSpace InGammaSpace)
 
void Init (int32 InSizeX, int32 InSizeY, ERawImageFormat::Type InFormat)
 
IMAGECORE_API void Init (const FImageInfo &Info)
 
voidGetPixelPointer (int32 X, int32 Y, int32 Slice=0) const
 
const FLinearColor GetOnePixelLinear (int32 X, int32 Y, int32 Slice=0) const
 
TArrayView64< uint8AsG8 ()
 
TArrayView64< uint16AsG16 ()
 
TArrayView64< FColorAsBGRA8 ()
 
TArrayView64< FColorAsBGRE8 ()
 
TArrayView64< uint16AsRGBA16 ()
 
TArrayView64< FFloat16ColorAsRGBA16F ()
 
TArrayView64< FLinearColorAsRGBA32F ()
 
TArrayView64< FFloat16AsR16F ()
 
TArrayView64< floatAsR32F ()
 
TArrayView64< const uint8AsG8 () const
 
TArrayView64< const uint16AsG16 () const
 
TArrayView64< const FColorAsBGRA8 () const
 
TArrayView64< const FColorAsBGRE8 () const
 
TArrayView64< const uint16AsRGBA16 () const
 
TArrayView64< const FFloat16ColorAsRGBA16F () const
 
TArrayView64< const FLinearColorAsRGBA32F () const
 
TArrayView64< const FFloat16AsR16F () const
 
TArrayView64< const floatAsR32F () const
 
- Public Member Functions inherited from FImageInfo
 FImageInfo ()
 
 FImageInfo (int32 InSizeX, int32 InSizeY, int32 InNumSlices, ERawImageFormat::Type InFormat, EGammaSpace InGammaSpace)
 
bool operator== (const FImageInfo &rhs) const
 
bool IsImageInfoValid () const
 
bool IsGammaCorrected () const
 
int64 GetBytesPerPixel () const
 
int64 GetNumPixels () const
 
int64 GetImageSizeBytes () const
 
int64 GetSliceNumPixels () const
 
int64 GetSliceSizeBytes () const
 
int64 GetWidth () const
 
int64 GetHeight () const
 
int64 GetStrideBytes () const
 
EGammaSpace GetGammaSpace () const
 
int64 GetPixelOffsetBytes (int32 X, int32 Y, int32 Slice=0) const
 
IMAGECORE_API void ImageInfoToCompactBinary (class FCbObject &OutObject) const
 
IMAGECORE_API bool ImageInfoFromCompactBinary (const FCbObject &InObject)
 
- Public Member Functions inherited from FThreadSafeRefCountedObject
 FThreadSafeRefCountedObject ()=default
 
 FThreadSafeRefCountedObject (const FThreadSafeRefCountedObject &Rhs)=delete
 
FThreadSafeRefCountedObjectoperator= (const FThreadSafeRefCountedObject &Rhs)=delete
 
virtual ~FThreadSafeRefCountedObject ()
 
FReturnedRefCountValue AddRef () const
 
uint32 Release () const
 
uint32 GetRefCount () const
 

Additional Inherited Members

- Public Attributes inherited from FImage
TArray64< uint8RawData
 
- Public Attributes inherited from FImageInfo
int32 SizeX = 0
 
int32 SizeY = 0
 
int32 NumSlices = 0
 
ERawImageFormat::Type Format = ERawImageFormat::BGRA8
 
EGammaSpace GammaSpace = EGammaSpace::sRGB
 

Constructor & Destructor Documentation

◆ FSharedImage()

FSharedImage::FSharedImage ( )
default

◆ ~FSharedImage()

virtual FSharedImage::~FSharedImage ( )
virtualdefault

The documentation for this struct was generated from the following file: