nirt::video::IImageWriter Class Reference

Interface for writing software image data. More...

#include <nirtcpp/core/engine/IImageWriter.hpp>

Inheritance diagram for nirt::video::IImageWriter:

Collaboration diagram for nirt::video::IImageWriter:

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

Additional Inherited Members
Protected Member Functions inherited from nirt::IReferenceCounted
void	setDebugName (const c8 *newName)
	Sets the debug name of the object.

Detailed Description

Interface for writing software image data.

Member Function Documentation

isAWriteableFileExtension()

virtual bool nirt::video::IImageWriter::isAWriteableFileExtension ( const io::path &  filename ) const

pure virtual

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

Parameters

filename

Name of the file to check.

Returns

True if file extension specifies a writable type.

writeImage()

virtual bool nirt::video::IImageWriter::writeImage ( io::IWriteFile *  file, IImage *  image, u32  param = 0  ) const

pure virtual

Write image to file.

Parameters

file	File handle to write to.
image	Image to write into file.
param	Writer specific parameter, influencing e.g. quality.

Returns

True if image was successfully written.

---

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

• include/nirtcpp/core/engine/IImageWriter.hpp