Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help 
xcb_shm_put_image(3)		  XCB Requests		    xcb_shm_put_image(3)

NAME
     xcb_shm_put_image - Copy data from the shared memory to the specified draw-
     able.

SYNOPSIS
     #include <xcb/shm.h>

   Request function
     xcb_void_cookie_t	  xcb_shm_put_image(xcb_connection_t *conn,    xcb_draw-
	    able_t drawable,	  xcb_gcontext_t gc,	   uint16_t total_width,
	    uint16_t total_height,	  uint16_t src_x,	 uint16_t src_y,
	    uint16_t src_width,       uint16_t src_height,	  int16_t dst_x,
	    int16_t dst_y,  uint8_t depth,  uint8_t format,  uint8_t send_event,
	    xcb_shm_seg_t shmseg, uint32_t offset);

REQUEST ARGUMENTS
     conn      The XCB connection to X11.

     drawable  The drawable to draw to.

     gc        The graphics context to use.

     total_width
	       The total width of the source image.

     total_height
	       The total height of the source image.

     src_x     The source X coordinate of the sub-image to copy.

     src_y     The source Y coordinate of the sub-image to copy.

     src_width The width, in source image coordinates, of the data to copy  from
	       the  source.   The X server will use this to determine the amount
	       of data to copy.  The amount of the  destination  image	that  is
	       overwritten is determined automatically.

     src_heightThe height, in source image coordinates, of the data to copy from
	       the  source.   The X server will use this to determine the amount
	       of data to copy.  The amount of the  destination  image	that  is
	       overwritten is determined automatically.

     dst_x     The X coordinate on the destination drawable to copy to.

     dst_y     The Y coordinate on the destination drawable to copy to.

     depth     The depth to use.

     format    The  format  of	the image being drawn.	If it is XYBitmap, depth
	       must be 1, or a "BadMatch" error results.  The  foreground  pixel
	       in  the	GC  determines the source for the one bits in the image,
	       and the background pixel determines the source for the zero bits.
	       For XYPixmap and ZPixmap, the depth must match the depth  of  the
	       drawable, or a "BadMatch" error results.

     send_eventTrue  if  the server should send an XCB_SHM_COMPLETION event when
	       the blit completes.

     shmseg    TODO: NOT YET DOCUMENTED.

     offset    The offset that the source image starts at.

DESCRIPTION
     Copy data from the shared memory to the specified drawable.  The amount  of
     bytes  written  to  the  destination image is always equal to the number of
     bytes read from the shared memory segment.

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_shm_put_image_checked. See xcb-requests(3) for details.

ERRORS
     This request does never generate any errors.

SEE ALSO
     xcb-requests(3)

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

X Version 11			  libxcb 1.17.0 	    xcb_shm_put_image(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=xcb_shm_put_image_checked&sektion=3&manpath=FreeBSD+Ports+15.1.quarterly>

home | help