aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBenjamin Riefenstahl2019-01-15 17:00:04 +0100
committerEli Zaretskii2019-01-25 10:20:55 +0200
commitb6c762a520c041d8c69a8557b9ee5ffdd3004b1f (patch)
tree802b449f08aa8ffa5f9f3130c12d7a50bc607d88
parent928d342c81c4d442e3125ddc463d141029d6898f (diff)
downloademacs-b6c762a520c041d8c69a8557b9ee5ffdd3004b1f.tar.gz
emacs-b6c762a520c041d8c69a8557b9ee5ffdd3004b1f.zip
create-image: Expand documentation (bug#33990)
* lisp/image.el (create-image): Discuss default for :scale in the doc string.
-rw-r--r--lisp/image.el9
1 files changed, 8 insertions, 1 deletions
diff --git a/lisp/image.el b/lisp/image.el
index b49f1b3aa5a..3019da556b3 100644
--- a/lisp/image.el
+++ b/lisp/image.el
@@ -413,13 +413,20 @@ must be available."
413(defun create-image (file-or-data &optional type data-p &rest props) 413(defun create-image (file-or-data &optional type data-p &rest props)
414 "Create an image. 414 "Create an image.
415FILE-OR-DATA is an image file name or image data. 415FILE-OR-DATA is an image file name or image data.
416
416Optional TYPE is a symbol describing the image type. If TYPE is omitted 417Optional TYPE is a symbol describing the image type. If TYPE is omitted
417or nil, try to determine the image type from its first few bytes 418or nil, try to determine the image type from its first few bytes
418of image data. If that doesn't work, and FILE-OR-DATA is a file name, 419of image data. If that doesn't work, and FILE-OR-DATA is a file name,
419use its file extension as image type. 420use its file extension as image type.
421
420Optional DATA-P non-nil means FILE-OR-DATA is a string containing image data. 422Optional DATA-P non-nil means FILE-OR-DATA is a string containing image data.
423
421Optional PROPS are additional image attributes to assign to the image, 424Optional PROPS are additional image attributes to assign to the image,
422like, e.g. `:mask MASK'. 425like, e.g. `:mask MASK'. If the property `:scale' is not given and the
426display has a high resolution (more exactly, when the average width of a
427character in the default font is more than 10 pixels), the image is
428automatically scaled up in proportion to the default font.
429
423Value is the image created, or nil if images of type TYPE are not supported. 430Value is the image created, or nil if images of type TYPE are not supported.
424 431
425Images should not be larger than specified by `max-image-size'. 432Images should not be larger than specified by `max-image-size'.