SaveSprite()

Syntax

Result = SaveSprite(#Sprite, Filename$ [, ImagePlugin [, Flags]])

Saves the specified #Sprite to a file. By default, the saved image will be in 24bit BMP format. Very useful for screenshots when used with the GrabSprite() command. If the 'Result' is 0, the sprite hasn't be saved (disk full, bad filename, etc.). 'ImagePlugin' is an optional parameter and can be one of the following constant:

  #PB_ImagePlugin_BMP  : Save the image in BMP  (format by default)
  #PB_ImagePlugin_JPEG : Save the image in JPEG (the command UseJPEGImageEncoder() must be used)
  #PB_ImagePlugin_PNG  : Save the image in PNG  (the command UsePNGImageEncoder() must be used)

'Flags' is an optional parameter depending of the plugin used. For now, only the quality setting is supported: a number from 0 (worste quality) to 10 (maximum quality). Only the JPEG plugin currently support it (default quality is set to '7' if no flags are specified with the JPEG encoder).

Supported OS

Windows, Linux, MacOS X