FineMedia

class ffw::PbmSaver

Class List > ffw :: PbmSaver

Inherits the following classes: ffw::ImageWriter

Public Functions

Type Name
PbmSaver (const std::string & path, int width, int height, ffw::ImageType type, int quality = 100, int mips = 1)
PbmSaver (const PbmSaver & other) = delete
PbmSaver (PbmSaver && other)
void swap (PbmSaver & other)
PbmSaver & operator= (const PbmSaver & other) = delete
PbmSaver & operator= (PbmSaver && other)
virtual ~PbmSaver ()
virtual size_t writeRow (const void * src) override
Writes a row of pixels.
virtual bool writeFooter () override
Writes the footer.
virtual void close () override

Public Functions Documentation

function PbmSaver (1/3)

ffw::PbmSaver::PbmSaver (
    const std::string & path,
    int width,
    int height,
    ffw::ImageType type,
    int quality = 100,
    int mips = 1
)

function PbmSaver (2/3)

ffw::PbmSaver::PbmSaver (
    const PbmSaver & other
) = delete

function PbmSaver (3/3)

ffw::PbmSaver::PbmSaver (
    PbmSaver && other
)

function swap

void ffw::PbmSaver::swap (
    PbmSaver & other
)

function operator= (1/2)

PbmSaver & ffw::PbmSaver::operator= (
    const PbmSaver & other
) = delete

function operator= (2/2)

PbmSaver & ffw::PbmSaver::operator= (
    PbmSaver && other
)

function ~PbmSaver

virtual ffw::PbmSaver::~PbmSaver ()

function writeRow

virtual size_t ffw::PbmSaver::writeRow (
    const void * src
)

Writes a row of pixels.

Parameters:

  • src Where to read pixels from

The src must contain an entire row of pixels. Use writer->getStrideSize() to determine the size of the row needed in number of bytes.

Implements ImageWriter::writeRow

function writeFooter

virtual bool ffw::PbmSaver::writeFooter ()

Writes the footer.

Note:

This is needed to be called at the end of writing all pixels. Not doing so could lead to invalid image file.

Implements ImageWriter::writeFooter

function close

virtual void ffw::PbmSaver::close ()

Implements ImageWriter::close

The documentation for this class was generated from the following file: include/ffw/media/pbmsaver.h