Update doc for imlib_load_image_fd()

This commit is contained in:
Kim Woelders 2021-12-06 07:04:06 +01:00
parent 273a7aaac3
commit 1216f11686
2 changed files with 18 additions and 4 deletions

View File

@ -1069,6 +1069,17 @@ an image handle on success or NULL on failure.</blockquote>
it returns a valid image handle, if not NULL is returned and the error_return
pointed to is set to the detail of the error.</blockquote>
<b><tt><font color="#660000"><font size=+2>Imlib_Image imlib_load_image_fd(int fd, const char *file);</font></font></tt></b>
<blockquote>Reads image from file descriptor.
The image is loaded without deferred image data decoding (i.e. it is
decoded straight away) and without looking in the cache.
The file name is only used to guess the file format.
fd must be mmap&apos;able (so it cannot be a pipe).
fd will be closed after calling this function.
Returns an image handle on success or NULL on failure.
</blockquote>
<b><tt><font color="#660000"><font size=+2>void imlib_free_image(void);</font></font></tt></b>
<blockquote>This frees the image that is set as the current image in Imlib2's

View File

@ -1389,10 +1389,13 @@ imlib_load_image_immediately_without_cache(const char *file)
* @param file Image file.
* @return An image handle.
*
* Loads the image without deferred image data decoding (i.e. it is
* decoded straight away) and without looking in the cache. Returns an
* image handle on success or NULL on failure.
* fd will be closed after calling this function.
* Reaasd image from file descriptor.
* The file name @file is only used to guess the file format.
* The image is loaded without deferred image data decoding (i.e. it is
* decoded straight away) and without looking in the cache.
* @fd must be mmap'able (so it cannot be a pipe).
* @fd will be closed after calling this function.
* Returns an image handle on success or NULL on failure.
*/
EAPI Imlib_Image
imlib_load_image_fd(int fd, const char *file)