Navigation
API > API/Runtime > API/Runtime/Core > API/Runtime/Core/Misc > API/Runtime/Core/Misc/FFileHelper > API/Runtime/Core/Misc/FFileHelper/CreateBitmap
References
| Module | Core |
| Header | /Engine/Source/Runtime/Core/Public/Misc/FileHelper.h |
| Include | #include "Misc/FileHelper.h" |
static bool CreateBitmap
&40;
const TCHAR &42; Pattern,
int32 DataWidth,
int32 DataHeight,
const struct FColor &42; Data,
FIntRect &42; SubRectangle,
IFileManager &42; FileManager,
FString &42; OutFilename,
bool bInWriteAlpha,
EColorChannel ColorChannel
&41;
Remarks
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 true if success
Parameters
| Name | Description |
|---|---|
| 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). |