Duckcpp 2.1.0
Duckcpp is a high-performance c++ graphics engine.
Loading...
Searching...
No Matches
dcpp::video::IImageWriter Class Referenceabstract

Interface for writing software image data. More...

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

Inheritance diagram for dcpp::video::IImageWriter:
Inheritance graph
Collaboration diagram for dcpp::video::IImageWriter:
Collaboration graph

Public Member Functions

virtual bool isAWriteableFileExtension (const dcpp::io::path &filename) const =0
 Check if this writer can write a file with the given extension.
 
virtual bool writeImage (dcpp::io::IWriteFile *file, IImage *image, dcpp::uint32_kt param=0) const =0
 Write image to file.
 
- Public Member Functions inherited from dcpp::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.
 
dcpp::int32_kt getReferenceCount () const
 Get the reference count.
 
const dcpp::char_ktgetDebugName () const
 Returns the debug name of the object.
 

Additional Inherited Members

- Protected Member Functions inherited from dcpp::IReferenceCounted
void setDebugName (const dcpp::char_kt *newName)
 Sets the debug name of the object.
 

Detailed Description

Interface for writing software image data.

Member Function Documentation

◆ isAWriteableFileExtension()

virtual bool dcpp::video::IImageWriter::isAWriteableFileExtension ( const dcpp::io::path filename) const
pure virtual

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

Parameters
filenameName of the file to check.
Returns
True if file extension specifies a writable type.

◆ writeImage()

virtual bool dcpp::video::IImageWriter::writeImage ( dcpp::io::IWriteFile file,
IImage image,
dcpp::uint32_kt  param = 0 
) const
pure virtual

Write image to file.

Parameters
fileFile handle to write to.
imageImage to write into file.
paramWriter specific parameter, influencing e.g. quality.
Returns
True if image was successfully written.

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

Duckcpp    @cppfx.xyz