Current File : //usr/share/man/man3xcb/xcb_get_image.3xcb

'\" t
.TH xcb_get_image 3xcb  2012-03-26 "XCB" "XCB Requests"
.ad l
.SH NAME
xcb_get_image \- 
.SH SYNOPSIS
.nf
\fBcc\fR [ \fIflag\fR\&.\&.\&. ] \fIfile\fR\&.\&.\&. \fB\-lxcb\fR [ \fIlibrary\fR\&.\&.\&. ]
.fi
.sp
.nf
\fBcc\fR [ \fIflag\fR\&.\&.\&. ] `pkg-config --cflags *` \fIfile\fR\&.\&.\&. `pkg-config --libs *` 
.fi
.hy 0
.B #include <xcb/xproto.h>
.SS Request function
.HP
xcb_get_image_cookie_t \fBxcb_get_image\fP(xcb_connection_t\ *\fIconn\fP, uint8_t\ \fIformat\fP, xcb_drawable_t\ \fIdrawable\fP, int16_t\ \fIx\fP, int16_t\ \fIy\fP, uint16_t\ \fIwidth\fP, uint16_t\ \fIheight\fP, uint32_t\ \fIplane_mask\fP);
.PP
.SS Reply datastructure
.nf
.sp
typedef struct xcb_get_image_reply_t {
    uint8_t        \fIresponse_type\fP;
    uint8_t        \fIdepth\fP;
    uint16_t       \fIsequence\fP;
    uint32_t       \fIlength\fP;
    xcb_visualid_t \fIvisual\fP;
    uint8_t        \fIpad0\fP[20];
} \fBxcb_get_image_reply_t\fP;
.fi
.SS Reply function
.HP
xcb_get_image_reply_t *\fBxcb_get_image_reply\fP(xcb_connection_t\ *\fIconn\fP, xcb_get_image_cookie_t\ \fIcookie\fP, xcb_generic_error_t\ **\fIe\fP);
.SS Reply accessors
.HP
uint8_t *\fBxcb_get_image_data\fP(const xcb_get_image_request_t *\fIreply\fP);
.HP
int \fBxcb_get_image_data_length\fP(const xcb_get_image_reply_t *\fIreply\fP);
.HP
xcb_generic_iterator_t \fBxcb_get_image_data_end\fP(const xcb_get_image_reply_t *\fIreply\fP);
.br
.hy 1
.SH REQUEST ARGUMENTS
.IP \fIconn\fP 1i
The XCB connection to X11.
.IP \fIformat\fP 1i
One of the following values:
.RS 1i
.IP \fIXCB_IMAGE_FORMAT_XY_BITMAP\fP 1i
TODO: NOT YET DOCUMENTED.
.IP \fIXCB_IMAGE_FORMAT_XY_PIXMAP\fP 1i
TODO: NOT YET DOCUMENTED.
.IP \fIXCB_IMAGE_FORMAT_Z_PIXMAP\fP 1i
TODO: NOT YET DOCUMENTED.
.RE
.RS 1i
TODO: NOT YET DOCUMENTED.
.RE
.IP \fIdrawable\fP 1i
TODO: NOT YET DOCUMENTED.
.IP \fIx\fP 1i
TODO: NOT YET DOCUMENTED.
.IP \fIy\fP 1i
TODO: NOT YET DOCUMENTED.
.IP \fIwidth\fP 1i
TODO: NOT YET DOCUMENTED.
.IP \fIheight\fP 1i
TODO: NOT YET DOCUMENTED.
.IP \fIplane_mask\fP 1i
TODO: NOT YET DOCUMENTED.
.SH REPLY FIELDS
.IP \fIresponse_type\fP 1i
The type of this reply, in this case \fIXCB_GET_IMAGE\fP. This field is also present in the \fIxcb_generic_reply_t\fP and can be used to tell replies apart from each other.
.IP \fIsequence\fP 1i
The sequence number of the last request processed by the X11 server.
.IP \fIlength\fP 1i
The length of the reply, in words (a word is 4 bytes).
.IP \fIdepth\fP 1i
TODO: NOT YET DOCUMENTED.
.IP \fIvisual\fP 1i
TODO: NOT YET DOCUMENTED.
.SH DESCRIPTION
.SH RETURN VALUE
Returns an \fIxcb_get_image_cookie_t\fP. Errors have to be handled when calling the reply function \fIxcb_get_image_reply\fP.

If you want to handle errors in the event loop instead, use \fIxcb_get_image_unchecked\fP. See \fBxcb-requests(3)\fP for details.
.SH ERRORS
This request does never generate any errors.
.SH SEE ALSO
.SH AUTHOR
Generated from xproto.xml. Contact xcb@lists.freedesktop.org for corrections and improvements.

.\" Begin Oracle Solaris update
.SH "ATTRIBUTES"
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp
.TS
allbox;
cw(2.750000i)| cw(2.750000i)
lw(2.750000i)| lw(2.750000i).
ATTRIBUTE TYPE	ATTRIBUTE VALUE
Availability	x11/library/libxcb
Interface Stability	Volatile
MT-Level	Safe
.TE
.sp
.\" End Oracle Solaris update