aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--lispref/display.texi50
1 files changed, 25 insertions, 25 deletions
diff --git a/lispref/display.texi b/lispref/display.texi
index 23f826a56ec..2c896841593 100644
--- a/lispref/display.texi
+++ b/lispref/display.texi
@@ -2450,6 +2450,31 @@ XPM format.
2450types: 2450types:
2451 2451
2452@table @code 2452@table @code
2453@item :file @var{file}
2454The @code{:file} property specifies to load the image from file
2455@var{file}. If @var{file} is not an absolute file name, it is expanded
2456in @code{data-directory}.
2457
2458@item :data @var{data}
2459The @code{:data} property specifies the actual contents of the image.
2460Each image must use either @code{:data} or @code{:file}, but not both.
2461For most image types, the value of the @code{:data} property should be a
2462string containing the image data; we recommend using a unibyte string.
2463
2464Before using @code{:data}, look for further information in the section
2465below describing the specific image format. For some image types,
2466@code{:data} may not be supported; for some, it allows other data types;
2467for some, @code{:data} alone is not enough, so you need to use other
2468image properties along with @code{:data}.
2469
2470@item :margin @var{margin}
2471The @code{:margin} property specifies how many pixels to add as an
2472extra margin around the image. The value, @var{margin}, must be a a
2473non-negative number, or a pair @code{(@var{x} . @var{y})} of such
2474numbers. If it is a pair, @var{x} specifies how many pixels to add
2475horizontally, and @var{y} specifies how many pixels to add vertically.
2476If @code{:margin} is not specified, the default is zero.
2477
2453@item :ascent @var{ascent} 2478@item :ascent @var{ascent}
2454The @code{:ascent} property specifies the amount of the image's 2479The @code{:ascent} property specifies the amount of the image's
2455height to use for its ascent---that is, the part above the baseline. 2480height to use for its ascent---that is, the part above the baseline.
@@ -2466,14 +2491,6 @@ properties and overlays that apply to the image.
2466 2491
2467If this property is omitted, it defaults to 50. 2492If this property is omitted, it defaults to 50.
2468 2493
2469@item :margin @var{margin}
2470The @code{:margin} property specifies how many pixels to add as an
2471extra margin around the image. The value, @var{margin}, must be a
2472non-negative number, or a pair @code{(@var{x} . @var{y})} of such
2473numbers. If it is a pair, @var{x} specifies how many pixels to add
2474horizontally, and @var{y} specifies how many pixels to add vertically.
2475If @code{:margin} is not specified, the default is zero.
2476
2477@item :relief @var{relief} 2494@item :relief @var{relief}
2478The @code{:relief} property, if non-@code{nil}, adds a shadow rectangle 2495The @code{:relief} property, if non-@code{nil}, adds a shadow rectangle
2479around the image. The value, @var{relief}, specifies the width of the 2496around the image. The value, @var{relief}, specifies the width of the
@@ -2572,23 +2589,6 @@ specifying the color to assume for the background of the image.
2572If @var{mask} is nil, remove a mask from the image, if it has one. Images 2589If @var{mask} is nil, remove a mask from the image, if it has one. Images
2573in some formats include a mask which can be removed by specifying 2590in some formats include a mask which can be removed by specifying
2574@code{:mask nil}. 2591@code{:mask nil}.
2575
2576@item :file @var{file}
2577The @code{:file} property specifies to load the image from file
2578@var{file}. If @var{file} is not an absolute file name, it is expanded
2579in @code{data-directory}.
2580
2581@item :data @var{data}
2582The @code{:data} property specifies the actual contents of the image.
2583Each image must use either @code{:data} or @code{:file}, but not both.
2584For most image types, the value of the @code{:data} property should be a
2585string containing the image data; we recommend using a unibyte string.
2586
2587Before using @code{:data}, look for further information in the section
2588below describing the specific image format. For some image types,
2589@code{:data} may not be supported; for some, it allows other data types;
2590for some, @code{:data} alone is not enough, so you need to use other
2591image properties along with @code{:data}.
2592@end table 2592@end table
2593 2593
2594@defun image-mask-p spec &optional frame 2594@defun image-mask-p spec &optional frame