Skip to content
Member Filters
Show Inherited
Show Protected
Show abstract
GR32🞂TCustomBitmap32🞂SaveToFileMethodPublic

TCustomBitmap32.SaveToFile

Saves bitmap image data to a file on disk in BMP/DIB format.

Declarations ​

pascal
procedure SaveToFile(const FileName: string); overload; virtual;
procedure SaveToFile(const FileName: string; SaveTopDown: Boolean); overload; virtual;
procedure SaveToFile(const FileName: string; SaveTopDown: Boolean; InfoHeaderVersion: TInfoHeaderVersion); overload; virtual;
Overload Details

Overload 1 ​

pascal
procedure SaveToFile(const FileName: string); overload; virtual;

Saves bitmap to a file using default BMP header version.

ParameterTypeDescription
FileNamestringOutput file path.

Overload 2 ​

pascal
procedure SaveToFile(const FileName: string; SaveTopDown: Boolean); overload; virtual;

Saves bitmap to a file with specified scanline orientation.

ParameterTypeDescription
FileNamestringOutput file path.
SaveTopDownBooleanIf True, writes scanlines top-down.

Overload 3 ​

pascal
procedure SaveToFile(const FileName: string; SaveTopDown: Boolean; InfoHeaderVersion: TInfoHeaderVersion); overload; virtual;

Saves bitmap to a file specifying scanline orientation and BMP header version.

ParameterTypeDescription
FileNamestringOutput file path.
SaveTopDownBooleanIf True, writes scanlines top-down.
InfoHeaderVersionTInfoHeaderVersionBMP header format version.

Description ​

SaveToFile writes the bitmap surface contents to disk.

Example ​

pascal
Bitmap.SaveToFile('Output.bmp');