AIFile (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class AIFile
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Actually, it's a data structure to wrap a set of fXXXX (e.g fopen) replacement functions.
The default implementation of the functions utilizes the fXXX functions from the CRT. However, you can supply a custom implementation to Assimp by delivering a custom AIFileIO. Use this to enable reading from other sources, such as ZIP archives or memory locations.

Member documentation
- ReadProc – Callback to read from a file
- WriteProc – Callback to write to a file
- TellProc – Callback to retrieve the current position of the file cursor (ftell())
- FileSizeProc – Callback to retrieve the size of the file, in bytes
- SeekProc – Callback to set the current position of the file cursor (fseek())
- FlushProc – Callback to flush the file contents
- UserData – User-defined, opaque data
Layout
```
 struct aiFile {
     aiFileReadProc ReadProc;
     aiFileWriteProc WriteProc;
     aiFileTellProc TellProc;
     aiFileTellProc FileSizeProc;
     aiFileSeek SeekProc;
     aiFileFlushProc FlushProc;
     aiUserData UserData;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class AIFile.Buffer
An array of AIFile 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`	`AIFile.Buffer` An array of `AIFile` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`FILESIZEPROC` The struct member offsets.
`static int`	`FLUSHPROC` The struct member offsets.
`static int`	`READPROC` The struct member offsets.
`static int`	`SEEKPROC` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`TELLPROC` The struct member offsets.
`static int`	`USERDATA` The struct member offsets.
`static int`	`WRITEPROC` 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

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

Constructors
Constructor and Description
`AIFile(java.nio.ByteBuffer container)` Creates a `AIFile` 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 AIFile`	`calloc()` Returns a new `AIFile` instance allocated with `memCalloc`.
`static AIFile.Buffer`	`calloc(int capacity)` Returns a new `AIFile.Buffer` instance allocated with `memCalloc`.
`static AIFile`	`callocStack()` Returns a new `AIFile` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static AIFile.Buffer`	`callocStack(int capacity)` Returns a new `AIFile.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static AIFile.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `AIFile.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static AIFile`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `AIFile` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static AIFile`	`create()` Returns a new `AIFile` instance allocated with `BufferUtils`.
`static AIFile.Buffer`	`create(int capacity)` Returns a new `AIFile.Buffer` instance allocated with `BufferUtils`.
`static AIFile`	`create(long address)` Returns a new `AIFile` instance for the specified memory address.
`static AIFile.Buffer`	`create(long address, int capacity)` Create a `AIFile.Buffer` instance at the specified memory.
`static AIFile`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static AIFile.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`AIFileTellProc`	`FileSizeProc()` Returns the value of the `FileSizeProc` field.
`AIFile`	`FileSizeProc(AIFileTellProcI value)` Sets the specified value to the `FileSizeProc` field.
`AIFileFlushProc`	`FlushProc()` Returns the value of the `FlushProc` field.
`AIFile`	`FlushProc(AIFileFlushProcI value)` Sets the specified value to the `FlushProc` field.
`static AIFile`	`malloc()` Returns a new `AIFile` instance allocated with `memAlloc`.
`static AIFile.Buffer`	`malloc(int capacity)` Returns a new `AIFile.Buffer` instance allocated with `memAlloc`.
`static AIFile`	`mallocStack()` Returns a new `AIFile` instance allocated on the thread-local `MemoryStack`.
`static AIFile.Buffer`	`mallocStack(int capacity)` Returns a new `AIFile.Buffer` instance allocated on the thread-local `MemoryStack`.
`static AIFile.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `AIFile.Buffer` instance allocated on the specified `MemoryStack`.
`static AIFile`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `AIFile` instance allocated on the specified `MemoryStack`.
`static AIFileTellProc`	`nFileSizeProc(long struct)` Unsafe version of `FileSizeProc()`.
`static void`	`nFileSizeProc(long struct, AIFileTellProcI value)` Unsafe version of `FileSizeProc`.
`static AIFileFlushProc`	`nFlushProc(long struct)` Unsafe version of `FlushProc()`.
`static void`	`nFlushProc(long struct, AIFileFlushProcI value)` Unsafe version of `FlushProc`.
`static AIFileReadProc`	`nReadProc(long struct)` Unsafe version of `ReadProc()`.
`static void`	`nReadProc(long struct, AIFileReadProcI value)` Unsafe version of `ReadProc`.
`static AIFileSeek`	`nSeekProc(long struct)` Unsafe version of `SeekProc()`.
`static void`	`nSeekProc(long struct, AIFileSeekI value)` Unsafe version of `SeekProc`.
`static AIFileTellProc`	`nTellProc(long struct)` Unsafe version of `TellProc()`.
`static void`	`nTellProc(long struct, AIFileTellProcI value)` Unsafe version of `TellProc`.
`static long`	`nUserData(long struct)` Unsafe version of `UserData()`.
`static void`	`nUserData(long struct, long value)` Unsafe version of `UserData`.
`static AIFileWriteProc`	`nWriteProc(long struct)` Unsafe version of `WriteProc()`.
`static void`	`nWriteProc(long struct, AIFileWriteProcI value)` Unsafe version of `WriteProc`.
`AIFileReadProc`	`ReadProc()` Returns the value of the `ReadProc` field.
`AIFile`	`ReadProc(AIFileReadProcI value)` Sets the specified value to the `ReadProc` field.
`AIFileSeek`	`SeekProc()` Returns the value of the `SeekProc` field.
`AIFile`	`SeekProc(AIFileSeekI value)` Sets the specified value to the `SeekProc` field.
`AIFile`	`set(AIFile src)` Copies the specified struct data to this struct.
`AIFile`	`set(AIFileReadProcI ReadProc, AIFileWriteProcI WriteProc, AIFileTellProcI TellProc, AIFileTellProcI FileSizeProc, AIFileSeekI SeekProc, AIFileFlushProcI FlushProc, long UserData)` Initializes this struct with the specified values.
`int`	`sizeof()`
`AIFileTellProc`	`TellProc()` Returns the value of the `TellProc` field.
`AIFile`	`TellProc(AIFileTellProcI value)` Sets the specified value to the `TellProc` field.
`long`	`UserData()` Returns the value of the `UserData` field.
`AIFile`	`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.
`AIFileWriteProc`	`WriteProc()` Returns the value of the `WriteProc` field.
`AIFile`	`WriteProc(AIFileWriteProcI value)` Sets the specified value to the `WriteProc` field.

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.
  - READPROC
```
public static final int READPROC
```
    The struct member offsets.
  - WRITEPROC
```
public static final int WRITEPROC
```
    The struct member offsets.
  - TELLPROC
```
public static final int TELLPROC
```
    The struct member offsets.
  - FILESIZEPROC
```
public static final int FILESIZEPROC
```
    The struct member offsets.
  - SEEKPROC
```
public static final int SEEKPROC
```
    The struct member offsets.
  - FLUSHPROC
```
public static final int FLUSHPROC
```
    The struct member offsets.
  - USERDATA
```
public static final int USERDATA
```
    The struct member offsets.
- Constructor Detail
  - AIFile
```
public AIFile(java.nio.ByteBuffer container)
```
    Creates a AIFile 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
  - ReadProc
```
public AIFileReadProc ReadProc()
```
    Returns the value of the ReadProc field.
  - WriteProc
```
public AIFileWriteProc WriteProc()
```
    Returns the value of the WriteProc field.
  - TellProc
```
public AIFileTellProc TellProc()
```
    Returns the value of the TellProc field.
  - FileSizeProc
```
public AIFileTellProc FileSizeProc()
```
    Returns the value of the FileSizeProc field.
  - SeekProc
```
public AIFileSeek SeekProc()
```
    Returns the value of the SeekProc field.
  - FlushProc
```
public AIFileFlushProc FlushProc()
```
    Returns the value of the FlushProc field.
  - UserData
```
public long UserData()
```
    Returns the value of the UserData field.
  - ReadProc
```
public AIFile ReadProc(AIFileReadProcI value)
```
    Sets the specified value to the ReadProc field.
  - WriteProc
```
public AIFile WriteProc(AIFileWriteProcI value)
```
    Sets the specified value to the WriteProc field.
  - TellProc
```
public AIFile TellProc(AIFileTellProcI value)
```
    Sets the specified value to the TellProc field.
  - FileSizeProc
```
public AIFile FileSizeProc(AIFileTellProcI value)
```
    Sets the specified value to the FileSizeProc field.
  - SeekProc
```
public AIFile SeekProc(AIFileSeekI value)
```
    Sets the specified value to the SeekProc field.
  - FlushProc
```
public AIFile FlushProc(AIFileFlushProcI value)
```
    Sets the specified value to the FlushProc field.
  - UserData
```
public AIFile UserData(long value)
```
    Sets the specified value to the UserData field.
  - set
```
public AIFile set(AIFileReadProcI ReadProc,
                  AIFileWriteProcI WriteProc,
                  AIFileTellProcI TellProc,
                  AIFileTellProcI FileSizeProc,
                  AIFileSeekI SeekProc,
                  AIFileFlushProcI FlushProc,
                  long UserData)
```
    Initializes this struct with the specified values.
  - set
```
public AIFile set(AIFile src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static AIFile malloc()
```
    Returns a new AIFile instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static AIFile calloc()
```
    Returns a new AIFile instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static AIFile create()
```
    Returns a new AIFile instance allocated with BufferUtils.
  - create
```
public static AIFile create(long address)
```
    Returns a new AIFile instance for the specified memory address.
  - createSafe
```
@Nullable
public static AIFile createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static AIFile.Buffer malloc(int capacity)
```
    Returns a new AIFile.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static AIFile.Buffer calloc(int capacity)
```
    Returns a new AIFile.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static AIFile.Buffer create(int capacity)
```
    Returns a new AIFile.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static AIFile.Buffer create(long address,
                                   int capacity)
```
    Create a AIFile.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static AIFile.Buffer createSafe(long address,
                                                 int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static AIFile mallocStack()
```
    Returns a new AIFile instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static AIFile callocStack()
```
    Returns a new AIFile instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static AIFile mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new AIFile instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static AIFile callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new AIFile instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static AIFile.Buffer mallocStack(int capacity)
```
    Returns a new AIFile.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static AIFile.Buffer callocStack(int capacity)
```
    Returns a new AIFile.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static AIFile.Buffer mallocStack(int capacity,
                                        org.lwjgl.system.MemoryStack stack)
```
    Returns a new AIFile.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static AIFile.Buffer callocStack(int capacity,
                                        org.lwjgl.system.MemoryStack stack)
```
    Returns a new AIFile.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
  - nReadProc
```
public static AIFileReadProc nReadProc(long struct)
```
    Unsafe version of ReadProc().
  - nWriteProc
```
public static AIFileWriteProc nWriteProc(long struct)
```
    Unsafe version of WriteProc().
  - nTellProc
```
public static AIFileTellProc nTellProc(long struct)
```
    Unsafe version of TellProc().
  - nFileSizeProc
```
public static AIFileTellProc nFileSizeProc(long struct)
```
    Unsafe version of FileSizeProc().
  - nSeekProc
```
public static AIFileSeek nSeekProc(long struct)
```
    Unsafe version of SeekProc().
  - nFlushProc
```
public static AIFileFlushProc nFlushProc(long struct)
```
    Unsafe version of FlushProc().
  - nUserData
```
public static long nUserData(long struct)
```
    Unsafe version of UserData().
  - nReadProc
```
public static void nReadProc(long struct,
                             AIFileReadProcI value)
```
    Unsafe version of ReadProc.
  - nWriteProc
```
public static void nWriteProc(long struct,
                              AIFileWriteProcI value)
```
    Unsafe version of WriteProc.
  - nTellProc
```
public static void nTellProc(long struct,
                             AIFileTellProcI value)
```
    Unsafe version of TellProc.
  - nFileSizeProc
```
public static void nFileSizeProc(long struct,
                                 AIFileTellProcI value)
```
    Unsafe version of FileSizeProc.
  - nSeekProc
```
public static void nSeekProc(long struct,
                             AIFileSeekI value)
```
    Unsafe version of SeekProc.
  - nFlushProc
```
public static void nFlushProc(long struct,
                              AIFileFlushProcI value)
```
    Unsafe version of FlushProc.
  - 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 AIFile

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

READPROC

WRITEPROC

TELLPROC

FILESIZEPROC

SEEKPROC

FLUSHPROC

USERDATA

Constructor Detail

AIFile

Method Detail

sizeof

ReadProc

WriteProc

TellProc

FileSizeProc

SeekProc

FlushProc

UserData

ReadProc

WriteProc

TellProc

FileSizeProc

SeekProc

FlushProc

UserData

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nReadProc

nWriteProc

nTellProc

nFileSizeProc

nSeekProc

nFlushProc

nUserData

nReadProc

nWriteProc

nTellProc

nFileSizeProc

nSeekProc

nFlushProc

nUserData

validate

validate