Class AIFileIO

All Implemented Interfaces:
AutoCloseable, NativeResource, Pointer

public class AIFileIO extends Struct<AIFileIO> implements NativeResource

 struct aiFileIO {
     {@link AIFileOpenProcI aiFileOpenProc} OpenProc;
     {@link AIFileCloseProcI aiFileCloseProc} CloseProc;
     aiUserData UserData;
 }
  • Field Details

    • SIZEOF

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

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

      public static final int OPENPROC
      The struct member offsets.
    • CLOSEPROC

      public static final int CLOSEPROC
      The struct member offsets.
    • USERDATA

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

    • AIFileIO

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

      public AIFileOpenProc OpenProc()
      Returns:
      the value of the OpenProc field.
    • CloseProc

      public AIFileCloseProc CloseProc()
      Returns:
      the value of the CloseProc field.
    • UserData

      public long UserData()
      Returns:
      the value of the UserData field.
    • OpenProc

      public AIFileIO OpenProc(AIFileOpenProcI value)
      Sets the specified value to the OpenProc field.
    • CloseProc

      public AIFileIO CloseProc(AIFileCloseProcI value)
      Sets the specified value to the CloseProc field.
    • UserData

      public AIFileIO UserData(long value)
      Sets the specified value to the UserData field.
    • set

      public AIFileIO set(AIFileOpenProcI OpenProc, AIFileCloseProcI CloseProc, long UserData)
      Initializes this struct with the specified values.
    • set

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

      public static AIFileOpenProc nOpenProc(long struct)
      Unsafe version of OpenProc().
    • nCloseProc

      public static AIFileCloseProc nCloseProc(long struct)
      Unsafe version of CloseProc().
    • nUserData

      public static long nUserData(long struct)
      Unsafe version of UserData().
    • nOpenProc

      public static void nOpenProc(long struct, AIFileOpenProcI value)
      Unsafe version of OpenProc.
    • nCloseProc

      public static void nCloseProc(long struct, AIFileCloseProcI value)
      Unsafe version of CloseProc.
    • nUserData

      public static void nUserData(long struct, long value)
      Unsafe version of UserData.
    • validate

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