Class AIFileIO

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

    public class AIFileIO
    extends Struct
    implements NativeResource
    Provided are functions to open and close files. Supply a custom structure to the import function. If you don't, a default implementation is used. Use custom file systems to enable reading from other sources, such as ZIPs or memory locations.

    Member documentation

    • OpenProc – Function used to open a new file
    • CloseProc – Function used to close an existing file
    • UserData – User-defined, opaque data

    Layout

    
     struct aiFileIO {
         aiFileOpenProc OpenProc;
         aiFileCloseProc CloseProc;
         aiUserData UserData;
     }
    • Field Detail

      • SIZEOF

        The struct size in bytes.
      • ALIGNOF

        The struct alignment in bytes.
      • OPENPROC, CLOSEPROC, USERDATA

        The struct member offsets.
    • Constructor Detail

      • AIFileIO

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

      • sizeof

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

        public AIFileIO UserData​(long value)
        Sets the specified value to the UserData field.
      • 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​(long address)
        Returns a new AIFileIO instance for the specified memory address.
      • createSafe

        @Nullable
        public static 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​(long address,
                                             int capacity)
        Create a AIFileIO.Buffer instance at the specified memory.
        Parameters:
        address - the memory address
        capacity - the buffer capacity
      • createSafe

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

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

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

        public static AIFileIO callocStack​(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
      • callocStack

        public static AIFileIO.Buffer callocStack​(int capacity)
        Returns a new AIFileIO.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
        Parameters:
        capacity - the buffer capacity
      • callocStack

        public static AIFileIO.Buffer callocStack​(int capacity,
                                                  MemoryStack stack)
        Returns a new AIFileIO.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
        Parameters:
        stack - the stack from which to allocate
        capacity - the buffer capacity
      • nUserData

        public static long nUserData​(long struct)
        Unsafe version of UserData().
      • 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
      • 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