admin/CSFML
1
0 Fork 0
mirror of https://github.com/SFML/CSFML.git synced 2026-10-28 13:46:13 +01:00
Code Issues Packages Projects Releases Wiki Activity

Document QOI support for images

Browse Source
This commit is contained in:
Lukas Dürrenberger committed 2026-10-04 22:10:41 +02:00
1 parent e38e58c835
commit b4220b39ff
1 file changed
+8 -8
Download Patch File Download Diff File Expand all files Collapse all files
include/CSFML/Graphics/Image.h
+8 -8
View File
@@ -82,8 +82,8 @@ CSFML_GRAPHICS_API sfImage* sfImage_createFromPixels(sfVector2u size, const uint
/// \brief Create an image from a file on disk /// \brief Create an image from a file on disk
/// ///
/// The supported image formats are bmp, png, tga, jpg, gif, /// The supported image formats are bmp, png, tga, jpg, gif,
/// psd, hdr and pic. Some format options are not supported, /// psd, hdr, pic, pnm and qoi. Some format options are not supported,
/// like progressive jpeg. /// like jpeg with arithmetic coding or ASCII pnm.
/// If this function fails, the image is left unchanged. /// If this function fails, the image is left unchanged.
/// ///
/// \param filename Path of the image file to load /// \param filename Path of the image file to load
@@ -97,8 +97,8 @@ CSFML_GRAPHICS_API sfImage* sfImage_createFromFile(const char* filename);
/// \brief Create an image from a file in memory /// \brief Create an image from a file in memory
/// ///
/// The supported image formats are bmp, png, tga, jpg, gif, /// The supported image formats are bmp, png, tga, jpg, gif,
/// psd, hdr and pic. Some format options are not supported, /// psd, hdr, pic, pnm and qoi. Some format options are not supported,
/// like progressive jpeg. /// like jpeg with arithmetic coding or ASCII pnm.
/// If this function fails, the image is left unchanged. /// If this function fails, the image is left unchanged.
/// ///
/// \param data Pointer to the file data in memory /// \param data Pointer to the file data in memory
@@ -113,8 +113,8 @@ CSFML_GRAPHICS_API sfImage* sfImage_createFromMemory(const void* data, size_t si
/// \brief Create an image from a custom stream /// \brief Create an image from a custom stream
/// ///
/// The supported image formats are bmp, png, tga, jpg, gif, /// The supported image formats are bmp, png, tga, jpg, gif,
/// psd, hdr and pic. Some format options are not supported, /// psd, hdr, pic, pnm and qoi. Some format options are not supported,
/// like progressive jpeg. /// like jpeg with arithmetic coding or ASCII pnm.
/// If this function fails, the image is left unchanged. /// If this function fails, the image is left unchanged.
/// ///
/// \param stream Source stream to read from /// \param stream Source stream to read from
@@ -147,7 +147,7 @@ CSFML_GRAPHICS_API void sfImage_destroy(const sfImage* image);
/// ///
/// The format of the image is automatically deduced from /// The format of the image is automatically deduced from
/// the extension. The supported image formats are bmp, png, /// the extension. The supported image formats are bmp, png,
/// tga and jpg. The destination file is overwritten /// tga, jpg and qoi. The destination file is overwritten
/// if it already exists. This function fails if the image is empty. /// if it already exists. This function fails if the image is empty.
/// ///
/// \param image Image object /// \param image Image object
@@ -164,7 +164,7 @@ CSFML_GRAPHICS_API bool sfImage_saveToFile(const sfImage* image, const char* fil
/// \brief Save the image to a buffer in memory /// \brief Save the image to a buffer in memory
/// ///
/// The format of the image must be specified. /// The format of the image must be specified.
/// The supported image formats are bmp, png, tga and jpg. /// The supported image formats are bmp, png, tga, jpg and qoi.
/// This function fails if the image is empty, or if /// This function fails if the image is empty, or if
/// the format was invalid. /// the format was invalid.
/// ///