Class XGenericEventCookie

  • All Implemented Interfaces:
    java.lang.AutoCloseable, NativeResource, Pointer

    public class XGenericEventCookie
    extends Struct
    implements NativeResource
    Additional information for an XGenericEvent.

    Member documentation

    Layout

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

      • SIZEOF

        The struct size in bytes.
      • ALIGNOF

        The struct alignment in bytes.
      • TYPE, SERIAL, SEND_EVENT, DISPLAY, EXTENSION, EVTYPE, COOKIE, DATA

        The struct member offsets.
    • Constructor Detail

      • XGenericEventCookie

        public XGenericEventCookie​(java.nio.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 Detail

      • sizeof

        public int sizeof()
        Description copied from class: Struct
        Returns sizeof(struct).
        Specified by:
        sizeof in class 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.
      • extension

        public int extension()
        Returns the value of the extension field.
      • evtype

        public int evtype()
        Returns the value of the evtype field.
      • cookie

        public int cookie()
        Returns the value of the cookie field.
      • data

        public java.nio.ByteBuffer data​(int capacity)
        Returns a ByteBuffer view of the data pointed to by the data field.
        Parameters:
        capacity - the number of elements in the returned buffer
      • 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​(java.nio.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,
                                       java.nio.ByteBuffer data)
        Initializes this struct with the specified values.
      • 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​(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.
      • callocStack

        public static XGenericEventCookie callocStack()
        Returns a new XGenericEventCookie instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
      • mallocStack

        public static XGenericEventCookie mallocStack​(MemoryStack stack)
        Returns a new XGenericEventCookie instance allocated on the specified MemoryStack.
        Parameters:
        stack - the stack from which to allocate
      • callocStack

        public static XGenericEventCookie callocStack​(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
      • 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 java.nio.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,
                                 java.nio.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
      • 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