XSetState(3X11) manual page

Table of Contents

## Name

XSetState, XSetFunction, XSetPlaneMask, XSetForeground, XSetBackground - GC convenience routines

## Syntax

int XSetState(Display *display, GC gc, unsigned long
  foreground, unsigned int background, int function, unsigned long plane_mask);
int XSetFunction(Display *display, GC gc, int
  function);
int XSetPlaneMask(Display *display, GC gc, unsigned long
  plane_mask);
int XSetForeground(Display *display, GC gc, unsigned long
  foreground);
int XSetBackground(Display *display, GC gc, unsigned long
  background);

## Arguments

background
  Specifies the background you want to set for the specified GC.
display
  Specifies the connection to the X server.
foreground
  Specifies the foreground you want to set for the specified GC.
function
  Specifies the function you want to set for the specified GC.
gc
  Specifies the GC.
plane_mask
  Specifies the plane mask.

## Description

The XSetState function sets the foreground, background, plane mask, and function components for the specified GC.

XSetState can generate BadAlloc, BadGC, and BadValue errors.

XSetFunction sets a specified value in the specified GC.

XSetFunction can generate BadAlloc, BadGC, and BadValue errors.

The XSetPlaneMask function sets the plane mask in the specified GC.

XSetPlaneMask can generate BadAlloc and BadGC errors.

The XSetForeground function sets the foreground in the specified GC.

XSetForeground can generate BadAlloc and BadGC errors.

The XSetBackground function sets the background in the specified GC.

XSetBackground can generate BadAlloc and BadGC errors.

## Diagnostics

BadAlloc
  The server failed to allocate the requested resource or server memory.
BadGC
  A value for a GContext argument does not name a defined GContext.
BadValue
  Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined by the argument's type is accepted. Any argument defined as a set of alternatives can generate this error.

## See Also

XCreateGC(3X11) , XQueryBestSize(3X11) , XSetArcMode(3X11) , XSetClipOrigin(3X11) , XSetFillStyle(3X11) , XSetFont(3X11) , XSetLineAttributes(3X11) , XSetTile(3X11)
Xlib - C Language X Interface

Table of Contents

- Name
- Syntax
- Arguments
- Description
- Diagnostics
- See Also