XShm
NAMESYNTAX
STRUCTURES
DESCRIPTION
SEE ALSO
NAME
XShmQueryExtension, XShmQueryVersion, XShmPixmapFormat, XShmAttach, XShmDetach XShmCreateImage, XShmPutImage, XShmGetImage, XShmCreatePixmap, XShmGetEventBase - X Shared Memory extension functions
SYNTAX
#include
<X11/Xlib.h>
#include <sys/ipc.h>
#include <sys/shm.h>
#include <X11/extensions/XShm.h>
Bool |
XShmQueryExtension( | ||
Display *display); |
Bool XShmQueryVersion(
Display *display; | |
int *major, *minor; | |
Bool *pixmaps); |
Status XShmPixmapFormat(
Display *display); |
Status XShmAttach(
Display *display; | |
XShmSegmentInfo *shminfo); |
Status XShmDetach(
Display *display; | |
XShmSegmentInfo *shminfo); |
XImage *XShmCreateImage (
Display *display; | |
Visual *visual; | |
unsigned int depth; | |
int format; | |
char *data; | |
XShmSegmentInfo *shminfo; | |
unsigned int width, height); |
Status XShmPutImage(
Display *display; | |
Drawable d; | |
GC gc; | |
XImage *image; | |
int src_x, src_y, dest_x, dest_y; | |
unsigned int width, height; | |
bool send_event); |
Status XShmGetImage (
Display *display; | |
Drawable d; | |
XImage *image; | |
int x, y; | |
unsigned long plane_mask); |
Pixmap
XShmCreatePixmap(
Display *display;
Drawable d;
char *data;
XShmSegmentInfo *shminfo; | |
unsigned int width, height, depth); |
Status XShmGetEventBase(
Display *display); |
STRUCTURES
Events:
typedef struct {
int type; /* of event */
unsigned long serial; /* # of last request processed by
server*/
Bool send_event; /* true if this came from a SendEvent
request*/
Display *display; /* Display the event was read from */
Drawable drawable; /* drawable of request */
int major_code; /* ShmReqCode */
int minor_code; /* X_ShmPutImage */
ShmSeg shmseg; /* the ShmSeg used in the request*/
unsigned long offset; /* the offset into ShmSeg used in the
request*/
} XShmCompletionEvent;
a structure of type XShmSegmentInfo :
typedef struct
{
ShmSeg shmseg; /* resource id */
int shmid; /* kernel id */
char *shmaddr; /* address in client */
Bool readOnly; /* how the server should attach it */
} XShmSegmentInfo;
DESCRIPTION
XShmQueryExtension checks to see if the shared memory extensions are available for the specified display.
XShmQueryVersion returns the version numbers of the extension implementation. Shared memory pixmaps are supported if the pixmaps argument returns true.
XShmAttach tells the server to attach to your shared memory segment. If all goes well, you will get a non-zero status, back and your XImage is ready for use.
XShmDetach tells the server to detach from your shared memory segment.
XShmPutImage combines an image in memory with a shape of the specified drawable. If XYBitmap format is used, the depth must be one, or a ‘‘BadMatch’’ error results. The foreground pixel in the GC defines the source for the one bits in the image, and the background pixel defines the source for the zero bits. For XYPixmap and ZPixmap, the depth must match the depth of the drawable, or a ‘‘BadMatch’’ error results.
XShmGetImage reads image data into a shared memory XImage where display is the display of interest, drawable is the source drawable, image is the destination XImage, x and y are offsets within the drawable, and plane_mask defines which planes are to be read.
XShmCreateImage allocates the memory needed for an XImage structure for the specified display but does not allocate space for the image itself.
XShmPixmapFormat gets the format for the server. If your application can deal with the server pixmap data format, a shared memory segment and shminfo structure are created.
XShmCreatePixmap points to a pixmap which you can manipulate in all of the usual ways, with the added bonus of being able to edit its contents directly through the shared memory segment.
XShmGetEventBase gets the completion event value.
SEE ALSO
MIT-SHM - The MIT Shared Memory Extension
More Linux Commands
manpages/mvins_wch.3ncurses.html
mvins_wch(3ncurses) - insert a complex character and renditi
These routines, insert the complex character wch with rendition before the character under the cursor. All characters to the right of the cursor are moved one s
manpages/dumpcap.1.html
dumpcap(1) - Dump network traffic - Linux manual page.......
Dumpcap is a network traffic dump tool. It lets you capture packet data from a live network and write the packets to a file. Dumpcaps default capture file forma
manpages/btrfs-restore.8.html
btrfs-restore(8) try to restore files from a damaged btrfs f
btrfs restore is used to try to salvage files from a damaged filesystem and restore them into <path> or just list the tree roots. Since current btrfs-check(8) o
manpages/clientlib.3.html
clientlib(3) - NNTP clientlib part of InterNetNews library
The routines described in this manual page are part of the InterNetNews library, libinn(3). They are replacements for the clientlib part of the NNTP distributio
manpages/Tcl_SetExitProc.3.html
Tcl_SetExitProc(3) - end the application or thread (and invo
The procedures described here provide a graceful mechanism to end the execution of a Tcl application. Exit handlers are invoked to cleanup the applications stat
manpages/setfattr.1.html
setfattr(1) - set extended attributes of filesystem objects
The setfattr command associates a new value with an extended attribute name for each specified file. OPTIONS -n name, --name=name Specifies the name of the exte
manpages/SDL_mutexP.3.html
SDL_mutexP(3) - Lock a mutex (Library - Linux man page).....
Locks the mutex, which was previously created with SDL_CreateMutex. If the mutex is already locked then SDL_mutexP will not return until it is unlocked. Returns
manpages/uri.7.html
uri(7) - uniform resource identifier (URI), including a URL
A Uniform Resource Identifier (URI) is a short string of characters identifying an abstract or physical resource (for example, a web page). A Uniform Resource L
manpages/glTexCoord.3gl.html
glTexCoord(3gl) - set the current texture coordinates.......
glTexCoord specifies texture coordinates in one, two, three, or four dimensions. glTexCoord1 sets the current texture coordinates to (s, 0, 0, 1); a call to glT
manpages/read.2.html
read(2) - read from a file descriptor - Linux manual page...
read() attempts to read up to count bytes from file descriptor fd into the buffer starting at buf. On files that support seeking, the read operation commences a
manpages/gnutls_session_get_data2.3.html
gnutls_session_get_data2(3) - API function - Linux man page
gnutls_session_get_data2.3 - Returns all session parameters, in order to support resuming. The client should call this, and keep the returned session, if he wan
manpages/glResetMinmax.3gl.html
glResetMinmax(3gl) - reset minmax table entries to initial v
glResetMinmax resets the elements of the current minmax table to their initial values: the maximum element receives the minimum possible component values, and t
