diff options
author | Eli Zaretskii <eliz@gnu.org> | 2024-03-07 10:11:44 +0200 |
---|---|---|
committer | Eli Zaretskii <eliz@gnu.org> | 2024-03-07 10:11:44 +0200 |
commit | 5ffcca121bb79b97c6a0f941c71a61505032d8f8 (patch) | |
tree | 7f36dbdb7075b405ab810b9120596a4782342c6f /doc/lispref | |
parent | 6e801077ae88e72dbad32015a083602062c4efe3 (diff) | |
download | emacs-5ffcca121bb79b97c6a0f941c71a61505032d8f8.tar.gz emacs-5ffcca121bb79b97c6a0f941c71a61505032d8f8.tar.bz2 emacs-5ffcca121bb79b97c6a0f941c71a61505032d8f8.zip |
; Improve documentation of image properties
* lisp/image.el (create-image, image-property): Add to do strings
link to description of image properties in ELisp manual.
* doc/lispref/display.texi (Defining Images): Fix example and add
cross-reference to where image properties are described.
(Image Descriptors): Add index entry.
Diffstat (limited to 'doc/lispref')
-rw-r--r-- | doc/lispref/display.texi | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/doc/lispref/display.texi b/doc/lispref/display.texi index 34f215820ed..c6b29e87b3a 100644 --- a/doc/lispref/display.texi +++ b/doc/lispref/display.texi @@ -6041,6 +6041,7 @@ event is composed by combining the @var{id} of the hot-spot with the mouse event; for instance, @code{[area4 mouse-1]} if the hot-spot's @var{id} is @code{area4}. +@findex image-compute-scaling-factor Note that the map's coordinates should reflect the displayed image after all transforms have been done (rotation, scaling and so on), and also note that Emacs (by default) performs auto-scaling of images, so @@ -6759,11 +6760,15 @@ from the file's name. The remaining arguments, @var{props}, specify additional image properties---for example, -@c ':heuristic-mask' is not documented? @example -(create-image "foo.xpm" 'xpm nil :heuristic-mask t) +(create-image "foo.xpm" 'xpm nil :mask 'heuristic) @end example +@noindent +@xref{Image Descriptors}, for the list of supported properties. Some +properties are specific to certain image types, and are described in +subsections specific to those types. + The function returns @code{nil} if images of this type are not supported. Otherwise it returns an image descriptor. @end defun |