<<<<<<<<<<<<<<<<

xprivate_cells(x) Xlib xprivate_cells(x)

NAME

xprivate_cells - private colormap cells

DESCRIPTION

This class provides an interface to private color cells in X.

SUPERCLASS

object

INSTANCE VARIABLES

colormap is the name of the associated xcolormap object. If no colormap is specified, the default colormap for the display will be used.

contig is a boolean value that specifies whether or not the color planes need to be contiguous.

display is the name of the associated xdisplay object.

flags is a mask which indicates which rgb values are stored. The default value is 7 for DoRed | DoGreen | DoBlue.

number_of_colors is the number of cells to allocate. Possibly modified by the allocate! message.

number_of_plane_masks is the number of planes to allocate for each cell specified in number of colors.

pixel_number is the current cell. The range of this value is 1 <= pixel_number <= number of colors.

pixels is a list of pixel values for the allocated cells. All values are initialized to black.

plane_masks is a private instance variable. To manipulate the planes, use the planes instance variable.

planes is a list of the planes that are currently active. Valid plane numbers are in the range 1 <= plane_number <= number of planes if planes have been allocated.

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 allocation, so make sure to set this instance variable before you

allocate the cells.

MESSAGES

allocate! allocates the cells. If the requested number_of_colors can't be allocated, it is decremented and the allocation attempt is repeated. The number_of_colors instance variable is set to reflect the number of cells actually allocated. It is the script writer's responsibility to check the number of colors actually allocated and adapt to the smaller allocation, if necessary.

clear_planes! deselects the currently selected planes.

color:colorname stores the specified color into the current cell. For a full list of possible colornames, please refer to the Xlib manuals.

colormap= colormap_object_name sets the colormap instance variable.

colormap? returns the value of the colormap instance variable on the argument stack.

contig= value sets the contig instance variable.

contig? returns the value of the contig 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.

do_red_on! ors DoRed into the flags bitmask.

do_red_off! deletes DoRed from the flags bitmask.

do_green_on! ors DoGreen into the flags bitmask.

do_green_off! deletes DoGreen from the flags bitmask.

do_blue_on! ors DoBlue into the flags bitmask.

do_blue_off! deletes DoBlue from the flags bitmask.

flags= value sets the flags instance variable.

flags? returns the value of the flags instance variable on the argument stack.

free_cells! attempts to free the cells.

number_of_colors= value sets the number_of_colors instance variable.

number_of_colors? returns the value of the number_of_colors instance variable on the argument stack.

number_of_plane_masks= value sets the number_of_plane_masks instance variable.

number_of_plane_masks? returns the value of the number_of_plane_masks instance variable on the argument stack.

@ pixel_number, pixel= pixel_number sets the pixel_number instance variable.

pixel_number? returns the value of the number_of_plane_masks instance variable on the argument stack.

pixels? returns the pixels.

pixels_masks? returns the pointer to the plane_masks.

planes= planes clears currently active planes and adds the specified planes to the list of active planes. These planes will now be used to retrieve pixel values.

planes+ planes adds the specified planes to the list of active planes. These planes will now be used to retrieve pixel values.

planes- planes subtracts the specified planes from the list of

active planes. These planes will no longer be used to retrieve pixel values.

rgb: rgb stores the rgb into the current cell. The range for the rgb values is 0 <= rgb_value <= 1. Note that this is different from Xlib where rgb values must be in the range 0 <= Xlib_rgb_value <= 65535.

rgb? returns the rgb of the current cell.

screen? retreives the screen instance variable.

screen= sets the screen instance variable. Note: timing is important. You must set the screen before allocation.

EXAMPLE

/* store red and green into the color cells with no planes and black and white into the color cells using plane 1 */

xprivate_cells new: the_cells

number_of_colors= 2

number_of_planes= 1

@1 color: red

@2 rgb: (0, 1, 0)

planes= 1

@1 rgb: (1, 1, 1)

@2 color: black ;