xcb\_circulate\_window(3) XCB Requests xcb\_circulate\_window(3)

# [NAME](#NAME)

xcb\_circulate\_window - Change window stacking order

# [SYNOPSIS](#SYNOPSIS)

**#include <xcb/xproto.h>**

## [Request function](#Request_function)

xcb\_void\_cookie\_t **xcb\_circulate\_window**(xcb\_connection\_t \**conn*, uint8\_t *direction*, xcb\_window\_t *window*);

# [REQUEST ARGUMENTS](#REQUEST_ARGUMENTS)

[*conn*](#conn)

The XCB connection to X11.

[*direction*](#direction)

One of the following values:

[*XCB\_CIRCULATE\_RAISE\_LOWEST*](#XCB_CIRCULATE_RAISE_LOWEST)

TODO: NOT YET DOCUMENTED.

[*XCB\_CIRCULATE\_LOWER\_HIGHEST*](#XCB_CIRCULATE_LOWER_HIGHEST)

TODO: NOT YET DOCUMENTED.

[*window*](#window)

The window to raise/lower (depending on *direction*).

# [DESCRIPTION](#DESCRIPTION)

If *direction* is *XCB\_CIRCULATE\_RAISE\_LOWEST*, the lowest mapped child (if any) will be raised to the top of the stack.

If *direction* is *XCB\_CIRCULATE\_LOWER\_HIGHEST*, the highest mapped child will be lowered to the bottom of the stack.

# [RETURN VALUE](#RETURN_VALUE)

Returns an *xcb\_void\_cookie\_t*. Errors (if any) have to be handled in the event loop.

If you want to handle errors directly with *xcb\_request\_check* instead, use *xcb\_circulate\_window\_checked*. See [**xcb-requests(3)**](/man/os/libxcb/xcb-requests.3) for details.

# [ERRORS](#ERRORS)

[*xcb\_value\_error\_t*](#xcb_value_error_t)

The specified *direction* is invalid.

[*xcb\_window\_error\_t*](#xcb_window_error_t)

The specified *window* does not exist.

# [SEE ALSO](#SEE_ALSO)

[**xcb-requests**(3)](/man/os/libxcb/xcb-requests.3)

# [AUTHOR](#AUTHOR)

Generated from xproto.xml. Contact xcb@lists.freedesktop.org for corrections and improvements.

libxcb 1.17.0 X Version 11

---

Document: xcb_circulate_window(3) from libxcb 1.17.0-r16 (Chainguard OS)
Source: https://gitlab.freedesktop.org/xorg/lib/libxcb.git