IImageWrapperModule.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreTypes.h"
#include "Modules/ModuleInterface.h"
#include "Templates/SharedPointer.h"
#include "ImageCore.h"
#include "IImageWrapper.h"
#include "ImageWrapperOutputTypes.h"
 
 
 
 
class IImageWrapperModule
    : public IModuleInterface
{
public:
 
 
    virtual bool CompressImage(TArray64<uint8> & OutData, EImageFormat ToFormat, const FImageView & InImage, int32 Quality = 0) = 0;
    
    /* Read an image from file format encoded data.
     * ImageWrapper calls this a "decompress"
     * OutImage is allocated and filled, any existing contents are discarded
     * 
     * @param InCompressedData  Image format encoded bytes to read; format is automatically deduced from the content
     * @param InCompressedSize  Size of InCompressedData in bytes
     * @param OutImage          Filled with Image that is read.  Allocated.
     */
    virtual bool DecompressImage(const void* InCompressedData, int64 InCompressedSize, FImage & OutImage) = 0;
 
    /* Read an image from file format encoded data.
     * ImageWrapper calls this a "decompress"
     * OutImage is allocated and filled, any existing contents are discarded
     *
     * @param InCompressedData                  Image format encoded bytes to read; format is automatically deduced from the content
     * @param InCompressedSize                  Size of InCompressedData in bytes
     * @param OutDecompressedImageData          Filled with Image along with other meta data and mip images that is read.  Allocated.
     */
    virtual bool DecompressImage(const void* InCompressedData, int64 InCompressedSize, FDecompressedImageOutput& OutDecompressedImage) = 0;
 
    virtual TSharedPtr<IImageWrapper> CreateImageWrapper(const EImageFormat InFormat, const TCHAR* InOptionalDebugImageName = nullptr) = 0;
 
    virtual EImageFormat DetectImageFormat(const void* InCompressedData, int64 InCompressedSize) = 0;
 
    /* Name can be a full name like "xx.png" or just the extension part, like "png"
     * returns EImageFormat::Invalid if no supported image extension found
     */
    virtual EImageFormat GetImageFormatFromExtension(const TCHAR * Name) = 0;
 
    /* returns extension, not including the "." , 3 or 4 chars */
    virtual const TCHAR * GetExtension(EImageFormat Format) = 0;
 
    /* get a good default output image format for a pixel format */
    virtual EImageFormat GetDefaultOutputFormat(ERawImageFormat::Type RawFormat) = 0;
 
    /* Convert an ImageWrapper style {ERGBFormat+BitDepth} into an ERawImageFormat for FImage
    * returns ERawImageFormat::Invalid if no mapping is possible
    * bIsExactMatch is filled with whether the formats are an exact match or not
    *   if not, conversion is needed
    */
    virtual ERawImageFormat::Type ConvertRGBFormat(ERGBFormat Format,int BitDepth,bool * bIsExactMatch = nullptr) = 0;
    
    virtual void ConvertRawImageFormat(ERawImageFormat::Type RawFormat, ERGBFormat & OutFormat,int & OutBitDepth) = 0;
 
public:
 
    virtual ~IImageWrapperModule() { }
};