d2/d70/_bmp_file_format_8h_source.htm

#pragma once


#include <Texture/Image/Formats/ImageFileFormat.h>


class PL_TEXTURE_DLL plBmpFileFormat : public plImageFileFormat

{

public:

  virtual plResult ReadImageHeader(plStreamReader& inout_stream, plImageHeader& ref_header, plStringView sFileExtension) const override;


  virtual plResult ReadImage(plStreamReader& inout_stream, plImage& ref_image, plStringView sFileExtension) const override;

  virtual plResult WriteImage(plStreamWriter& inout_stream, const plImageView& image, plStringView sFileExtension) const override;


  virtual bool CanReadFileType(plStringView sExtension) const override;

  virtual bool CanWriteFileType(plStringView sExtension) const override;

};


plBmpFileFormat
Definition BmpFileFormat.h:6

plImageFileFormat
Definition ImageFileFormat.h:17

plImageFileFormat::CanWriteFileType
virtual bool CanWriteFileType(plStringView sExtension) const =0
Should return true, if files with the given extension can be written.

plImageFileFormat::CanReadFileType
virtual bool CanReadFileType(plStringView sExtension) const =0
Should return true, if files with the given extension can be read.

plImageFileFormat::WriteImage
virtual plResult WriteImage(plStreamWriter &inout_stream, const plImageView &image, plStringView sFileExtension) const =0
Writes the data to the given stream in this format. Errors are written to the given plLogInterface.

plImageFileFormat::ReadImageHeader
virtual plResult ReadImageHeader(plStreamReader &inout_stream, plImageHeader &ref_header, plStringView sFileExtension) const =0
Reads only the header information for an image and ignores the data. Much faster than reading the ent...

plImageFileFormat::ReadImage
virtual plResult ReadImage(plStreamReader &inout_stream, plImage &ref_image, plStringView sFileExtension) const =0
Reads the data from the given stream and creates the image from it. Errors are written to the given p...

plImageHeader
A class containing image meta data, such as format and dimensions.
Definition ImageHeader.h:15

plImage
A class containing image data and associated meta data.
Definition Image.h:103

plImageView
A class referencing image data and holding metadata about the image.
Definition Image.h:13

plStreamReader
Interface for binary in (read) streams.
Definition Stream.h:22

plStreamWriter
Interface for binary out (write) streams.
Definition Stream.h:107

plStringView
plStringView represent a read-only sub-string of a larger string, as it can store a dedicated string ...
Definition StringView.h:34

plResult
Default enum for returning failure or success, instead of using a bool.
Definition Types.h:54