summaryrefslogtreecommitdiff
path: root/lispref
diff options
context:
space:
mode:
authorGerd Moellmann <gerd@gnu.org>2000-05-03 10:45:51 +0000
committerGerd Moellmann <gerd@gnu.org>2000-05-03 10:45:51 +0000
commit96f66dc5f257ecb67edb02a1e371f56a40bebe59 (patch)
tree63d736b4fbb7ac807f8ab2df904217f964dc33c7 /lispref
parent9b21ecc23fe4bff2eac5afab51a9561f0ce65bf6 (diff)
downloademacs-96f66dc5f257ecb67edb02a1e371f56a40bebe59.tar.gz
*** empty log message ***
Diffstat (limited to 'lispref')
-rw-r--r--lispref/display.texi38
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
@end table
If you specify an XBM image using data within Emacs instead of an
-external file, use the following three properties (all of them):
+external file, use the following three properties:
@table @code
-@item :width @var{width}
-The value, @var{width}, specifies the width the image in pixels.
+@item :data @var{data}
+The value, @var{data}, specifies the contents of the image.
+There are three formats you can use for @var{data}:
-@item :height @var{height}
-The value, @var{height}, specifies the height of the image in pixels.
+@itemize @bullet
+@item
+A vector of strings or bool-vectors, each specifying one line of the
+image. Do specify @code{:height} and @code{:width}.
-@item :data @var{data}
-The value, @var{data}, should normally be a string or a bool-vector.
-Either way, it must contain enough bits for the area of the image: at
-least @var{width} * @code{height} bits.
+@item
+A string containing the same byte sequence as an XBM file would contain.
+You must not specify @code{:height} and @code{:width} in this case,
+because omitting them is what indicates the data has the format of an
+XBM file. The file contents specify the height and width of the image.
-Alternatively, @var{data} can be a vector of strings or bool-vectors,
-each specifying one line of the image.
+@item
+A string or a bool-vector containing the bits of the image (plus perhaps
+some extra bits at the end that will not be used). It should contain at
+least @var{width} * @code{height} bits. In this case, you must specify
+@code{:height} and @code{:width}, both to indicate that the string
+contains just the bits rather than a whole XBM file, and to specify the
+size of the image.
+@end itemize
+
+@item :width @var{width}
+The value, @var{width}, specifies the width of the image, in pixels.
+
+@item :height @var{height}
+The value, @var{height}, specifies the height of the image, in pixels.
@end table
@node XPM Images