Class CXCursor

All Implemented Interfaces:
AutoCloseable, NativeResource, Pointer

public class CXCursor extends Struct<CXCursor> implements NativeResource

 struct CXCursor {
     enum CXCursorKind kind;
     int xdata;
     void const * data[3];
 }
  • Field Details

    • SIZEOF

      public static final int SIZEOF
      The struct size in bytes.
    • ALIGNOF

      public static final int ALIGNOF
      The struct alignment in bytes.
    • KIND

      public static final int KIND
      The struct member offsets.
    • XDATA

      public static final int XDATA
      The struct member offsets.
    • DATA

      public static final int DATA
      The struct member offsets.
  • Constructor Details

    • CXCursor

      public CXCursor(ByteBuffer container)
      Creates a CXCursor 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()
      Description copied from class: Struct
      Returns sizeof(struct).
      Specified by:
      sizeof in class Struct<CXCursor>
    • kind

      public int kind()
      Returns:
      the value of the kind field.
    • xdata

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

      public PointerBuffer data()
      Returns:
      a PointerBuffer view of the data field.
    • data

      public long data(int index)
      Returns:
      the value at the specified index of the data field.
    • malloc

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

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

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

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

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

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

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

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

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

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

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

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

      @Deprecated public static CXCursor mallocStack(MemoryStack stack)
      Deprecated.
      Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.
    • callocStack

      @Deprecated public static CXCursor callocStack(MemoryStack stack)
      Deprecated.
      Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.
    • mallocStack

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

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

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

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

      public static CXCursor malloc(MemoryStack stack)
      Returns a new CXCursor instance allocated on the specified MemoryStack.
      Parameters:
      stack - the stack from which to allocate
    • calloc

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

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

      public static CXCursor.Buffer calloc(int capacity, MemoryStack stack)
      Returns a new CXCursor.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
    • nkind

      public static int nkind(long struct)
      Unsafe version of kind().
    • nxdata

      public static int nxdata(long struct)
      Unsafe version of xdata().
    • ndata

      public static PointerBuffer ndata(long struct)
      Unsafe version of data().
    • ndata

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