FineMedia

class ffw::TgaSaver

Class List > ffw :: TgaSaver

Inherits the following classes: ffw::ImageWriter

Public Functions

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

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

function TgaSaver (2/3)

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

function TgaSaver (3/3)

ffw::TgaSaver::TgaSaver (
    TgaSaver && other
)

function swap

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

function operator= (1/2)

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

function operator= (2/2)

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

function ~TgaSaver

virtual ffw::TgaSaver::~TgaSaver ()

function writeRow

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

Implements ImageWriter::close

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