384 lines
9.0 KiB
Plaintext
384 lines
9.0 KiB
Plaintext
'\" t
|
|
.ds xT X Toolkit Intrinsics \- C Language Interface
|
|
.ds xW Athena X Widgets \- C Language X Toolkit Interface
|
|
.ds xL Xlib \- C Language X Interface
|
|
.ds xC Inter-Client Communication Conventions Manual
|
|
.na
|
|
.de Ds
|
|
.nf
|
|
.\\$1D \\$2 \\$1
|
|
.ft 1
|
|
.\".ps \\n(PS
|
|
.\".if \\n(VS>=40 .vs \\n(VSu
|
|
.\".if \\n(VS<=39 .vs \\n(VSp
|
|
..
|
|
.de De
|
|
.ce 0
|
|
.if \\n(BD .DF
|
|
.nr BD 0
|
|
.in \\n(OIu
|
|
.if \\n(TM .ls 2
|
|
.sp \\n(DDu
|
|
.fi
|
|
..
|
|
.de FD
|
|
.LP
|
|
.KS
|
|
.TA .5i 3i
|
|
.ta .5i 3i
|
|
.nf
|
|
..
|
|
.de FN
|
|
.fi
|
|
.KE
|
|
.LP
|
|
..
|
|
.de IN \" send an index entry to the stderr
|
|
..
|
|
.de C{
|
|
.KS
|
|
.nf
|
|
.D
|
|
.\"
|
|
.\" choose appropriate monospace font
|
|
.\" the imagen conditional, 480,
|
|
.\" may be changed to L if LB is too
|
|
.\" heavy for your eyes...
|
|
.\"
|
|
.ie "\\*(.T"480" .ft L
|
|
.el .ie "\\*(.T"300" .ft L
|
|
.el .ie "\\*(.T"202" .ft PO
|
|
.el .ie "\\*(.T"aps" .ft CW
|
|
.el .ft R
|
|
.ps \\n(PS
|
|
.ie \\n(VS>40 .vs \\n(VSu
|
|
.el .vs \\n(VSp
|
|
..
|
|
.de C}
|
|
.DE
|
|
.R
|
|
..
|
|
.de Pn
|
|
.ie t \\$1\fB\^\\$2\^\fR\\$3
|
|
.el \\$1\fI\^\\$2\^\fP\\$3
|
|
..
|
|
.de ZN
|
|
.ie t \fB\^\\$1\^\fR\\$2
|
|
.el \fI\^\\$1\^\fP\\$2
|
|
..
|
|
.de NT
|
|
.ne 7
|
|
.ds NO Note
|
|
.if \\n(.$>$1 .if !'\\$2'C' .ds NO \\$2
|
|
.if \\n(.$ .if !'\\$1'C' .ds NO \\$1
|
|
.ie n .sp
|
|
.el .sp 10p
|
|
.TB
|
|
.ce
|
|
\\*(NO
|
|
.ie n .sp
|
|
.el .sp 5p
|
|
.if '\\$1'C' .ce 99
|
|
.if '\\$2'C' .ce 99
|
|
.in +5n
|
|
.ll -5n
|
|
.R
|
|
..
|
|
. \" Note End -- doug kraft 3/85
|
|
.de NE
|
|
.ce 0
|
|
.in -5n
|
|
.ll +5n
|
|
.ie n .sp
|
|
.el .sp 10p
|
|
..
|
|
.ny0
|
|
'\" t
|
|
.TH XAllocStandardColormap 3X11 "Release 5" "X Version 11" "XLIB FUNCTIONS"
|
|
.SH NAME
|
|
XAllocStandardColormap, XSetRGBColormaps, XGetRGBColormaps, XStandardColormap \- allocate, set, or read a standard colormap structure
|
|
.SH SYNTAX
|
|
XStandardColormap *XAllocStandardColormap\^(\|)
|
|
.LP
|
|
void XSetRGBColormaps\^(\^\fIdisplay\fP, \fIw\fP, \fIstd_colormap\fP, \
|
|
\fIcount\fP, \fIproperty\fP\^)
|
|
.br
|
|
Display *\fIdisplay\fP\^;
|
|
.br
|
|
Window \fIw\fP\^;
|
|
.br
|
|
XStandardColormap *\fIstd_colormap\fP\^;
|
|
.br
|
|
int \fIcount\fP\^;
|
|
.br
|
|
Atom \fIproperty\fP\^;
|
|
.LP
|
|
Status XGetRGBColormaps\^(\^\fIdisplay\fP, \fIw\fP, \fIstd_colormap_return\fP, \
|
|
\fIcount_return\fP, \fIproperty\fP\^)
|
|
.br
|
|
Display *\fIdisplay\fP\^;
|
|
.br
|
|
Window \fIw\fP\^;
|
|
.br
|
|
XStandardColormap **\fIstd_colormap_return\fP\^;
|
|
.br
|
|
int *\fIcount_return\fP\^;
|
|
.br
|
|
Atom \fIproperty\fP\^;
|
|
.SH ARGUMENTS
|
|
.\" $Header: display.a,v 1.1 88/02/26 10:26:29 mento Exp $
|
|
.IP \fIdisplay\fP 1i
|
|
Specifies the connection to the X server.
|
|
.ds Cn colormaps
|
|
.IP \fIcount\fP 1i
|
|
Specifies the number of \*(Cn.
|
|
.ds Cn colormaps
|
|
.IP \fIcount_return\fP 1i
|
|
Returns the number of \*(Cn.
|
|
.\" $Header: property.a,v 1.2 88/04/05 15:19:43 mento Exp $
|
|
.IP \fIproperty\fP 1i
|
|
Specifies the property name.
|
|
.IP \fIstd_colormap\fP 1i
|
|
Specifies the
|
|
.ZN XStandardColormap
|
|
structure to be used.
|
|
.IP \fIstd_colormap_return\fP 1i
|
|
Returns the
|
|
.ZN XStandardColormap
|
|
structure.
|
|
.SH DESCRIPTION
|
|
The
|
|
.ZN XAllocStandardColormap
|
|
function allocates and returns a pointer to a
|
|
.ZN XStandardColormap
|
|
structure.
|
|
Note that all fields in the
|
|
.ZN XStandardColormap
|
|
structure are initially set to zero.
|
|
If insufficient memory is available,
|
|
.ZN XAllocStandardColormap
|
|
returns NULL.
|
|
To free the memory allocated to this structure,
|
|
use
|
|
.ZN XFree .
|
|
.LP
|
|
The
|
|
.ZN XSetRGBColormaps
|
|
function replaces the RGB colormap definition in the specified property
|
|
on the named window.
|
|
If the property does not already exist,
|
|
.ZN XSetRGBColormaps
|
|
sets the RGB colormap definition in the specified property
|
|
on the named window.
|
|
The property is stored with a type of RGB_COLOR_MAP and a format of 32.
|
|
Note that it is the caller's responsibility to honor the ICCCM
|
|
restriction that only RGB_DEFAULT_MAP contain more than one definition.
|
|
.LP
|
|
The
|
|
.ZN XSetRGBColormaps
|
|
function usually is only used by window or session managers.
|
|
To create a standard colormap,
|
|
follow this procedure:
|
|
.IP 1. 5
|
|
Open a new connection to the same server.
|
|
.IP 2. 5
|
|
Grab the server.
|
|
.IP 3. 5
|
|
See if the property is on the property list of the root window for the screen.
|
|
.IP 4. 5
|
|
If the desired property is not present:
|
|
.RS
|
|
.IP \(bu 5
|
|
Create a colormap (unless using the default colormap of the screen).
|
|
.IP \(bu 5
|
|
Determine the color characteristics of the visual.
|
|
.IP \(bu 5
|
|
Call
|
|
.ZN XAllocColorPlanes
|
|
or
|
|
.ZN XAllocColorCells
|
|
to allocate cells in the colormap.
|
|
.IP \(bu 5
|
|
Call
|
|
.ZN XStoreColors
|
|
to store appropriate color values in the colormap.
|
|
.IP \(bu 5
|
|
Fill in the descriptive members in the
|
|
.ZN XStandardColormap
|
|
structure.
|
|
.IP \(bu 5
|
|
Attach the property to the root window.
|
|
.IP \(bu 5
|
|
Use
|
|
.ZN XSetCloseDownMode
|
|
to make the resource permanent.
|
|
.RE
|
|
.IP 5. 5
|
|
Ungrab the server.
|
|
.LP
|
|
.ZN XSetRGBColormaps
|
|
can generate
|
|
.ZN BadAlloc ,
|
|
.ZN BadAtom ,
|
|
and
|
|
.ZN BadWindow
|
|
errors.
|
|
.LP
|
|
The
|
|
.ZN XGetRGBColormaps
|
|
function returns the RGB colormap definitions stored
|
|
in the specified property on the named window.
|
|
If the property exists, is of type RGB_COLOR_MAP, is of format 32,
|
|
and is long enough to contain a colormap definition,
|
|
.ZN XGetRGBColormaps
|
|
allocates and fills in space for the returned colormaps
|
|
and returns a nonzero status.
|
|
If the visualid is not present,
|
|
.ZN XGetRGBColormaps
|
|
assumes the default visual for the screen on which the window is located;
|
|
if the killid is not present,
|
|
.ZN None
|
|
is assumed, which indicates that the resources cannot be released.
|
|
Otherwise,
|
|
none of the fields are set, and
|
|
.ZN XGetRGBColormaps
|
|
returns a zero status.
|
|
Note that it is the caller's responsibility to honor the ICCCM
|
|
restriction that only RGB_DEFAULT_MAP contain more than one definition.
|
|
.LP
|
|
.ZN XGetRGBColormaps
|
|
can generate
|
|
.ZN BadAtom
|
|
and
|
|
.ZN BadWindow
|
|
errors.
|
|
.SH STRUCTURES
|
|
The
|
|
.ZN XStandardColormap
|
|
structure contains:
|
|
.LP
|
|
/* Hints */
|
|
.TS
|
|
lw(.5i) lw(2i) lw(1i).
|
|
T{
|
|
#define
|
|
T} T{
|
|
.ZN ReleaseByFreeingColormap
|
|
T} T{
|
|
( (XID) 1L)
|
|
T}
|
|
.TE
|
|
/* Values */
|
|
.IN "XStandardColormap" "" "@DEF@"
|
|
.Ds 0
|
|
.TA .5i 2.5i
|
|
.ta .5i 2.5i
|
|
typedef struct {
|
|
Colormap colormap;
|
|
unsigned long red_max;
|
|
unsigned long red_mult;
|
|
unsigned long green_max;
|
|
unsigned long green_mult;
|
|
unsigned long blue_max;
|
|
unsigned long blue_mult;
|
|
unsigned long base_pixel;
|
|
VisualID visualid;
|
|
XID killid;
|
|
} XStandardColormap;
|
|
.De
|
|
.LP
|
|
The colormap member is the colormap created by the
|
|
.ZN XCreateColormap
|
|
function.
|
|
The red_max, green_max, and blue_max members give the maximum
|
|
red, green, and blue values, respectively.
|
|
Each color coefficient ranges from zero to its max, inclusive.
|
|
For example,
|
|
a common colormap allocation is 3/3/2 (3 planes for red, 3
|
|
planes for green, and 2 planes for blue).
|
|
This colormap would have red_max = 7, green_max = 7,
|
|
and blue_max = 3.
|
|
An alternate allocation that uses only 216 colors is red_max = 5,
|
|
green_max = 5, and blue_max = 5.
|
|
.LP
|
|
The red_mult, green_mult, and blue_mult members give the
|
|
scale factors used to compose a full pixel value.
|
|
(See the discussion of the base_pixel members for further information.)
|
|
For a 3/3/2 allocation, red_mult might be 32,
|
|
green_mult might be 4, and blue_mult might be 1.
|
|
For a 6-colors-each allocation, red_mult might be 36,
|
|
green_mult might be 6, and blue_mult might be 1.
|
|
.LP
|
|
The base_pixel member gives the base pixel value used to
|
|
compose a full pixel value.
|
|
Usually, the base_pixel is obtained from a call to the
|
|
.ZN XAllocColorPlanes
|
|
function.
|
|
Given integer red, green, and blue coefficients in their appropriate
|
|
ranges, one then can compute a corresponding pixel value by
|
|
using the following expression:
|
|
.LP
|
|
.Ds
|
|
.TA .5i 1.5i
|
|
.ta .5i 1.5i
|
|
(r * red_mult + g * green_mult + b * blue_mult + base_pixel) & 0xFFFFFFFF
|
|
.De
|
|
.LP
|
|
For
|
|
.ZN GrayScale
|
|
colormaps,
|
|
only the colormap, red_max, red_mult,
|
|
and base_pixel members are defined.
|
|
The other members are ignored.
|
|
To compute a
|
|
.ZN GrayScale
|
|
pixel value, use the following expression:
|
|
.LP
|
|
.Ds
|
|
.TA .5i 1.5i
|
|
.ta .5i 1.5i
|
|
(gray * red_mult + base_pixel) & 0xFFFFFFFF
|
|
.De
|
|
.LP
|
|
Negative multipliers can be represented by converting the 2's
|
|
complement representation of the multiplier into an unsigned long and
|
|
storing the result in the appropriate _mult field.
|
|
The step of masking by 0xFFFFFFFF effectively converts the resulting
|
|
positive multiplier into a negative one.
|
|
The masking step will take place automatically on many machine architectures,
|
|
depending on the size of the integer type used to do the computation,
|
|
.LP
|
|
The visualid member gives the ID number of the visual from which the
|
|
colormap was created.
|
|
The killid member gives a resource ID that indicates whether
|
|
the cells held by this standard colormap are to be released
|
|
by freeing the colormap ID or by calling the
|
|
.ZN XKillClient
|
|
function on the indicated resource.
|
|
(Note that this method is necessary for allocating out of an existing colormap.)
|
|
.LP
|
|
The properties containing the
|
|
.ZN XStandardColormap
|
|
information have
|
|
the type RGB_COLOR_MAP.
|
|
.SH DIAGNOSTICS
|
|
.\" $Header: badalloc.e,v 1.3 87/09/11 11:17:14 mento Exp $
|
|
.TP 1i
|
|
.ZN BadAlloc
|
|
The server failed to allocate the requested resource or server memory.
|
|
.\" $Header: badatom.e,v 1.1 87/09/04 08:22:55 mento Exp $
|
|
.TP 1i
|
|
.ZN BadAtom
|
|
A value for an Atom argument does not name a defined Atom.
|
|
.\" $Header: badwindow.e,v 1.1 87/09/04 08:23:20 mento Exp $
|
|
.TP 1i
|
|
.ZN BadWindow
|
|
A value for a Window argument does not name a defined Window.
|
|
.SH "SEE ALSO"
|
|
XAllocColor(3X11),
|
|
XCreateColormap(3X11),
|
|
XFree(3X11),
|
|
XSetCloseDownMode(3X11)
|
|
.br
|
|
\fI\*(xL\fP
|