application string is not used. It can be used by the user to hold application specific information.
bitmap_pad is the alignment of scanline rows. Possible values are 8, 16 or 32. The default is 8.
bitmap_bit_order indicates the order of bits in pixels. This is set implicitly when an image is created using create! or get_image:. Although the user can set it using bitmap_bit_order=, it has no effect other than to confuse the programmer. Valid values are LSBFirst (0) and MSBFirst (1).
byte_order indicates the order of bytes in pixels that are bigger than one byte. This is set implicitly when an image is created using create! or get_image:. Although the user can set it using bitmap_bit_order=, it has no effect other than to confuse the programmer. Valid values are LSBFirst (0) and MSBFirst (1).
bits_per_pixel is the size of a pixel. It is only useful for ZPixmap images.
bytes_per_line is the number of bytes between successive scanlines. If you use the default value 0, Xlib will assume that the memory is contiguous and will calculate the bytes_per_line.
data is a pointer to the data.
depth is the depth of the image. If the depth is not set, the display's default depth will be used.
height is the height of the image. The default is 512.
id is a pointer to the XImage structure.
plane_mask specifies which planes to fetch when getting an image with the get_image! message.
screen is the name of an xscreen instance. If no screen is specified, the default screen of the X display is used. The screen is used during creation, so make sure to set this instance variable before you create the image.
width is the width of the image. The default is 512.
xoffset is number of pixels to ignore at the beginning of each scanline. The default is 0.
xy is the (x,y) coordinate of the current pixel in the image.
add_pixel: value adds the value to all pixels in the image.
all_planes! sets the plane mask to use all planes.
application_scalar= value sets the application_scalar instance variable.
application_scalar? returns the value of the application_scalar instance variable on the argument stack.
application_string= value sets the application_string instance variable.
application_string? returns the value of the application_string instance variable on the argument stack.
bitmap_pad= value sets the bitmap_pad instance variable.
bitmap_pad? returns the value of the bitmap_pad instance variable on the argument stack.
bytes_per_lines= value sets the bytes_per_lines instance variable.
bytes_per_lines? returns the value of the bytes_per_lines instance variable on the argument stack.
create! creates the image and sets the id instance variable.
data= value sets the data instance variable.
data? returns the value of the data instance variable on the argument stack.
depth= value sets the depth instance variable.
depth? returns the value of the depth instance variable on the argument stack.
display= display_object_name sets the display instance variable.
display? returns the value of the display instance variable on the argument stack.
get_image: window fetches a rectangular image from the specified window and sets the id instance variable.
height= value sets the height instance variable.
height? returns the value of the height instance variable on the argument stack.
id? returns pointer to the XImage structure.
pixel? returns the pixel at the current image coordinate which is specified by the xy instance variable.
planes=: plane numbers clear the planes_mask and adds the planes specified to the plane mask. The numbers can range from 0 through 32.
planes+: plane numbers adds the planes specified to the plane mask. The numbers can range from 0 through 32.
planes-: plane numbers subtracts the planes specified from the plane mask. The numbers can range from 0 through 32.
plane_mask= value sets the plane_mask instance variable.
plane_mask? returns the value of the plane_mask instance variable on the argument stack.
put_pixel: pixel puts the pixel at the current image coordinate which is specified by the xy instance variable.
screen? retreives the screen instance variable.
screen= sets the screen instance variable. Note: timing is important. You must set the screen before creation.
visual= visual_object_name sets the visual instance variable.
visual? returns the value of the visual instance variable on the argument stack.
width= value sets the width instance variable.
width? returns the value of the width instance variable on the argument stack.
width= value sets the width instance variable.
xoffset? returns the value of the xoffset instance variable on the argument stack.
xy? returns the value of the xy instance variable on the argument stack.
Please send comments and suggestions to
its-documentation@rpi.edu