carta
xcb_get_image_unchecked(3)

xcb_get_image_unchecked3

Part of xcb_get_image(3).

Usage

Reply datastructure

uint8_t response_type;

uint8_t depth;

uint16_t sequence;

uint32_t length;

xcb_visualid_t visual;

uint8_t pad0 [20] ;

Reply accessors

uint8_t *xcb_get_image_data(const xcb_get_image_request_t *reply);

int xcb_get_image_data_length(const xcb_get_image_reply_t *reply);

xcb_generic_iterator_t xcb_get_image_data_end(const xcb_get_image_reply_t *reply);

Request arguments

conn

The XCB connection to X11.

format

One of the following values:

XCB_IMAGE_FORMAT_XY_BITMAP

TODO: NOT YET DOCUMENTED.

XCB_IMAGE_FORMAT_XY_PIXMAP

TODO: NOT YET DOCUMENTED.

XCB_IMAGE_FORMAT_Z_PIXMAP

TODO: NOT YET DOCUMENTED.

TODO: NOT YET DOCUMENTED.

drawable

TODO: NOT YET DOCUMENTED.

x

TODO: NOT YET DOCUMENTED.

y

TODO: NOT YET DOCUMENTED.

width

TODO: NOT YET DOCUMENTED.

height

TODO: NOT YET DOCUMENTED.

plane_mask

TODO: NOT YET DOCUMENTED.

Reply fields

response_type

The type of this reply, in this case XCB_GET_IMAGE. This field is also present in the xcb_generic_reply_t and can be used to tell replies apart from each other.

sequence

The sequence number of the last request processed by the X11 server.

length

The length of the reply, in words (a word is 4 bytes).

depth

TODO: NOT YET DOCUMENTED.

visual

TODO: NOT YET DOCUMENTED.

Overview

Return value

Returns an xcb_get_image_cookie_t. Errors have to be handled when calling the reply function xcb_get_image_reply.

If you want to handle errors in the event loop instead, use xcb_get_image_unchecked. See xcb-requests(3) for details.

Errors

This request does never generate any errors.

History

  • Arch Linux 2026-11-01 to Debian 13 (Trixie): the text shown here
  • Debian 12 (Bookworm)
  • Debian 11 (Bullseye)
  • Debian 10 (Buster)
  • Debian 9 (Stretch)

Author

Generated from xproto.xml. Contact [email protected] for corrections and improvements.

From libxcb 1.17.0-1 in Arch Linux 2026-11-01. Parsed by carta from the page's man source.