diff options
| author | Gerd Moellmann | 2000-05-03 10:45:51 +0000 |
|---|---|---|
| committer | Gerd Moellmann | 2000-05-03 10:45:51 +0000 |
| commit | 96f66dc5f257ecb67edb02a1e371f56a40bebe59 (patch) | |
| tree | 63d736b4fbb7ac807f8ab2df904217f964dc33c7 | |
| parent | 9b21ecc23fe4bff2eac5afab51a9561f0ce65bf6 (diff) | |
| download | emacs-96f66dc5f257ecb67edb02a1e371f56a40bebe59.tar.gz emacs-96f66dc5f257ecb67edb02a1e371f56a40bebe59.zip | |
*** empty log message ***
| -rw-r--r-- | lispref/display.texi | 38 |
1 files changed, 27 insertions, 11 deletions
diff --git a/lispref/display.texi b/lispref/display.texi index 4fa586136c7..5992c36171d 100644 --- a/lispref/display.texi +++ b/lispref/display.texi | |||
| @@ -2470,22 +2470,38 @@ background color. This color is used for each pixel in the XBM that is | |||
| 2470 | @end table | 2470 | @end table |
| 2471 | 2471 | ||
| 2472 | If you specify an XBM image using data within Emacs instead of an | 2472 | If you specify an XBM image using data within Emacs instead of an |
| 2473 | external file, use the following three properties (all of them): | 2473 | external file, use the following three properties: |
| 2474 | 2474 | ||
| 2475 | @table @code | 2475 | @table @code |
| 2476 | @item :width @var{width} | 2476 | @item :data @var{data} |
| 2477 | The value, @var{width}, specifies the width the image in pixels. | 2477 | The value, @var{data}, specifies the contents of the image. |
| 2478 | There are three formats you can use for @var{data}: | ||
| 2478 | 2479 | ||
| 2479 | @item :height @var{height} | 2480 | @itemize @bullet |
| 2480 | The value, @var{height}, specifies the height of the image in pixels. | 2481 | @item |
| 2482 | A vector of strings or bool-vectors, each specifying one line of the | ||
| 2483 | image. Do specify @code{:height} and @code{:width}. | ||
| 2481 | 2484 | ||
| 2482 | @item :data @var{data} | 2485 | @item |
| 2483 | The value, @var{data}, should normally be a string or a bool-vector. | 2486 | A string containing the same byte sequence as an XBM file would contain. |
| 2484 | Either way, it must contain enough bits for the area of the image: at | 2487 | You must not specify @code{:height} and @code{:width} in this case, |
| 2485 | least @var{width} * @code{height} bits. | 2488 | because omitting them is what indicates the data has the format of an |
| 2489 | XBM file. The file contents specify the height and width of the image. | ||
| 2486 | 2490 | ||
| 2487 | Alternatively, @var{data} can be a vector of strings or bool-vectors, | 2491 | @item |
| 2488 | each specifying one line of the image. | 2492 | A string or a bool-vector containing the bits of the image (plus perhaps |
| 2493 | some extra bits at the end that will not be used). It should contain at | ||
| 2494 | least @var{width} * @code{height} bits. In this case, you must specify | ||
| 2495 | @code{:height} and @code{:width}, both to indicate that the string | ||
| 2496 | contains just the bits rather than a whole XBM file, and to specify the | ||
| 2497 | size of the image. | ||
| 2498 | @end itemize | ||
| 2499 | |||
| 2500 | @item :width @var{width} | ||
| 2501 | The value, @var{width}, specifies the width of the image, in pixels. | ||
| 2502 | |||
| 2503 | @item :height @var{height} | ||
| 2504 | The value, @var{height}, specifies the height of the image, in pixels. | ||
| 2489 | @end table | 2505 | @end table |
| 2490 | 2506 | ||
| 2491 | @node XPM Images | 2507 | @node XPM Images |