Class CXType

All Implemented Interfaces:
AutoCloseable, NativeResource, Pointer

public class CXType extends Struct<CXType> implements NativeResource

 struct CXType {
     enum CXTypeKind kind;
     void * data[2];
 }
  • 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.
    • DATA

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

    • CXType

      public CXType(ByteBuffer container)
      Creates a CXType 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<CXType>
    • kind

      public int kind()
      Returns:
      the value of the kind 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 CXType malloc()
      Returns a new CXType instance allocated with memAlloc. The instance must be explicitly freed.
    • calloc

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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