Defined in:Exports an image to a file.
virtual EngineResult ExportImageFile(const char *name, const Color4U *image, const Integer2D& size, uint32 flags = 0) = 0;
||The file name of the image, relative to the engine executable.|
||A pointer to a buffer in which the image is stored.|
||The dimensions of the image.|
||Flags pertaining to the export process.|
ExportImageFilefunction exports an image to the file specified by the
nameparamater. If the function succeeds, then the return value is
kEngineOkay. If an error occurred, then the result code corresponding to the error is returned. The
imageparameter specifies the buffer containing the image data, and the
sizeparameter specifies the horizontal and vertical dimensions of the image. Exactly 4wh bytes are read from the image buffer, where w and h are the width and height of the image. The image data must be stored in RGBA format with 8 bits per channel. The
flagsparameter specifies various options that control the export process, and it can be a combination (through logical OR) of the following constants.
||Include an alpha channel in the exported image.|
||Do not compress the exported image, if possible.|
||The image data to be exported is stored in BGRA order.|
ExportImageFilefunction must be overridden by subclasses of the