Saga3D API Documentation  1.0-RC4
saga::video::IImageWriter Class Referenceabstract

Interface for writing software image data. More...

#include <IImageWriter.h>

Public Member Functions

virtual bool isAWriteableFileExtension (const std::string &filename) const =0
 Check if this writer can write a file with the given extension. More...
 
virtual bool writeImage (io::IWriteFile *file, IImage *image, std::uint32_t param=0) const =0
 Write image to file. More...
 

Detailed Description

Interface for writing software image data.

Definition at line 25 of file IImageWriter.h.

Member Function Documentation

◆ isAWriteableFileExtension()

virtual bool saga::video::IImageWriter::isAWriteableFileExtension ( const std::string &  filename) const
pure virtual

Check if this writer can write a file with the given extension.

Parameters
filenameName of the file to check.
Returns
True if file extension specifies a writable type.

◆ writeImage()

virtual bool saga::video::IImageWriter::writeImage ( io::IWriteFile *  file,
IImage *  image,
std::uint32_t  param = 0 
) const
pure virtual

Write image to file.

Parameters
fileFile handle to write to.
imageImage to write into file.
paramWriter specific parameter, influencing e.g. quality.
Returns
True if image was successfully written.

The documentation for this class was generated from the following file: