FImageOperator

This struct contains image operations that may need to allocate and free temporary images to work.

API > API/Plugins > API/Plugins/MutableRuntime

This struct contains image operations that may need to allocate and free temporary images to work. It's purpose is to override the creation, release and clone functions depending on the context.

   
Name FImageOperator
Type struct
Header File /Engine/Plugins/Mutable/Source/MutableRuntime/Public/MuR/Image.h
Include Path #include "MuR/Image.h"

Syntax

struct FImageOperator

Constructors

Name Remarks Include Path Unreal Specifiers

FImageOperator ( FImageCreateFunc Create,
FImageReleaseFunc Release,
FImageCloneFunc Clone,
FImagePixelFormatFunc FormatOverride
)

   MuR/Image.h  

Structs

Name Remarks
FScratchImageMipmap Support struct to keep preallocated data required for some mipmap operations.

Typedefs

Name Type Remarks Include Path
FImageCloneFunc TFunction< TSharedPtr< FImage >(const FImage *)>   MuR/Image.h
FImageCreateFunc TFunction< TSharedPtr< FImage >(int32, int32, int32, EImageFormat, EInitializationType)> Common callback used for functions that can create temporary images. MuR/Image.h
FImagePixelFormatFunc TFunction< void(bool &, int32, FImage *, const FImage *, int32)> Interface to override the internal mutable image pixel format conversion functions. MuR/Image.h
FImageReleaseFunc TFunction< void(TSharedPtr< FImage > &)>   MuR/Image.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
CloneImage FImageCloneFunc   MuR/Image.h  
CreateImage FImageCreateFunc   MuR/Image.h  
FormatImageOverride FImagePixelFormatFunc   MuR/Image.h  
ReleaseImage FImageReleaseFunc   MuR/Image.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

TSharedPtr< FImage > ExtractMip ( const FImage* From,
int32 Mip
)

   MuR/Image.h  

void FillColor ( FImage* Image,
FVector4f Color
)

 Fill the image with a plain colour. MuR/Image.h  

void ImageCompose ( FImage* Base,
const FImage* Block,
const box< FIntVector2 >& Rect
)

   MuR/Image.h  

bool ImageCrop ( TSharedPtr< FImage >& OutCropped,
int32 CompressionQuality,
const FImage* Base,
const box< FIntVector2 >& Rect
)

   MuR/Image.h  

void ImageMipmap ( int32 CompressionQuality,
FImage* Dest,
const FImage* Base,
int32 StartLevel,
int32 LevelCount,
const FMipmapGenerationSettings&,
bool bGenerateOnlyTail
)

 Generate the mipmaps for images. MuR/Image.h  

void ImageMipmap ( FImageOperator::FScratchImageMipmap&,
int32 CompressionQuality,
FImage* Dest,
const FImage* Base,
int32 LevelStart,
int32 LevelCount,
const FMipmapGenerationSettings&,
bool bGenerateOnlyTail
)

   MuR/Image.h  

void ImageMipmap_PrepareScratch ( const FImage* DestImage,
int32 StartLevel,
int32 LevelCount,
FScratchImageMipmap&
)

 Mipmap separating the worst case treatment in 3 steps to manage allocations of temp data. MuR/Image.h  

void ImageMipmap_ReleaseScratch ( FScratchImageMipmap&
)

   MuR/Image.h  

TSharedPtr< FImage > ImagePixelFormat ( int32 Quality,
const FImage* Base,
EImageFormat TargetFormat,
int32 OnlyLOD
)

 Convert an image to another pixel format. MuR/Image.h  

void ImagePixelFormat ( bool& bOutSuccess,
int32 Quality,
FImage* Result,
const FImage* Base,
int32 OnlyLOD
)

 Convert an image to another pixel format. Not all format conversions are implemented. MuR/Image.h  

void ImagePixelFormat ( bool& bOutSuccess,
int32 Quality,
FImage* Result,
const FImage* Base,
int32 BeginResultLOD,
int32 BeginBaseLOD,
int32 NumLODs
)

   MuR/Image.h  

void ImageResizeLinear ( FImage* Dest,
int32 ImageCompressionQuality,
const FImage* Base
)

 Bilinear filter image resize. MuR/Image.h  

TSharedPtr< FImage > ImageSwizzle ( EImageFormat Format,
const TSharedPtr< const FImage > Sources,
const uint8 Channels
)

   MuR/Image.h  

Static

Name Remarks Include Path Unreal Specifiers

static FImageOperator GetDefault ( const FImagePixelFormatFunc& InFormatOverride
)

 Create an default version for untracked resources. MuR/Image.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page