AIFileIO (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.assimp.AIFileIO

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class AIFileIO
extends org.lwjgl.system.Struct
implements org.lwjgl.system.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;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class AIFileIO.Buffer
An array of AIFileIO structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default

Nested Classes
Modifier and Type	Class and Description
`static class`	`AIFileIO.Buffer` An array of `AIFileIO` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`CLOSEPROC` The struct member offsets.
`static int`	`OPENPROC` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`USERDATA` The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor and Description

AIFileIO(java.nio.ByteBuffer container)
Creates a AIFileIO instance at the current position of the specified ByteBuffer container.

Constructors
Constructor and Description
`AIFileIO(java.nio.ByteBuffer container)` Creates a `AIFileIO` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static AIFileIO`	`calloc()` Returns a new `AIFileIO` instance allocated with `memCalloc`.
`static AIFileIO.Buffer`	`calloc(int capacity)` Returns a new `AIFileIO.Buffer` instance allocated with `memCalloc`.
`static AIFileIO`	`callocStack()` Returns a new `AIFileIO` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`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.
`static AIFileIO.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `AIFileIO.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static AIFileIO`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `AIFileIO` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`AIFileCloseProc`	`CloseProc()` Returns the value of the `CloseProc` field.
`AIFileIO`	`CloseProc(AIFileCloseProcI value)` Sets the specified value to the `CloseProc` field.
`static AIFileIO`	`create()` Returns a new `AIFileIO` instance allocated with `BufferUtils`.
`static AIFileIO.Buffer`	`create(int capacity)` Returns a new `AIFileIO.Buffer` instance allocated with `BufferUtils`.
`static AIFileIO`	`create(long address)` Returns a new `AIFileIO` instance for the specified memory address.
`static AIFileIO.Buffer`	`create(long address, int capacity)` Create a `AIFileIO.Buffer` instance at the specified memory.
`static AIFileIO`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static AIFileIO.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`static AIFileIO`	`malloc()` Returns a new `AIFileIO` instance allocated with `memAlloc`.
`static AIFileIO.Buffer`	`malloc(int capacity)` Returns a new `AIFileIO.Buffer` instance allocated with `memAlloc`.
`static AIFileIO`	`mallocStack()` Returns a new `AIFileIO` instance allocated on the thread-local `MemoryStack`.
`static AIFileIO.Buffer`	`mallocStack(int capacity)` Returns a new `AIFileIO.Buffer` instance allocated on the thread-local `MemoryStack`.
`static AIFileIO.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `AIFileIO.Buffer` instance allocated on the specified `MemoryStack`.
`static AIFileIO`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `AIFileIO` instance allocated on the specified `MemoryStack`.
`static AIFileCloseProc`	`nCloseProc(long struct)` Unsafe version of `CloseProc()`.
`static void`	`nCloseProc(long struct, AIFileCloseProcI value)` Unsafe version of `CloseProc`.
`static AIFileOpenProc`	`nOpenProc(long struct)` Unsafe version of `OpenProc()`.
`static void`	`nOpenProc(long struct, AIFileOpenProcI value)` Unsafe version of `OpenProc`.
`static long`	`nUserData(long struct)` Unsafe version of `UserData()`.
`static void`	`nUserData(long struct, long value)` Unsafe version of `UserData`.
`AIFileOpenProc`	`OpenProc()` Returns the value of the `OpenProc` field.
`AIFileIO`	`OpenProc(AIFileOpenProcI value)` Sets the specified value to the `OpenProc` field.
`AIFileIO`	`set(AIFileIO src)` Copies the specified struct data to this struct.
`AIFileIO`	`set(AIFileOpenProcI OpenProc, AIFileCloseProcI CloseProc, long UserData)` Initializes this struct with the specified values.
`int`	`sizeof()`
`long`	`UserData()` Returns the value of the `UserData` field.
`AIFileIO`	`UserData(long value)` Sets the specified value to the `UserData` field.
`static void`	`validate(long struct)` Validates pointer members that should not be `NULL`.
`static void`	`validate(long array, int count)` Calls `validate(long)` for each struct contained in the specified struct array.

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull

Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource
close, free

- Field Detail
  - 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 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()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.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.
  - 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
```
@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(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
```
@Nullable
public static AIFileIO.Buffer createSafe(long address,
                                                   int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static AIFileIO mallocStack()
```
    Returns a new AIFileIO instance allocated on the thread-local MemoryStack.
  - 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(org.lwjgl.system.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(org.lwjgl.system.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
  - mallocStack
```
public static AIFileIO.Buffer mallocStack(int capacity)
```
    Returns a new AIFileIO.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - 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
  - mallocStack
```
public static AIFileIO.Buffer mallocStack(int capacity,
                                          org.lwjgl.system.MemoryStack stack)
```
    Returns a new AIFileIO.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static AIFileIO.Buffer callocStack(int capacity,
                                          org.lwjgl.system.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
  - 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
  - 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

Class AIFileIO

Member documentation

Layout

Nested Class Summary

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

ALIGNOF

OPENPROC

CLOSEPROC

USERDATA

Constructor Detail

AIFileIO

Method Detail

sizeof

OpenProc

CloseProc

UserData

OpenProc

CloseProc

UserData

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nOpenProc

nCloseProc

nUserData

nOpenProc

nCloseProc

nUserData

validate

validate