aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/lispref/display.texi18
1 files changed, 12 insertions, 6 deletions
diff --git a/doc/lispref/display.texi b/doc/lispref/display.texi
index 3c3ee1fc6a4..fd6820897f3 100644
--- a/doc/lispref/display.texi
+++ b/doc/lispref/display.texi
@@ -5446,12 +5446,14 @@ because omitting them is what indicates the data has the format of an
5446XBM file. The file contents specify the height and width of the image. 5446XBM file. The file contents specify the height and width of the image.
5447 5447
5448@item 5448@item
5449A string or a bool-vector containing the bits of the image (plus perhaps 5449A string or a bool-vector containing the bits of the image (plus
5450some extra bits at the end that will not be used). It should contain at 5450perhaps some extra bits at the end that will not be used). It should
5451least @var{width} * @code{height} bits. In this case, you must specify 5451contain at least @w{@code{@var{stride} * @var{height}}} bits, where
5452@code{:height} and @code{:width}, both to indicate that the string 5452@var{stride} is the smallest multiple of 8 greater than or equal to
5453contains just the bits rather than a whole XBM file, and to specify the 5453the width of the image. In this case, you should specify
5454size of the image. 5454@code{:height}, @code{:width} and @code{:stride}, both to indicate
5455that the string contains just the bits rather than a whole XBM file,
5456and to specify the size of the image.
5455@end itemize 5457@end itemize
5456 5458
5457@item :width @var{width} 5459@item :width @var{width}
@@ -5459,6 +5461,10 @@ The value, @var{width}, specifies the width of the image, in pixels.
5459 5461
5460@item :height @var{height} 5462@item :height @var{height}
5461The value, @var{height}, specifies the height of the image, in pixels. 5463The value, @var{height}, specifies the height of the image, in pixels.
5464
5465@item :stride @var{stride}
5466The number of bool vector entries stored for each row; the smallest
5467multiple of 8 greater than or equal to @var{width}.
5462@end table 5468@end table
5463 5469
5464@node XPM Images 5470@node XPM Images