NAME
xcbcreatewindow - Creates a window SYNOPSIS
#include
Request function xcbvoidcookiet xcbcreatewindow(xcbconnectiont *conn, uint8t depth, xcbwindowt wid, xcbwindowt parent, int16t x, int16t y, uint16t width, uint16t height, uint16t borderwidth, uint16t class, xcbvisualidt visual, uint32t valuemask, const void *valuelist); REQUEST ARGUMENTS conn The XCB connection to X11. depth Specifies the new window's depth (TODO: what unit?). The special value XCBCOPYFROMPARENT means the depth is taken from the parent window. wid The ID with which you will refer to the new window, created by xcbgenerateid. parent The parent window of the new window. x The X coordinate of the new window. y The Y coordinate of the new window. width The width of the new window. height The height of the new window. borderwidth TODO: Must be zero if the class is InputOnly or a xcbmatcherrort occurs. class One of the following values: XCBWINDOWCLASSCOPYFROMPARENT TODO: NOT YET DOCUMENTED. XCBWINDOWCLASSINPUTOUTPUT TODO: NOT YET DOCUMENTED. XCBWINDOWCLASSINPUTONLY TODO: NOT YET DOCUMENTED. visual Specifies the id for the new window's visual. The special value XCBCOPYFROMPARENT means the visual is taken from the parent window. valuemask One of the following values: XCBCWBACKPIXMAP Overrides the default background-pixmap. The back‐ ground pixmap and window must have the same root and same depth. Any size pixmap can be used, al‐ though some sizes may be faster than others. If XCBBACKPIXMAPNONE is specified, the window has no defined background. The server may fill the contents with the previous screen contents or with contents of its own choosing. If XCBBACKPIXMAPPARENTRELATIVE is specified, the parent's background is used, but the window must have the same depth as the parent (or a Match error results). The parent's background is tracked, and the current version is used each time the window background is required. XCBCWBACKPIXEL Overrides BackPixmap. A pixmap of undefined size filled with the specified background pixel is used
for the background. Range-checking is not per‐ formed, the background pixel is truncated to the appropriate number of bits. XCBCWBORDERPIXMAP
Overrides the default border-pixmap. The border pixmap and window must have the same root and the same depth. Any size pixmap can be used, although some sizes may be faster than others. The special value XCBCOPYFROMPARENT means the parent's border pixmap is copied (subsequent changes to the parent's border attribute do not af‐ fect the child), but the window must have the same depth as the parent. XCBCWBORDERPIXEL Overrides BorderPixmap. A pixmap of undefined size filled with the specified border pixel is used for the border. Range checking is not performed on the
border-pixel value, it is truncated to the appro‐ priate number of bits. XCBCWBITGRAVITY Defines which region of the window should be re‐ tained if the window is resized. XCBCWWINGRAVITY Defines how the window should be repositioned if the parent is resized (see ConfigureWindow). XCBCWBACKINGSTORE
A backing-store of WhenMapped advises the server that maintaining contents of obscured regions when the window is mapped would be beneficial. A back‐
ing-store of Always advises the server that main‐ taining contents even when the window is unmapped would be beneficial. In this case, the server may generate an exposure event when the window is cre‐ ated. A value of NotUseful advises the server that maintaining contents is unnecessary, although a server may still choose to maintain contents while the window is mapped. Note that if the server main‐ tains contents, then the server should maintain complete contents not just the region within the parent boundaries, even if the window is larger than its parent. While the server maintains con‐ tents, exposure events will not normally be gener‐ ated, but the server may stop maintaining contents at any time. XCBCWBACKINGPLANES
The backing-planes indicates (with bits set to 1) which bit planes of the window hold dynamic data
that must be preserved in backing-stores and during
save-unders. XCBCWBACKINGPIXEL
The backing-pixel specifies what value to use in
planes not covered by backing-planes. The server is free to save only the specified bit planes in the
backing-store or save-under and regenerate the re‐ maining planes with the specified pixel value. Any bits beyond the specified depth of the window in these values are simply ignored. XCBCWOVERRIDEREDIRECT
The override-redirect specifies whether map and configure requests on this window should override a SubstructureRedirect on the parent, typically to inform a window manager not to tamper with the win‐ dow. XCBCWSAVEUNDER If 1, the server is advised that when this window is mapped, saving the contents of windows it ob‐ scures would be beneficial. XCBCWEVENTMASK
The event-mask defines which events the client is interested in for this window (or for some event types, inferiors of the window). XCBCWDONTPROPAGATE
The do-not-propagate-mask defines which events should not be propagated to ancestor windows when no client has the event type selected in this win‐ dow. XCBCWCOLORMAP The colormap specifies the colormap that best re‐ flects the true colors of the window. Servers capa‐ ble of supporting multiple hardware colormaps may
use this information, and window man- agers may use it for InstallColormap requests. The colormap must have the same visual type and root as the window (or a Match error results). If CopyFromParent is specified, the parent's colormap is copied (subse‐ quent changes to the parent's colormap attribute do not affect the child). However, the window must have the same visual type as the parent (or a Match error results), and the parent must not have a col‐ ormap of None (or a Match error results). For an explanation of None, see FreeColormap request. The colormap is copied by sharing the colormap object between the child and the parent, not by making a complete copy of the colormap contents. XCBCWCURSOR If a cursor is specified, it will be used whenever
the pointer is in the window. If None is speci- fied, the parent's cursor will be used when the pointer is in the window, and any change in the parent's cursor will cause an immediate change in the displayed cursor. TODO: NOT YET DOCUMENTED. valuelist TODO: NOT YET DOCUMENTED. DESCRIPTION Creates an unmapped window as child of the specified parent window. A CreateNotify event will be generated. The new window is placed on top in the stacking order with respect to siblings. The coordinate system has the X axis horizontal and the Y axis vertical
with the origin [0, 0] at the upper-left corner. Coordinates are inte‐ gral, in terms of pixels, and coincide with pixel centers. Each window and pixmap has its own coordinate system. For a window, the origin is
inside the border at the inside, upper-left corner. The created window is not yet displayed (mapped), call xcbmapwindow to display it. The created window will initially use the same cursor as its parent. RETURN VALUE Returns an xcbvoidcookiet. Errors (if any) have to be handled in the event loop. If you want to handle errors directly with xcbrequestcheck instead,
use xcbcreatewindowchecked. See xcb-requests(3) for details. ERRORS xcballocerrort The X server could not allocate the requested resources (no memory?). xcbcolormaperrort TODO: reasons? xcbcursorerrort TODO: reasons? xcbmatcherrort TODO: reasons? xcbpixmaperrort TODO: reasons? xcbvalueerrort TODO: reasons? xcbwindowerrort TODO: reasons? SEE ALSO
xcb-requests(3), xcbcreatenotifyeventt(3), xcbmapwindow(3), xcbgenerateid(3) AUTHOR Generated from xproto.xml. Contact xcb@lists.freedesktop.org for cor‐ rections and improvements. X Version 11 libxcb 1.13 xcbcreatewindow(3)