Package org.lwjgl.system.linux

Class XGenericEventCookie

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<XGenericEventCookie>
org.lwjgl.system.linux.XGenericEventCookie
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class XGenericEventCookie extends org.lwjgl.system.Struct<XGenericEventCookie> implements org.lwjgl.system.NativeResource
Additional information for an XGenericEvent.

Layout


 struct XGenericEventCookie {
     int type();
     unsigned long serial();
     Bool send_event();
     Display * display();
     int extension();
     int evtype();
     unsigned int cookie;
     void * data;
 }

  • Field Details

    • 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.

    • EXTENSION

      public static final int EXTENSION
      The struct member offsets.

    • EVTYPE

      public static final int EVTYPE
      The struct member offsets.

    • DATA

      public static final int DATA
      The struct member offsets.

  • Constructor Details

    • XGenericEventCookie

      public XGenericEventCookie(ByteBuffer container)
      Creates a XGenericEventCookie 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 Details

    • sizeof

      public int sizeof()
      Specified by:
      sizeof in class org.lwjgl.system.Struct<XGenericEventCookie>

    • type

      public int type()
      of event. Must be:
      X11.GenericEvent

    • serial

      public long serial()
      # of last request processed by server

    • send_event

      public boolean send_event()
      true if this came from an X11.XSendEvent(long, long, boolean, long, org.lwjgl.system.linux.XEvent) request

    • display

      public long display()
      Display the event was read from

    • extension

      public int extension()
      major opcode of extension that caused the event

    • evtype

      public int evtype()
      actual event type

    • cookie

      public int cookie()
      Returns:
      the value of the cookie field.

    • data

      public ByteBuffer data(int capacity)
      Parameters:
      capacity - the number of elements in the returned buffer
      Returns:
      a ByteBuffer view of the data pointed to by the data field.

    • type

      public XGenericEventCookie type(int value)
      Sets the specified value to the type() field.

    • serial

      public XGenericEventCookie serial(long value)
      Sets the specified value to the serial() field.

    • send_event

      public XGenericEventCookie send_event(boolean value)
      Sets the specified value to the send_event() field.

    • display

      public XGenericEventCookie display(long value)
      Sets the specified value to the display() field.

    • extension

      public XGenericEventCookie extension(int value)
      Sets the specified value to the extension() field.

    • evtype

      public XGenericEventCookie evtype(int value)
      Sets the specified value to the evtype() field.

    • cookie

      public XGenericEventCookie cookie(int value)
      Sets the specified value to the cookie field.

    • data

      public XGenericEventCookie data(ByteBuffer value)
      Sets the address of the specified ByteBuffer to the data field.

    • set

      public XGenericEventCookie set(int type, long serial, boolean send_event, long display, int extension, int evtype, int cookie, ByteBuffer data)
      Initializes this struct with the specified values.

    • set

      public XGenericEventCookie set(XGenericEventCookie src)
      Copies the specified struct data to this struct.
      Parameters:
      src - the source struct
      Returns:
      this struct

    • malloc

      public static XGenericEventCookie malloc()
      Returns a new XGenericEventCookie instance allocated with memAlloc. The instance must be explicitly freed.

    • calloc

      public static XGenericEventCookie calloc()
      Returns a new XGenericEventCookie instance allocated with memCalloc. The instance must be explicitly freed.

    • create

      public static XGenericEventCookie create()
      Returns a new XGenericEventCookie instance allocated with BufferUtils.

    • create

      public static XGenericEventCookie create(long address)
      Returns a new XGenericEventCookie instance for the specified memory address.

    • createSafe

      @Nullable public static XGenericEventCookie createSafe(long address)
      Like create, but returns null if address is NULL.

    • malloc

      public static XGenericEventCookie.Buffer malloc(int capacity)
      Returns a new XGenericEventCookie.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
      Parameters:
      capacity - the buffer capacity

    • calloc

      public static XGenericEventCookie.Buffer calloc(int capacity)
      Returns a new XGenericEventCookie.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
      Parameters:
      capacity - the buffer capacity

    • create

      public static XGenericEventCookie.Buffer create(int capacity)
      Returns a new XGenericEventCookie.Buffer instance allocated with BufferUtils.
      Parameters:
      capacity - the buffer capacity

    • create

      public static XGenericEventCookie.Buffer create(long address, int capacity)
      Create a XGenericEventCookie.Buffer instance at the specified memory.
      Parameters:
      address - the memory address
      capacity - the buffer capacity

    • createSafe

      @Nullable public static XGenericEventCookie.Buffer createSafe(long address, int capacity)
      Like create, but returns null if address is NULL.

    • mallocStack

      @Deprecated public static XGenericEventCookie mallocStack()
      Deprecated.
      Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

    • callocStack

      @Deprecated public static XGenericEventCookie callocStack()
      Deprecated.
      Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

    • mallocStack

      @Deprecated public static XGenericEventCookie mallocStack(org.lwjgl.system.MemoryStack stack)
      Deprecated.
      Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

    • callocStack

      @Deprecated public static XGenericEventCookie callocStack(org.lwjgl.system.MemoryStack stack)
      Deprecated.
      Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

    • mallocStack

      @Deprecated public static XGenericEventCookie.Buffer mallocStack(int capacity)
      Deprecated.
      Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

    • callocStack

      @Deprecated public static XGenericEventCookie.Buffer callocStack(int capacity)
      Deprecated.
      Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

    • mallocStack

      @Deprecated public static XGenericEventCookie.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
      Deprecated.
      Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

    • callocStack

      @Deprecated public static XGenericEventCookie.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
      Deprecated.
      Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

    • malloc

      public static XGenericEventCookie malloc(org.lwjgl.system.MemoryStack stack)
      Returns a new XGenericEventCookie instance allocated on the specified MemoryStack.
      Parameters:
      stack - the stack from which to allocate

    • calloc

      public static XGenericEventCookie calloc(org.lwjgl.system.MemoryStack stack)
      Returns a new XGenericEventCookie instance allocated on the specified MemoryStack and initializes all its bits to zero.
      Parameters:
      stack - the stack from which to allocate

    • malloc

      public static XGenericEventCookie.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
      Returns a new XGenericEventCookie.Buffer instance allocated on the specified MemoryStack.
      Parameters:
      capacity - the buffer capacity
      stack - the stack from which to allocate

    • calloc

      public static XGenericEventCookie.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
      Returns a new XGenericEventCookie.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
      Parameters:
      capacity - the buffer capacity
      stack - the stack from which to allocate

    • 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().

    • nextension

      public static int nextension(long struct)
      Unsafe version of extension().

    • nevtype

      public static int nevtype(long struct)
      Unsafe version of evtype().

    • ncookie

      public static int ncookie(long struct)
      Unsafe version of cookie().

    • ndata

      public static ByteBuffer ndata(long struct, int capacity)
      Unsafe version of data.

    • 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.

    • nextension

      public static void nextension(long struct, int value)
      Unsafe version of extension.

    • nevtype

      public static void nevtype(long struct, int value)
      Unsafe version of evtype.

    • ncookie

      public static void ncookie(long struct, int value)
      Unsafe version of cookie.

    • ndata

      public static void ndata(long struct, ByteBuffer value)
      Unsafe version of data.

    • validate

      public static void validate(long struct)
      Validates pointer members that should not be NULL.
      Parameters:
      struct - the struct to validate