Package org.lwjgl.system.linux

Class X11

java.lang.Object

org.lwjgl.system.linux.X11

public class X11
extends java.lang.Object

Native bindings to libX11.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	X11.Functions Contains the function pointers loaded from the X11 SharedLibrary.

Field Summary

Fields

Modifier and Type	Field and Description
static int	AllocAll AllocNone For X11.XCreateColormap(long, long, org.lwjgl.system.linux.Visual, int).
static int	AllowExposures SCREEN SAVER STUFF
static int	AllTemporary RESERVED RESOURCE AND CONSTANT DEFINITIONS
static int	AlreadyGrabbed GrabPointer, GrabKeyboard reply status
static int	AnyButton AnyKey RESERVED RESOURCE AND CONSTANT DEFINITIONS
static int	AnyModifier button masks.
static int	AnyPropertyType RESERVED RESOURCE AND CONSTANT DEFINITIONS
static int	ArcChord ArcPieSlice Arc modes for PolyFillArc
static int	AsyncBoth AsyncKeyboard AsyncPointer AllowEvents modes
static int	BadAccess BadAlloc BadAtom BadColor BadCursor BadDrawable BadFont BadGC BadIDChoice BadImplementation BadLength BadMatch BadName BadPixmap BadRequest BadValue BadWindow ERROR CODES
static int	Button1 button names.
static int	Button1Mask button masks.
static int	Button1MotionMask Input Event Masks.
static int	Button2 button names.
static int	Button2Mask button masks.
static int	Button2MotionMask Input Event Masks.
static int	Button3 button names.
static int	Button3Mask button masks.
static int	Button3MotionMask Input Event Masks.
static int	Button4 button names.
static int	Button4Mask button masks.
static int	Button4MotionMask Input Event Masks.
static int	Button5 button names.
static int	Button5Mask button masks.
static int	Button5MotionMask ButtonMotionMask Input Event Masks.
static int	ButtonPress Event names.
static int	ButtonPressMask Input Event Masks.
static int	ButtonRelease Event names.
static int	ButtonReleaseMask Input Event Masks.
static int	CapButt CapNotLast CapProjecting CapRound capStyle
static int	CirculateNotify CirculateRequest ClientMessage Event names.
static int	ClipByChildren subwindow mode
static int	ColormapChangeMask Input Event Masks.
static int	ColormapInstalled Color Map notification
static int	ColormapNotify Event names.
static int	ColormapUninstalled Color Map notification
static int	Complex Polygon shapes
static int	ConfigureNotify ConfigureRequest Event names.
static int	ControlMapIndex modifier names.
static int	ControlMask Key masks.
static int	Convex Polygon shapes
static int	CoordModeOrigin CoordModePrevious CoordinateMode for drawing routines
static int	CopyFromParent RESERVED RESOURCE AND CONSTANT DEFINITIONS
static int	CreateNotify Event names.
static int	CurrentTime RESERVED RESOURCE AND CONSTANT DEFINITIONS
static int	CWBackingPixel CWBackingPlanes CWBackingStore CWBackPixel CWBackPixmap CWBitGravity CWBorderPixel CWBorderPixmap CWColormap CWCursor CWDontPropagate CWEventMask CWOverrideRedirect CWSaveUnder CWWinGravity Window attributes for CreateWindow and ChangeWindowAttributes
static int	DefaultBlanking DefaultExposures SCREEN SAVER STUFF
static int	DestroyNotify Event names.
static int	DisableScreenInterval DisableScreenSaver DontAllowExposures DontPreferBlanking SCREEN SAVER STUFF
static int	EnterNotify Event names.
static int	EnterWindowMask Input Event Masks.
static int	EvenOddRule fillRule
static int	Expose Event names.
static int	ExposureMask Input Event Masks.
static int	False Boolean values
static int	FillOpaqueStippled FillSolid FillStippled FillTiled fillStyle
static int	FocusChangeMask Input Event Masks.
static int	FocusIn FocusOut Event names.
static int	GCArcMode GCBackground GCCapStyle GCClipMask GCClipXOrigin GCClipYOrigin GCDashList GCDashOffset GCFillRule GCFillStyle GCFont GCForeground GCFunction GCGraphicsExposures GCJoinStyle GCLastBit GCLineStyle GCLineWidth GCPlaneMask GCStipple GCSubwindowMode GCTile GCTileStipXOrigin GCTileStipYOrigin GC components: masks used in CreateGC, CopyGC, ChangeGC, OR'ed into GC.stateChanges
static int	GenericEvent Event names.
static int	GrabFrozen GrabInvalidTime GrabPointer, GrabKeyboard reply status
static int	GrabModeAsync GrabModeSync GrabPointer, GrabButton, GrabKeyboard, GrabKey Modes
static int	GrabNotViewable GrabSuccess GrabPointer, GrabKeyboard reply status
static int	GraphicsExpose GravityNotify Event names.
static int	GXand GXandInverted GXandReverse GXclear GXcopy GXcopyInverted GXequiv GXinvert GXnand GXnoop GXnor GXor GXorInverted GXorReverse GXset GXxor graphics functions, as in GC.alu
static int	IncludeInferiors subwindow mode
static int	InputFocus RESERVED RESOURCE AND CONSTANT DEFINITIONS
static int	InputOnly InputOutput Window classes used by X11.XCreateWindow(long, long, int, int, int, int, int, int, int, org.lwjgl.system.linux.Visual, long, org.lwjgl.system.linux.XSetWindowAttributes).
static int	JoinBevel JoinMiter JoinRound joinStyle
static int	KeymapNotify Event names.
static int	KeymapStateMask Input Event Masks.
static int	KeyPress Event names.
static int	KeyPressMask Input Event Masks.
static int	KeyRelease Event names.
static int	KeyReleaseMask Input Event Masks.
static int	LASTEvent LeaveNotify Event names.
static int	LeaveWindowMask Input Event Masks.
static int	LineDoubleDash LineOnOffDash LineSolid LineStyle
static int	LockMapIndex modifier names.
static int	LockMask Key masks.
static int	MapNotify MappingNotify MapRequest Event names.
static int	Mod1MapIndex modifier names.
static int	Mod1Mask Key masks.
static int	Mod2MapIndex modifier names.
static int	Mod2Mask Key masks.
static int	Mod3MapIndex modifier names.
static int	Mod3Mask Key masks.
static int	Mod4MapIndex modifier names.
static int	Mod4Mask Key masks.
static int	Mod5MapIndex modifier names.
static int	Mod5Mask Key masks.
static int	MotionNotify Event names.
static int	NoEventMask Input Event Masks.
static int	NoExpose Event names.
static int	Nonconvex Polygon shapes
static int	None NoSymbol RESERVED RESOURCE AND CONSTANT DEFINITIONS
static int	NotifyAncestor NotifyDetailNone Notify detail
static int	NotifyGrab NotifyHint Notify modes
static int	NotifyInferior NotifyNonlinear NotifyNonlinearVirtual Notify detail
static int	NotifyNormal Notify modes
static int	NotifyPointer NotifyPointerRoot Notify detail
static int	NotifyUngrab Notify modes
static int	NotifyVirtual Notify detail
static int	NotifyWhileGrabbed Notify modes
static int	OwnerGrabButtonMask Input Event Masks.
static int	ParentRelative RESERVED RESOURCE AND CONSTANT DEFINITIONS
static int	PlaceOnBottom PlaceOnTop Circulation request
static int	PointerMotionHintMask PointerMotionMask Input Event Masks.
static int	PointerRoot PointerWindow RESERVED RESOURCE AND CONSTANT DEFINITIONS
static int	PreferBlanking SCREEN SAVER STUFF
static int	PropertyChangeMask Input Event Masks.
static int	PropertyDelete PropertyNewValue Property notification
static int	PropertyNotify Event names.
static int	PropModeAppend PropModePrepend PropModeReplace Property modes
static int	ReparentNotify Event names.
static int	ReplayKeyboard ReplayPointer AllowEvents modes
static int	ResizeRedirectMask Input Event Masks.
static int	ResizeRequest Event names.
static int	RevertToNone RevertToParent RevertToPointerRoot Used in XSetInputFocus(), XGetInputFocus().
static int	ScreenSaverActive ScreenSaverReset SCREEN SAVER STUFF
static int	SelectionClear SelectionNotify SelectionRequest Event names.
static int	ShiftMapIndex modifier names.
static int	ShiftMask Key masks.
static int	StructureNotifyMask SubstructureNotifyMask SubstructureRedirectMask Input Event Masks.
static int	Success ERROR CODES
static int	SyncBoth SyncKeyboard SyncPointer AllowEvents modes
static int	True Boolean values
static int	UnmapNotify Event names.
static int	Unsorted SetClipRectangles ordering
static int	VisibilityChangeMask Input Event Masks.
static int	VisibilityFullyObscured Visibility notify
static int	VisibilityNotify Event names.
static int	VisibilityPartiallyObscured VisibilityUnobscured Visibility notify
static int	WindingRule fillRule
static int	YSorted YXBanded YXSorted SetClipRectangles ordering

Method Summary

Modifier and Type	Method and Description
static SharedLibrary	getLibrary() Returns the X11 SharedLibrary.
static void	XCloseDisplay(long display) Closes the connection to the X server for the display specified in the Display structure and destroys all windows, resource IDs (Window, Font, Pixmap, Colormap, Cursor, and GContext), or other resources that the client has created on this display, unless the close-down mode of the resource has been changed (see XSetCloseDownMode()).
static long	XCreateColormap(long display, long w, Visual visual, int alloc) Creates a colormap of the specified visual type for the screen on which the specified window resides and returns the colormap ID associated with it.
static long	XCreateWindow(long display, long parent, int x, int y, int width, int height, int border_width, int depth, int windowClass, Visual visual, long valuemask, XSetWindowAttributes attributes) Creates an unmapped subwindow for a specified parent window, returns the window ID of the created window, and causes the X server to generate a CreateNotify event.
static int	XDefaultScreen(long display) Returns a pointer to the default screen.
static int	XDestroyWindow(long display, long w) Destroys the specified window as well as all of its subwindows and causes the X server to generate a DestroyNotify event for each window.
static int	XFree(java.nio.ByteBuffer data) Free in-memory data that was created by an Xlib function.
static int	XFree(PointerBuffer data) Free in-memory data that was created by an Xlib function.
static int	XFreeColormap(long display, long colormap) Deletes the association between the colormap resource ID and the colormap and frees the colormap storage.
static long	XOpenDisplay(java.nio.ByteBuffer display_name) Returns a Display structure that serves as the connection to the X server and that contains all the information about that X server.
static long	XOpenDisplay(java.lang.CharSequence display_name) Returns a Display structure that serves as the connection to the X server and that contains all the information about that X server.
static long	XRootWindow(long display, int screen_number) Returns the root window of the specified screen.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

True, False

Boolean values

None, ParentRelative, CopyFromParent, PointerWindow, InputFocus, PointerRoot, AnyPropertyType, AnyKey, AnyButton, AllTemporary, CurrentTime, NoSymbol

RESERVED RESOURCE AND CONSTANT DEFINITIONS

Success, BadRequest, BadValue, BadWindow, BadPixmap, BadAtom, BadCursor, BadFont, BadMatch, BadDrawable, BadAccess, BadAlloc, BadColor, BadGC, BadIDChoice, BadName, BadLength, BadImplementation

ERROR CODES

CWBackPixmap, CWBackPixel, CWBorderPixmap, CWBorderPixel, CWBitGravity, CWWinGravity, CWBackingStore, CWBackingPlanes, CWBackingPixel, CWOverrideRedirect, CWSaveUnder, CWEventMask, CWDontPropagate, CWColormap, CWCursor

Window attributes for CreateWindow and ChangeWindowAttributes

NoEventMask, KeyPressMask, KeyReleaseMask, ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask, PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask, Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask, KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask, ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask, FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask

Input Event Masks. Used as event-mask window attribute and as arguments to Grab requests. Not to be confused with event names.

KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify, EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose, GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify, UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify, ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify, CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, SelectionNotify, ColormapNotify, ClientMessage, MappingNotify, GenericEvent, LASTEvent

Event names. Used in "type" field in XEvent structures. Not to be confused with event masks above. They start from 2 because 0 and 1 are reserved in the protocol for errors and replies.

ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, Mod3Mask, Mod4Mask, Mod5Mask

Key masks. Used as modifiers to GrabButton and GrabKey, results of QueryPointer, state in various key-, mouse-, and button-related events.

ShiftMapIndex, LockMapIndex, ControlMapIndex, Mod1MapIndex, Mod2MapIndex, Mod3MapIndex, Mod4MapIndex, Mod5MapIndex

modifier names. Used to build a SetModifierMapping request or to read a GetModifierMapping request. These correspond to the masks defined above.

Button1Mask, Button2Mask, Button3Mask, Button4Mask, Button5Mask, AnyModifier

button masks. Used in same manner as Key masks above. Not to be confused with button names below.

Button1, Button2, Button3, Button4, Button5

button names. Used as arguments to GrabButton and as detail in ButtonPress and ButtonRelease events. Not to be confused with button masks above. Note that 0 is already defined above as "AnyButton".

NotifyNormal, NotifyGrab, NotifyUngrab, NotifyWhileGrabbed, NotifyHint

Notify modes

NotifyAncestor, NotifyVirtual, NotifyInferior, NotifyNonlinear, NotifyNonlinearVirtual, NotifyPointer, NotifyPointerRoot, NotifyDetailNone

Notify detail

VisibilityUnobscured, VisibilityPartiallyObscured, VisibilityFullyObscured

Visibility notify

PlaceOnTop, PlaceOnBottom

Circulation request

PropertyNewValue, PropertyDelete

Property notification

ColormapUninstalled, ColormapInstalled

Color Map notification

GrabModeSync, GrabModeAsync

GrabPointer, GrabButton, GrabKeyboard, GrabKey Modes

GrabSuccess, AlreadyGrabbed, GrabInvalidTime, GrabNotViewable, GrabFrozen

GrabPointer, GrabKeyboard reply status

AsyncPointer, SyncPointer, ReplayPointer, AsyncKeyboard, SyncKeyboard, ReplayKeyboard, AsyncBoth, SyncBoth

AllowEvents modes

AllocNone, AllocAll

For X11.XCreateColormap(long, long, org.lwjgl.system.linux.Visual, int).

RevertToNone, RevertToPointerRoot, RevertToParent

Used in XSetInputFocus(), XGetInputFocus().

InputOutput, InputOnly

Window classes used by X11.XCreateWindow(long, long, int, int, int, int, int, int, int, org.lwjgl.system.linux.Visual, long, org.lwjgl.system.linux.XSetWindowAttributes).

DontPreferBlanking, PreferBlanking, DefaultBlanking, DisableScreenSaver, DisableScreenInterval, DontAllowExposures, AllowExposures, DefaultExposures, ScreenSaverReset, ScreenSaverActive

SCREEN SAVER STUFF

PropModeReplace, PropModePrepend, PropModeAppend

Property modes

GXclear, GXand, GXandReverse, GXcopy, GXandInverted, GXnoop, GXxor, GXor, GXnor, GXequiv, GXinvert, GXorReverse, GXcopyInverted, GXorInverted, GXnand, GXset

graphics functions, as in GC.alu

LineSolid, LineOnOffDash, LineDoubleDash

LineStyle

CapNotLast, CapButt, CapRound, CapProjecting

capStyle

JoinMiter, JoinRound, JoinBevel

joinStyle

FillSolid, FillTiled, FillStippled, FillOpaqueStippled

fillStyle

EvenOddRule, WindingRule

fillRule

ClipByChildren, IncludeInferiors

subwindow mode

Unsorted, YSorted, YXSorted, YXBanded

SetClipRectangles ordering

CoordModeOrigin, CoordModePrevious

CoordinateMode for drawing routines

Complex, Nonconvex, Convex

Polygon shapes

ArcChord, ArcPieSlice

Arc modes for PolyFillArc

GCFunction, GCPlaneMask, GCForeground, GCBackground, GCLineWidth, GCLineStyle, GCCapStyle, GCJoinStyle, GCFillStyle, GCFillRule, GCTile, GCStipple, GCTileStipXOrigin, GCTileStipYOrigin, GCFont, GCSubwindowMode, GCGraphicsExposures, GCClipXOrigin, GCClipYOrigin, GCClipMask, GCDashOffset, GCDashList, GCArcMode, GCLastBit

GC components: masks used in CreateGC, CopyGC, ChangeGC, OR'ed into GC.stateChanges

Method Detail

getLibrary

public static SharedLibrary getLibrary()

Returns the X11 SharedLibrary.

XOpenDisplay

public static long XOpenDisplay(java.nio.ByteBuffer display_name)

public static long XOpenDisplay(java.lang.CharSequence display_name)

Returns a Display structure that serves as the connection to the X server and that contains all the information about that X server. XOpenDisplay connects your application to the X server through TCP or DECnet communications protocols, or through some local inter-process communication protocol. If the hostname is a host machine name and a single colon (:) separates the hostname and display number, XOpenDisplay connects using TCP streams. If the hostname is not specified, Xlib uses whatever it believes is the fastest transport. If the hostname is a host machine name and a double colon (::) separates the hostname and display number, XOpenDisplay connects using DECnet. A single X server can support any or all of these transport mechanisms simultaneously. A particular Xlib implementation can support many more of these transport mechanisms.

Parameters:

display_name - the hardware display name, which determines the display and communications domain to be used. On a POSIX-conformant system, if the display_name is NULL, it defaults to the value of the DISPLAY environment variable.

XCloseDisplay

public static void XCloseDisplay(long display)

Closes the connection to the X server for the display specified in the Display structure and destroys all windows, resource IDs (Window, Font, Pixmap, Colormap, Cursor, and GContext), or other resources that the client has created on this display, unless the close-down mode of the resource has been changed (see XSetCloseDownMode()). Therefore, these windows, resource IDs, and other resources should never be referenced again or an error will be generated. Before exiting, you should call XCloseDisplay() explicitly so that any pending errors are reported as XCloseDisplay() performs a final XSync() operation.

Parameters:

display - the connection to the X server

XDefaultScreen

public static int XDefaultScreen(long display)

Returns a pointer to the default screen.

Parameters:

display - the connection to the X server

XRootWindow

public static long XRootWindow(long display,
                               int screen_number)

Returns the root window of the specified screen.

Parameters:

display - the connection to the X server

screen_number - the appropriate screen number on the host server

XCreateColormap

public static long XCreateColormap(long display,
                                   long w,
                                   Visual visual,
                                   int alloc)

Creates a colormap of the specified visual type for the screen on which the specified window resides and returns the colormap ID associated with it. Note that the specified window is only used to determine the screen.

Parameters:

display - the connection to the X server

w - the window

visual - a visual type supported on the screen. If the visual type is not one supported by the screen, a BadMatch error results.

alloc - the colormap entries to be allocated. You can pass AllocNone or AllocAll.

XFreeColormap

public static int XFreeColormap(long display,
                                long colormap)

Deletes the association between the colormap resource ID and the colormap and frees the colormap storage. However, this function has no effect on the default colormap for a screen. If the specified colormap is an installed map for a screen, it is uninstalled. If the specified colormap is defined as the colormap for a window, XFreeColormap() changes the colormap associated with the window to X11.None and generates a ColormapNotify event. X does not define the colors displayed for a window with a colormap of X11.None.

Parameters:

display - the connection to the X server

colormap - the colormap to destroy

XCreateWindow

public static long XCreateWindow(long display,
                                 long parent,
                                 int x,
                                 int y,
                                 int width,
                                 int height,
                                 int border_width,
                                 int depth,
                                 int windowClass,
                                 Visual visual,
                                 long valuemask,
                                 XSetWindowAttributes attributes)

Creates an unmapped subwindow for a specified parent window, returns the window ID of the created window, and causes the X server to generate a CreateNotify event. The created 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 integral, 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 x and y coordinates are the top-left outside corner of the window's borders and are relative to the inside of the parent window's borders.

The width and height are the created window's inside dimensions and do not include the created window's borders.

Parameters:

display - the connection to the X server

parent - the parent window

x - the window x-coordinate

y - the window y-coordinate

width - the window width

height - the window height

border_width - the border width

depth - the window's depth. A depth of X11.CopyFromParent means the depth is taken from the parent.

windowClass - the created window's class. One of:

X11.InputOutput

X11.InputOnly

X11.CopyFromParent

visual - the visual type. A visual of X11.CopyFromParent means the visual type is taken from the parent.

valuemask - which window attributes are defined in the attributes argument. This mask is the bitwise inclusive OR of the valid attribute mask bits. If valuemask is zero, the attributes are ignored and are not referenced.

attributes - the structure from which the values (as specified by the value mask) are to be taken

XDestroyWindow

public static int XDestroyWindow(long display,
                                 long w)

Destroys the specified window as well as all of its subwindows and causes the X server to generate a DestroyNotify event for each window. The window should never be referenced again. If the window specified by the w argument is mapped, it is unmapped automatically. The ordering of the DestroyNotify events is such that for any given window being destroyed, DestroyNotify is generated on any inferiors of the window before being generated on the window itself. The ordering among siblings and across subhierarchies is not otherwise constrained. If the window you specified is a root window, no windows are destroyed. Destroying a mapped window will generate Expose events on other windows that were obscured by the window being destroyed.

Parameters:

display - the connection to the X server

w - the window

XFree

public static int XFree(java.nio.ByteBuffer data)

public static int XFree(PointerBuffer data)

Free in-memory data that was created by an Xlib function.

Parameters:

data - the data that is to be freed