XCirculateEvent (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.system.linux.XCirculateEvent

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class XCirculateEvent
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Member documentation
- serial – # of last request processed by server
- send_event – true if this came from an X11.XSendEvent(long, long, boolean, long, org.lwjgl.system.linux.XEvent) request
- display – Display the event was read from
- place – one of:
  X11.PlaceOnTop X11.PlaceOnBottom
Layout
```
 struct XCirculateEvent {
     int type;
     unsigned long serial;
     Bool send_event;
     Display * display;
     Window event;
     Window window;
     int place;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class XCirculateEvent.Buffer
An array of XCirculateEvent structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default

Nested Classes
Modifier and Type	Class and Description
`static class`	`XCirculateEvent.Buffer` An array of `XCirculateEvent` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`DISPLAY` The struct member offsets.
`static int`	`EVENT` The struct member offsets.
`static int`	`PLACE` The struct member offsets.
`static int`	`SEND_EVENT` The struct member offsets.
`static int`	`SERIAL` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`TYPE` The struct member offsets.
`static int`	`WINDOW` The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor and Description

XCirculateEvent(java.nio.ByteBuffer container)
Creates a XCirculateEvent instance at the current position of the specified ByteBuffer container.

Constructors
Constructor and Description
`XCirculateEvent(java.nio.ByteBuffer container)` Creates a `XCirculateEvent` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static XCirculateEvent`	`calloc()` Returns a new `XCirculateEvent` instance allocated with `memCalloc`.
`static XCirculateEvent.Buffer`	`calloc(int capacity)` Returns a new `XCirculateEvent.Buffer` instance allocated with `memCalloc`.
`static XCirculateEvent`	`callocStack()` Returns a new `XCirculateEvent` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static XCirculateEvent.Buffer`	`callocStack(int capacity)` Returns a new `XCirculateEvent.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static XCirculateEvent.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `XCirculateEvent.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static XCirculateEvent`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `XCirculateEvent` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static XCirculateEvent`	`create()` Returns a new `XCirculateEvent` instance allocated with `BufferUtils`.
`static XCirculateEvent.Buffer`	`create(int capacity)` Returns a new `XCirculateEvent.Buffer` instance allocated with `BufferUtils`.
`static XCirculateEvent`	`create(long address)` Returns a new `XCirculateEvent` instance for the specified memory address.
`static XCirculateEvent.Buffer`	`create(long address, int capacity)` Create a `XCirculateEvent.Buffer` instance at the specified memory.
`static XCirculateEvent`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static XCirculateEvent.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`long`	`display()` Returns the value of the `display` field.
`XCirculateEvent`	`display(long value)` Sets the specified value to the `display` field.
`long`	`event()` Returns the value of the `event` field.
`XCirculateEvent`	`event(long value)` Sets the specified value to the `event` field.
`static XCirculateEvent`	`malloc()` Returns a new `XCirculateEvent` instance allocated with `memAlloc`.
`static XCirculateEvent.Buffer`	`malloc(int capacity)` Returns a new `XCirculateEvent.Buffer` instance allocated with `memAlloc`.
`static XCirculateEvent`	`mallocStack()` Returns a new `XCirculateEvent` instance allocated on the thread-local `MemoryStack`.
`static XCirculateEvent.Buffer`	`mallocStack(int capacity)` Returns a new `XCirculateEvent.Buffer` instance allocated on the thread-local `MemoryStack`.
`static XCirculateEvent.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `XCirculateEvent.Buffer` instance allocated on the specified `MemoryStack`.
`static XCirculateEvent`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `XCirculateEvent` instance allocated on the specified `MemoryStack`.
`static long`	`ndisplay(long struct)` Unsafe version of `display()`.
`static void`	`ndisplay(long struct, long value)` Unsafe version of `display`.
`static long`	`nevent(long struct)` Unsafe version of `event()`.
`static void`	`nevent(long struct, long value)` Unsafe version of `event`.
`static int`	`nplace(long struct)` Unsafe version of `place()`.
`static void`	`nplace(long struct, int value)` Unsafe version of `place`.
`static int`	`nsend_event(long struct)` Unsafe version of `send_event()`.
`static void`	`nsend_event(long struct, int value)` Unsafe version of `send_event`.
`static long`	`nserial(long struct)` Unsafe version of `serial()`.
`static void`	`nserial(long struct, long value)` Unsafe version of `serial`.
`static int`	`ntype(long struct)` Unsafe version of `type()`.
`static void`	`ntype(long struct, int value)` Unsafe version of `type`.
`static long`	`nwindow(long struct)` Unsafe version of `window()`.
`static void`	`nwindow(long struct, long value)` Unsafe version of `window`.
`int`	`place()` Returns the value of the `place` field.
`XCirculateEvent`	`place(int value)` Sets the specified value to the `place` field.
`boolean`	`send_event()` Returns the value of the `send_event` field.
`XCirculateEvent`	`send_event(boolean value)` Sets the specified value to the `send_event` field.
`long`	`serial()` Returns the value of the `serial` field.
`XCirculateEvent`	`serial(long value)` Sets the specified value to the `serial` field.
`XCirculateEvent`	`set(int type, long serial, boolean send_event, long display, long event, long window, int place)` Initializes this struct with the specified values.
`XCirculateEvent`	`set(XCirculateEvent src)` Copies the specified struct data to this struct.
`int`	`sizeof()`
`int`	`type()` Returns the value of the `type` field.
`XCirculateEvent`	`type(int value)` Sets the specified value to the `type` field.
`static void`	`validate(long struct)` Validates pointer members that should not be `NULL`.
`static void`	`validate(long array, int count)` Calls `validate(long)` for each struct contained in the specified struct array.
`long`	`window()` Returns the value of the `window` field.
`XCirculateEvent`	`window(long value)` Sets the specified value to the `window` field.

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull

Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource
close, free

- Field Detail
  - SIZEOF
```
public static final int SIZEOF
```
    The struct size in bytes.
  - ALIGNOF
```
public static final int ALIGNOF
```
    The struct alignment in bytes.
  - TYPE
```
public static final int TYPE
```
    The struct member offsets.
  - SERIAL
```
public static final int SERIAL
```
    The struct member offsets.
  - SEND_EVENT
```
public static final int SEND_EVENT
```
    The struct member offsets.
  - DISPLAY
```
public static final int DISPLAY
```
    The struct member offsets.
  - EVENT
```
public static final int EVENT
```
    The struct member offsets.
  - WINDOW
```
public static final int WINDOW
```
    The struct member offsets.
  - PLACE
```
public static final int PLACE
```
    The struct member offsets.
- Constructor Detail
  - XCirculateEvent
```
public XCirculateEvent(java.nio.ByteBuffer container)
```
    Creates a XCirculateEvent instance at the current position of the specified ByteBuffer container. Changes to the buffer's content will be visible to the struct instance and vice versa.
    The created instance holds a strong reference to the container object.
- Method Detail
  - sizeof
```
public int sizeof()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.Struct
  - type
```
public int type()
```
    Returns the value of the type field.
  - serial
```
public long serial()
```
    Returns the value of the serial field.
  - send_event
```
public boolean send_event()
```
    Returns the value of the send_event field.
  - display
```
public long display()
```
    Returns the value of the display field.
  - event
```
public long event()
```
    Returns the value of the event field.
  - window
```
public long window()
```
    Returns the value of the window field.
  - place
```
public int place()
```
    Returns the value of the place field.
  - type
```
public XCirculateEvent type(int value)
```
    Sets the specified value to the type field.
  - serial
```
public XCirculateEvent serial(long value)
```
    Sets the specified value to the serial field.
  - send_event
```
public XCirculateEvent send_event(boolean value)
```
    Sets the specified value to the send_event field.
  - display
```
public XCirculateEvent display(long value)
```
    Sets the specified value to the display field.
  - event
```
public XCirculateEvent event(long value)
```
    Sets the specified value to the event field.
  - window
```
public XCirculateEvent window(long value)
```
    Sets the specified value to the window field.
  - place
```
public XCirculateEvent place(int value)
```
    Sets the specified value to the place field.
  - set
```
public XCirculateEvent set(int type,
                           long serial,
                           boolean send_event,
                           long display,
                           long event,
                           long window,
                           int place)
```
    Initializes this struct with the specified values.
  - set
```
public XCirculateEvent set(XCirculateEvent src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static XCirculateEvent malloc()
```
    Returns a new XCirculateEvent instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static XCirculateEvent calloc()
```
    Returns a new XCirculateEvent instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static XCirculateEvent create()
```
    Returns a new XCirculateEvent instance allocated with BufferUtils.
  - create
```
public static XCirculateEvent create(long address)
```
    Returns a new XCirculateEvent instance for the specified memory address.
  - createSafe
```
@Nullable
public static XCirculateEvent createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static XCirculateEvent.Buffer malloc(int capacity)
```
    Returns a new XCirculateEvent.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static XCirculateEvent.Buffer calloc(int capacity)
```
    Returns a new XCirculateEvent.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static XCirculateEvent.Buffer create(int capacity)
```
    Returns a new XCirculateEvent.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static XCirculateEvent.Buffer create(long address,
                                            int capacity)
```
    Create a XCirculateEvent.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static XCirculateEvent.Buffer createSafe(long address,
                                                          int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static XCirculateEvent mallocStack()
```
    Returns a new XCirculateEvent instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static XCirculateEvent callocStack()
```
    Returns a new XCirculateEvent instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static XCirculateEvent mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new XCirculateEvent instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static XCirculateEvent callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new XCirculateEvent instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static XCirculateEvent.Buffer mallocStack(int capacity)
```
    Returns a new XCirculateEvent.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static XCirculateEvent.Buffer callocStack(int capacity)
```
    Returns a new XCirculateEvent.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static XCirculateEvent.Buffer mallocStack(int capacity,
                                                 org.lwjgl.system.MemoryStack stack)
```
    Returns a new XCirculateEvent.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static XCirculateEvent.Buffer callocStack(int capacity,
                                                 org.lwjgl.system.MemoryStack stack)
```
    Returns a new XCirculateEvent.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - ntype
```
public static int ntype(long struct)
```
    Unsafe version of type().
  - nserial
```
public static long nserial(long struct)
```
    Unsafe version of serial().
  - nsend_event
```
public static int nsend_event(long struct)
```
    Unsafe version of send_event().
  - ndisplay
```
public static long ndisplay(long struct)
```
    Unsafe version of display().
  - nevent
```
public static long nevent(long struct)
```
    Unsafe version of event().
  - nwindow
```
public static long nwindow(long struct)
```
    Unsafe version of window().
  - nplace
```
public static int nplace(long struct)
```
    Unsafe version of place().
  - ntype
```
public static void ntype(long struct,
                         int value)
```
    Unsafe version of type.
  - nserial
```
public static void nserial(long struct,
                           long value)
```
    Unsafe version of serial.
  - nsend_event
```
public static void nsend_event(long struct,
                               int value)
```
    Unsafe version of send_event.
  - ndisplay
```
public static void ndisplay(long struct,
                            long value)
```
    Unsafe version of display.
  - nevent
```
public static void nevent(long struct,
                          long value)
```
    Unsafe version of event.
  - nwindow
```
public static void nwindow(long struct,
                           long value)
```
    Unsafe version of window.
  - nplace
```
public static void nplace(long struct,
                          int value)
```
    Unsafe version of place.
  - validate
```
public static void validate(long struct)
```
    Validates pointer members that should not be NULL.
    
    Parameters:
    
    struct - the struct to validate
  - validate
```
public static void validate(long array,
                            int count)
```
    Calls validate(long) for each struct contained in the specified struct array.
    
    Parameters:
    
    array - the struct array to validate
    
    count - the number of structs in array

Class XCirculateEvent

Member documentation

Layout

Nested Class Summary

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

ALIGNOF

TYPE

SERIAL

SEND_EVENT

DISPLAY

EVENT

WINDOW

PLACE

Constructor Detail

XCirculateEvent

Method Detail

sizeof

type

serial

send_event

display

event

window

place

type

serial

send_event

display

event

window

place

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

ntype

nserial

nsend_event

ndisplay

nevent

nwindow

nplace

ntype

nserial

nsend_event

ndisplay

nevent

nwindow

nplace

validate

validate