Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Core > Misc > FFileHelper > FFileHelper::CreateBitmap

Light Theme

Dark Theme

FFileHelper::CreateBitmap

Saves a 24/32Bit BMP file to disk Saves a 24Bit BMP file to disk

Windows

MacOS

Linux

References

Module	Core
Header	/Engine/Source/Runtime/Core/Public/Misc/FileHelper.h
Include	#include "Misc/FileHelper.h"
Source	/Engine/Source/Runtime/Core/Private/Misc/FileHelper.cpp

Syntax

static bool CreateBitmap
(
    const TCHAR * Pattern,
    int32 DataWidth,
    int32 DataHeight,
    const struct FColor * Data,
    struct FIntRect * SubRectangle,
    IFileManager * FileManager,
    FString * OutFilename,
    bool bInWriteAlpha,
    EChannelMask ChannelMask
)

Remarks

Saves a 24/32Bit BMP file to disk

Saves a 24Bit BMP file to disk

Returns

true if success

Parameters

Parameter	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.
ChannelMask	optional, specifies a specific channel to write out (will be written out to all channels gray scale).
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
ChannelMask	optional, specifies a specific channel to write out (will be written out to all channels gray scale).

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss