diff options
| author | Richard M. Stallman | 2005-01-15 23:09:32 +0000 |
|---|---|---|
| committer | Richard M. Stallman | 2005-01-15 23:09:32 +0000 |
| commit | 5092b64401d41a879f2f59b2a813a58b8f71c263 (patch) | |
| tree | 35f032d5557b938ce32bb292eac25b473335f889 | |
| parent | d4b6c2e3326c888da19e2be60899a27ef8a16f0a (diff) | |
| download | emacs-5092b64401d41a879f2f59b2a813a58b8f71c263.tar.gz emacs-5092b64401d41a879f2f59b2a813a58b8f71c263.zip | |
(Defining Images): Mention DATA-P arg of create-image.
| -rw-r--r-- | lispref/display.texi | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/lispref/display.texi b/lispref/display.texi index 7b0e72c753f..375db424122 100644 --- a/lispref/display.texi +++ b/lispref/display.texi | |||
| @@ -3788,10 +3788,12 @@ background color. | |||
| 3788 | The functions @code{create-image}, @code{defimage} and | 3788 | The functions @code{create-image}, @code{defimage} and |
| 3789 | @code{find-image} provide convenient ways to create image descriptors. | 3789 | @code{find-image} provide convenient ways to create image descriptors. |
| 3790 | 3790 | ||
| 3791 | @defun create-image file &optional type &rest props | 3791 | @defun create-image file-or-data &optional type data-p &rest props |
| 3792 | @tindex create-image | 3792 | @tindex create-image |
| 3793 | This function creates and returns an image descriptor which uses the | 3793 | This function creates and returns an image descriptor which uses the |
| 3794 | data in @var{file}. | 3794 | data in @var{file-or-data}. @var{file-or-data} can be a file name or |
| 3795 | a string containing the image data; @var{data-p} should be @code{nil} | ||
| 3796 | for the former case, non-@code{nil} for the latter case. | ||
| 3795 | 3797 | ||
| 3796 | The optional argument @var{type} is a symbol specifying the image type. | 3798 | The optional argument @var{type} is a symbol specifying the image type. |
| 3797 | If @var{type} is omitted or @code{nil}, @code{create-image} tries to | 3799 | If @var{type} is omitted or @code{nil}, @code{create-image} tries to |
| @@ -3802,7 +3804,7 @@ The remaining arguments, @var{props}, specify additional image | |||
| 3802 | properties---for example, | 3804 | properties---for example, |
| 3803 | 3805 | ||
| 3804 | @example | 3806 | @example |
| 3805 | (create-image "foo.xpm" 'xpm :heuristic-mask t) | 3807 | (create-image "foo.xpm" 'xpm nil :heuristic-mask t) |
| 3806 | @end example | 3808 | @end example |
| 3807 | 3809 | ||
| 3808 | The function returns @code{nil} if images of this type are not | 3810 | The function returns @code{nil} if images of this type are not |