procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

create-image: Expand documentation (bug#33990)

Browse source 
* lisp/image.el (create-image): Discuss default for :scale in the doc
string.
This commit is contained in:
Benjamin Riefenstahl 2019-01-15 17:00:04 +01:00 • committed by Eli Zaretskii
parent 928d342c81
commit b6c762a520
1 changed files with 8 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
lisp/image.el
View file

@ -413,13 +413,20 @@ must be available."
(defun create-image (file-or-data &optional type data-p &rest props) (defun create-image (file-or-data &optional type data-p &rest props)
"Create an image. "Create an image.
FILE-OR-DATA is an image file name or image data. FILE-OR-DATA is an image file name or image data.
Optional TYPE is a symbol describing the image type. If TYPE is omitted Optional TYPE is a symbol describing the image type. If TYPE is omitted
or nil, try to determine the image type from its first few bytes or nil, try to determine the image type from its first few bytes
of image data. If that doesn't work, and FILE-OR-DATA is a file name, of image data. If that doesn't work, and FILE-OR-DATA is a file name,
use its file extension as image type. use its file extension as image type.
Optional DATA-P non-nil means FILE-OR-DATA is a string containing image data. Optional DATA-P non-nil means FILE-OR-DATA is a string containing image data.
Optional PROPS are additional image attributes to assign to the image, Optional PROPS are additional image attributes to assign to the image,
like, e.g. `:mask MASK'. like, e.g. `:mask MASK'. If the property `:scale' is not given and the
display has a high resolution (more exactly, when the average width of a
character in the default font is more than 10 pixels), the image is
automatically scaled up in proportion to the default font.
Value is the image created, or nil if images of type TYPE are not supported. Value is the image created, or nil if images of type TYPE are not supported.
Images should not be larger than specified by `max-image-size'. Images should not be larger than specified by `max-image-size'.