class ffw::DdsSaver
Class List > ffw :: DdsSaver
Inherits the following classes: ffw::ImageWriter
Public Functions
Type | Name |
---|---|
DdsSaver (const std::string & path, int width, int height, ffw::ImageType type, int quality = 100, int mips = 1) | |
DdsSaver (const DdsSaver & other) = delete | |
DdsSaver (DdsSaver && other) | |
void | swap (DdsSaver & other) |
DdsSaver & | operator= (const DdsSaver & other) = delete |
DdsSaver & | operator= (DdsSaver && other) |
virtual | ~DdsSaver () |
virtual size_t | writeRow (const void * src) override Writes a row of pixels. |
virtual bool | writeFooter () override Writes the footer. |
virtual void | close () override |
virtual bool | setMipMap (int level) override |
Public Functions Documentation
function DdsSaver (1/3)
ffw::DdsSaver::DdsSaver (
const std::string & path,
int width,
int height,
ffw::ImageType type,
int quality = 100,
int mips = 1
)
function DdsSaver (2/3)
ffw::DdsSaver::DdsSaver (
const DdsSaver & other
) = delete
function DdsSaver (3/3)
ffw::DdsSaver::DdsSaver (
DdsSaver && other
)
function swap
void ffw::DdsSaver::swap (
DdsSaver & other
)
function operator= (1/2)
DdsSaver & ffw::DdsSaver::operator= (
const DdsSaver & other
) = delete
function operator= (2/2)
DdsSaver & ffw::DdsSaver::operator= (
DdsSaver && other
)
function ~DdsSaver
virtual ffw::DdsSaver::~DdsSaver ()
function writeRow
virtual size_t ffw::DdsSaver::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::DdsSaver::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::DdsSaver::close ()
Implements ImageWriter::close
function setMipMap
virtual bool ffw::DdsSaver::setMipMap (
int level
)
Implements ImageWriter::setMipMap
The documentation for this class was generated from the following file: include/ffw/media/ddssaver.h