XSetState(3) XLIB FUNCTIONS XSetState(3)

# [NAME](#NAME)

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

# [SYNTAX](#SYNTAX)

int XSetState(Display \**display*, GC *gc*, unsigned long *foreground*, unsigned long *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](#ARGUMENTS)

[*background*](#background)

Specifies the background you want to set for the specified GC.

[*display*](#display)

Specifies the connection to the X server.

[*foreground*](#foreground)

Specifies the foreground you want to set for the specified GC.

[*function*](#function)

Specifies the function you want to set for the specified GC.

[*gc*](#gc)

Specifies the GC.

[*plane\_mask*](#plane_mask)

Specifies the plane mask.

# [DESCRIPTION](#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](#DIAGNOSTICS)

[**BadAlloc**](#BadAlloc)

The server failed to allocate the requested resource or server memory.

[**BadGC**](#BadGC)

A value for a GContext argument does not name a defined GContext.

[**BadValue**](#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](#SEE_ALSO)

[**XCreateGC**(3)](/man/os/libx11/XCreateGC.3), [**XQueryBestSize**(3)](/man/os/libx11/XQueryBestSize.3), [**XSetArcMode**(3)](/man/os/libx11/XSetArcMode.3), [**XSetClipOrigin**(3)](/man/os/libx11/XSetClipOrigin.3), [**XSetFillStyle**(3)](/man/os/libx11/XSetFillStyle.3), [**XSetFont**(3)](/man/os/libx11/XSetFont.3), [**XSetLineAttributes**(3)](/man/os/libx11/XSetLineAttributes.3), [**XSetTile**(3)](/man/os/libx11/XSetTile.3)  
*Xlib - C Language X Interface*

libX11 1.8.14 X Version 11

---

Document: XSetForeground(3) from libx11 1.8.14-r0 (Chainguard OS)
Source: https://gitlab.freedesktop.org/xorg/lib/libx11.git