arsa  2.7
Public Member Functions | List of all members
irr::video::IImageWriter Class Referenceabstract

Interface for writing software image data. More...

#include <IImageWriter.h>

Inheritance diagram for irr::video::IImageWriter:
irr::IReferenceCounted

Public Member Functions

virtual bool isAWriteableFileExtension (const io::path &filename) const =0
 Check if this writer can write a file with the given extension. More...
 
virtual bool writeImage (io::IWriteFile *file, IImage *image, u32 param=0) const =0
 Write image to file. More...
 
- Public Member Functions inherited from irr::IReferenceCounted
 IReferenceCounted ()
 Constructor. More...
 
virtual ~IReferenceCounted ()
 Destructor. More...
 
void grab () const
 Grabs the object. Increments the reference counter by one. More...
 
bool drop () const
 Drops the object. Decrements the reference counter by one. More...
 
s32 getReferenceCount () const
 Get the reference count. More...
 
const c8getDebugName () const
 Returns the debug name of the object. More...
 

Additional Inherited Members

- Protected Member Functions inherited from irr::IReferenceCounted
void setDebugName (const c8 *newName)
 Sets the debug name of the object. More...
 

Detailed Description

Interface for writing software image data.

Definition at line 25 of file IImageWriter.h.

Member Function Documentation

◆ isAWriteableFileExtension()

virtual bool irr::video::IImageWriter::isAWriteableFileExtension ( const io::path 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 irr::video::IImageWriter::writeImage ( io::IWriteFile file,
IImage image,
u32  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: