Navigation
API > API/Runtime > API/Runtime/Core > API/Runtime/Core/FFileHelper
Overloads
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static bool CreateBitmap
(
const TCHAR* Pattern, |
Saves a 24/32Bit BMP file to disk for debug image dump purposes | Misc/FileHelper.h | |
static PRAGMA_DISABLE_DEPRECATION_WARNINGS bool CreateBitmap
(
const TCHAR* Pattern, |
Misc/FileHelper.h |
CreateBitmap(const TCHAR , int32, int32, const struct FColor , FIntRect , IFileManager , FString *, bool, EColorChannel)
Description
Saves a 24/32Bit BMP file to disk for debug image dump purposes
for general image saving (to BMP or any other format); use FImageUtils::SaveImage instead CreateBitmap is mainly for debug dump images
note this also calls SendDataToPCViaUnrealConsole and uses GenerateNextBitmapFilename if Pattern does not have ".bmp" on it
| Name | CreateBitmap |
| Type | function |
| Header File | /Engine/Source/Runtime/Core/Public/Misc/FileHelper.h |
| Include Path | #include "Misc/FileHelper.h" |
static bool CreateBitmap
(
const TCHAR * Pattern,
int32 DataWidth,
int32 DataHeight,
const struct FColor * Data,
FIntRect * SubRectangle,
IFileManager * FileManager,
FString * OutFilename,
bool bInWriteAlpha,
EColorChannel ColorChannel
)
true if success
Parameters
| Name | Remarks |
|---|---|
| Pattern | filename with path, must not be 0, if with "bmp" extension (e.g. "out.bmp") the filename stays like this, if without (e.g. "out") automatic index numbers are addended (e.g. "out00002.bmp") |
| DataWidth | Width of the bitmap supplied in Data >0 |
| DataHeight | Height of the bitmap supplied in Data >0 |
| Data | must not be 0 |
| SubRectangle | optional, specifies a sub-rectangle of the source image to save out. If NULL, the whole bitmap is saved |
| FileManager | must not be 0 |
| OutFilename | optional, if specified filename will be output |
| bInWriteAlpha | optional, specifies whether to write out the alpha channel. Will force BMP V4 format. |
| ColorChannel | optional, specifies a specific channel to write out (will be written out to all channels gray scale). |
CreateBitmap(const TCHAR , int32, int32, const struct FColor , FIntRect , IFileManager , FString *, bool, EChannelMask)
| Name | CreateBitmap |
| Type | function |
| Header File | /Engine/Source/Runtime/Core/Public/Misc/FileHelper.h |
| Include Path | #include "Misc/FileHelper.h" |
static PRAGMA_DISABLE_DEPRECATION_WARNINGS bool CreateBitmap
(
const TCHAR * Pattern,
int32 DataWidth,
int32 DataHeight,
const struct FColor * Data,
FIntRect * SubRectangle,
IFileManager * FileManager,
FString * OutFilename,
bool bInWriteAlpha,
EChannelMask ChannelMask
)