FineMedia

class ffw::BmpSaver

Class List > ffw :: BmpSaver

Inherits the following classes: ffw::ImageWriter

Public Functions

Type Name
BmpSaver (const std::string & path, int width, int height, ffw::ImageType type, int quality = 100, int mips = 1)
BmpSaver (const BmpSaver & other) = delete
BmpSaver (BmpSaver && other)
void swap (BmpSaver & other)
BmpSaver & operator= (const BmpSaver & other) = delete
BmpSaver & operator= (BmpSaver && other)
virtual ~BmpSaver ()
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 BmpSaver (1/3)

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

function BmpSaver (2/3)

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

function BmpSaver (3/3)

ffw::BmpSaver::BmpSaver (
    BmpSaver && other
)

function swap

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

function operator= (1/2)

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

function operator= (2/2)

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

function ~BmpSaver

virtual ffw::BmpSaver::~BmpSaver ()

function writeRow

virtual size_t ffw::BmpSaver::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::BmpSaver::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::BmpSaver::close ()

Implements ImageWriter::close

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