Top Description Inners Fields Constructors Methods
org.lwjgl.assimp

public Class AIFile

extends Struct<AIFile>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Annotations
@NativeType:struct aiFile
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

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.

Layout


struct aiFile {
    aiFileReadProc ReadProc;
    aiFileWriteProc WriteProc;
    aiFileTellProc TellProc;
    aiFileTellProc FileSizeProc;
    aiFileSeek SeekProc;
    aiFileFlushProc FlushProc;
    aiUserData UserData;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
AIFile.Buffer

An array of AIFile structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
FILESIZEPROC

The struct member offsets.

public static final int
FLUSHPROC

The struct member offsets.

public static final int
READPROC

The struct member offsets.

public static final int
SEEKPROC

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
TELLPROC

The struct member offsets.

public static final int
USERDATA

The struct member offsets.

public static final int
WRITEPROC

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
AIFile(long address, ByteBuffer container)

public
AIFile(ByteBuffer container)

Creates a AIFile instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static AIFile
calloc()

Returns a new AIFile instance allocated with memCalloc.

public static AIFile.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new AIFile.Buffer instance allocated with memCalloc.

public static AIFile
calloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new AIFile instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static AIFile.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new AIFile.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static AIFile
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static AIFile
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static AIFile.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static AIFile.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected AIFile
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static AIFile
create()

Returns a new AIFile instance allocated with BufferUtils.

public static AIFile
create(long address)

Returns a new AIFile instance for the specified memory address.

public static AIFile.Buffer
create(int
the buffer capacity
capacity
)

Returns a new AIFile.Buffer instance allocated with BufferUtils.

public static AIFile.Buffer
create(long
the memory address
address
,
int
the buffer capacity
capacity
)

Create a AIFile.Buffer instance at the specified memory.

public static AIFile
createSafe(long address)

Like create, but returns null if address is NULL.

public static AIFile.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public AIFileTellProc
FileSizeProc()

Callback to retrieve the size of the file, in bytes

public AIFile
FileSizeProc(AIFileTellProcI value)

Sets the specified value to the FileSizeProc field.

public AIFileFlushProc
FlushProc()

Callback to flush the file contents

public AIFile
FlushProc(AIFileFlushProcI value)

Sets the specified value to the FlushProc field.

public static AIFile
malloc()

Returns a new AIFile instance allocated with memAlloc.

public static AIFile.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new AIFile.Buffer instance allocated with memAlloc.

public static AIFile
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new AIFile instance allocated on the specified MemoryStack.

public static AIFile.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new AIFile.Buffer instance allocated on the specified MemoryStack.

public static AIFile
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static AIFile
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static AIFile.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static AIFile.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static AIFileTellProc
nFileSizeProc(long struct)

Unsafe version of FileSizeProc.

public static void
nFileSizeProc(long struct, AIFileTellProcI value)

Unsafe version of FileSizeProc.

public static AIFileFlushProc
nFlushProc(long struct)

Unsafe version of FlushProc.

public static void
nFlushProc(long struct, AIFileFlushProcI value)

Unsafe version of FlushProc.

public static AIFileReadProc
nReadProc(long struct)

Unsafe version of ReadProc.

public static void
nReadProc(long struct, AIFileReadProcI value)

Unsafe version of ReadProc.

public static AIFileSeek
nSeekProc(long struct)

Unsafe version of SeekProc.

public static void
nSeekProc(long struct, AIFileSeekI value)

Unsafe version of SeekProc.

public static AIFileTellProc
nTellProc(long struct)

Unsafe version of TellProc.

public static void
nTellProc(long struct, AIFileTellProcI value)

Unsafe version of TellProc.

public static long
nUserData(long struct)

Unsafe version of UserData.

public static void
nUserData(long struct, long value)

Unsafe version of UserData.

public static AIFileWriteProc
nWriteProc(long struct)

Unsafe version of WriteProc.

public static void
nWriteProc(long struct, AIFileWriteProcI value)

Unsafe version of WriteProc.

public AIFileReadProc
ReadProc()

Callback to read from a file

public AIFile
ReadProc(AIFileReadProcI value)

Sets the specified value to the ReadProc field.

public AIFileSeek
SeekProc()

Callback to set the current position of the file cursor (fseek())

public AIFile
SeekProc(AIFileSeekI value)

Sets the specified value to the SeekProc field.

public AIFile
set(AIFileReadProcI ReadProc, AIFileWriteProcI WriteProc, AIFileTellProcI TellProc, AIFileTellProcI FileSizeProc, AIFileSeekI SeekProc, AIFileFlushProcI FlushProc, long UserData)

Initializes this struct with the specified values.

public AIFile

Returns:

this struct
set
(AIFile
the source struct
src
)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public AIFileTellProc
TellProc()

Callback to retrieve the current position of the file cursor (ftell())

public AIFile
TellProc(AIFileTellProcI value)

Sets the specified value to the TellProc field.

public long
UserData()

User-defined, opaque data

public AIFile
UserData(long value)

Sets the specified value to the UserData field.

public static void
validate(long
the struct to validate
struct
)

Validates pointer members that should not be NULL.

public AIFileWriteProc
WriteProc()

Callback to write to a file

public AIFile
WriteProc(AIFileWriteProcI value)

Sets the specified value to the WriteProc field.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

FILESIZEPROCback to summary
public static final int FILESIZEPROC

The struct member offsets.

FLUSHPROCback to summary
public static final int FLUSHPROC

The struct member offsets.

READPROCback to summary
public static final int READPROC

The struct member offsets.

SEEKPROCback to summary
public static final int SEEKPROC

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

TELLPROCback to summary
public static final int TELLPROC

The struct member offsets.

USERDATAback to summary
public static final int USERDATA

The struct member offsets.

WRITEPROCback to summary
public static final int WRITEPROC

The struct member offsets.

Constructor Detail

AIFileback to summary
protected AIFile(long address, ByteBuffer container)
AIFileback to summary
public AIFile(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

callocback to summary
public static AIFile calloc()

Returns a new AIFile instance allocated with memCalloc. The instance must be explicitly freed.

callocback to summary
public static AIFile.Buffer calloc(int capacity)

Returns a new AIFile.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

callocback to summary
public static AIFile calloc(MemoryStack stack)

Returns a new AIFile instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static AIFile.Buffer calloc(int capacity, MemoryStack stack)

Returns a new AIFile.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

callocStackback to summary
public static AIFile callocStack()

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static AIFile callocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static AIFile.Buffer callocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static AIFile.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
createback to summary
protected AIFile create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static AIFile create()

Returns a new AIFile instance allocated with BufferUtils.

createback to summary
public static AIFile create(long address)

Returns a new AIFile instance for the specified memory address.

createback to summary
public static AIFile.Buffer create(int capacity)

Returns a new AIFile.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static AIFile.Buffer create(long address, int capacity)

Create a AIFile.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static AIFile createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static AIFile.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
FileSizeProcback to summary
public AIFileTellProc FileSizeProc()

Callback to retrieve the size of the file, in bytes

Annotations
@NativeType:aiFileTellProc
FileSizeProcback to summary
public AIFile FileSizeProc(AIFileTellProcI value)

Sets the specified value to the FileSizeProc field.

FlushProcback to summary
public AIFileFlushProc FlushProc()

Callback to flush the file contents

Annotations
@NativeType:aiFileFlushProc
FlushProcback to summary
public AIFile FlushProc(AIFileFlushProcI value)

Sets the specified value to the FlushProc field.

mallocback to summary
public static AIFile malloc()

Returns a new AIFile instance allocated with memAlloc. The instance must be explicitly freed.

mallocback to summary
public static AIFile.Buffer malloc(int capacity)

Returns a new AIFile.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static AIFile malloc(MemoryStack stack)

Returns a new AIFile instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static AIFile.Buffer malloc(int capacity, MemoryStack stack)

Returns a new AIFile.Buffer instance allocated on the specified MemoryStack.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static AIFile mallocStack()

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static AIFile mallocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static AIFile.Buffer mallocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static AIFile.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
nFileSizeProcback to summary
public static AIFileTellProc nFileSizeProc(long struct)

Unsafe version of FileSizeProc.

nFileSizeProcback to summary
public static void nFileSizeProc(long struct, AIFileTellProcI value)

Unsafe version of FileSizeProc.

nFlushProcback to summary
public static AIFileFlushProc nFlushProc(long struct)

Unsafe version of FlushProc.

nFlushProcback to summary
public static void nFlushProc(long struct, AIFileFlushProcI value)

Unsafe version of FlushProc.

nReadProcback to summary
public static AIFileReadProc nReadProc(long struct)

Unsafe version of ReadProc.

nReadProcback to summary
public static void nReadProc(long struct, AIFileReadProcI value)

Unsafe version of ReadProc.

nSeekProcback to summary
public static AIFileSeek nSeekProc(long struct)

Unsafe version of SeekProc.

nSeekProcback to summary
public static void nSeekProc(long struct, AIFileSeekI value)

Unsafe version of SeekProc.

nTellProcback to summary
public static AIFileTellProc nTellProc(long struct)

Unsafe version of TellProc.

nTellProcback to summary
public static void nTellProc(long struct, AIFileTellProcI value)

Unsafe version of TellProc.

nUserDataback to summary
public static long nUserData(long struct)

Unsafe version of UserData.

nUserDataback to summary
public static void nUserData(long struct, long value)

Unsafe version of UserData.

nWriteProcback to summary
public static AIFileWriteProc nWriteProc(long struct)

Unsafe version of WriteProc.

nWriteProcback to summary
public static void nWriteProc(long struct, AIFileWriteProcI value)

Unsafe version of WriteProc.

ReadProcback to summary
public AIFileReadProc ReadProc()

Callback to read from a file

Annotations
@NativeType:aiFileReadProc
ReadProcback to summary
public AIFile ReadProc(AIFileReadProcI value)

Sets the specified value to the ReadProc field.

SeekProcback to summary
public AIFileSeek SeekProc()

Callback to set the current position of the file cursor (fseek())

Annotations
@NativeType:aiFileSeek
SeekProcback to summary
public AIFile SeekProc(AIFileSeekI value)

Sets the specified value to the SeekProc field.

setback to summary
public AIFile set(AIFileReadProcI ReadProc, AIFileWriteProcI WriteProc, AIFileTellProcI TellProc, AIFileTellProcI FileSizeProc, AIFileSeekI SeekProc, AIFileFlushProcI FlushProc, long UserData)

Initializes this struct with the specified values.

setback to summary
public AIFile set(AIFile src)

Copies the specified struct data to this struct.

Parameters
src:AIFile

the source struct

Returns:AIFile

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
TellProcback to summary
public AIFileTellProc TellProc()

Callback to retrieve the current position of the file cursor (ftell())

Annotations
@NativeType:aiFileTellProc
TellProcback to summary
public AIFile TellProc(AIFileTellProcI value)

Sets the specified value to the TellProc field.

UserDataback to summary
public long UserData()

User-defined, opaque data

Annotations
@NativeType:aiUserData
UserDataback to summary
public AIFile UserData(long value)

Sets the specified value to the UserData field.

validateback to summary
public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters
struct:long

the struct to validate

WriteProcback to summary
public AIFileWriteProc WriteProc()

Callback to write to a file

Annotations
@NativeType:aiFileWriteProc
WriteProcback to summary
public AIFile WriteProc(AIFileWriteProcI value)

Sets the specified value to the WriteProc field.

org.lwjgl.assimp back to summary

public Class AIFile.Buffer

extends StructBuffer<AIFile, AIFile.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of AIFile structs.

Field Summary

Modifier and TypeField and Description
private static final AIFile

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new AIFile.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
public AIFileTellProc

Returns:

the value of the AIFile#FileSizeProc field.
FileSizeProc
()

public AIFile.Buffer
FileSizeProc(AIFileTellProcI value)

Sets the specified value to the AIFile#FileSizeProc field.

public AIFileFlushProc

Returns:

the value of the AIFile#FlushProc field.
FlushProc
()

public AIFile.Buffer
FlushProc(AIFileFlushProcI value)

Sets the specified value to the AIFile#FlushProc field.

protected AIFile
public AIFileReadProc

Returns:

the value of the AIFile#ReadProc field.
ReadProc
()

public AIFile.Buffer
ReadProc(AIFileReadProcI value)

Sets the specified value to the AIFile#ReadProc field.

public AIFileSeek

Returns:

the value of the AIFile#SeekProc field.
SeekProc
()

public AIFile.Buffer
SeekProc(AIFileSeekI value)

Sets the specified value to the AIFile#SeekProc field.

protected AIFile.Buffer
public AIFileTellProc

Returns:

the value of the AIFile#TellProc field.
TellProc
()

public AIFile.Buffer
TellProc(AIFileTellProcI value)

Sets the specified value to the AIFile#TellProc field.

public long

Returns:

the value of the AIFile#UserData field.
UserData
()

public AIFile.Buffer
UserData(long value)

Sets the specified value to the AIFile#UserData field.

public AIFileWriteProc

Returns:

the value of the AIFile#WriteProc field.
WriteProc
()

public AIFile.Buffer
WriteProc(AIFileWriteProcI value)

Sets the specified value to the AIFile#WriteProc field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final AIFile ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new AIFile.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by AIFile#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

FileSizeProcback to summary
public AIFileTellProc FileSizeProc()
Returns:AIFileTellProc

the value of the AIFile#FileSizeProc field.

Annotations
@NativeType:aiFileTellProc
FileSizeProcback to summary
public AIFile.Buffer FileSizeProc(AIFileTellProcI value)

Sets the specified value to the AIFile#FileSizeProc field.

FlushProcback to summary
public AIFileFlushProc FlushProc()
Returns:AIFileFlushProc

the value of the AIFile#FlushProc field.

Annotations
@NativeType:aiFileFlushProc
FlushProcback to summary
public AIFile.Buffer FlushProc(AIFileFlushProcI value)

Sets the specified value to the AIFile#FlushProc field.

getElementFactoryback to summary
protected AIFile getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
ReadProcback to summary
public AIFileReadProc ReadProc()
Returns:AIFileReadProc

the value of the AIFile#ReadProc field.

Annotations
@NativeType:aiFileReadProc
ReadProcback to summary
public AIFile.Buffer ReadProc(AIFileReadProcI value)

Sets the specified value to the AIFile#ReadProc field.

SeekProcback to summary
public AIFileSeek SeekProc()
Returns:AIFileSeek

the value of the AIFile#SeekProc field.

Annotations
@NativeType:aiFileSeek
SeekProcback to summary
public AIFile.Buffer SeekProc(AIFileSeekI value)

Sets the specified value to the AIFile#SeekProc field.

selfback to summary
protected AIFile.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
TellProcback to summary
public AIFileTellProc TellProc()
Returns:AIFileTellProc

the value of the AIFile#TellProc field.

Annotations
@NativeType:aiFileTellProc
TellProcback to summary
public AIFile.Buffer TellProc(AIFileTellProcI value)

Sets the specified value to the AIFile#TellProc field.

UserDataback to summary
public long UserData()
Returns:long

the value of the AIFile#UserData field.

Annotations
@NativeType:aiUserData
UserDataback to summary
public AIFile.Buffer UserData(long value)

Sets the specified value to the AIFile#UserData field.

WriteProcback to summary
public AIFileWriteProc WriteProc()
Returns:AIFileWriteProc

the value of the AIFile#WriteProc field.

Annotations
@NativeType:aiFileWriteProc
WriteProcback to summary
public AIFile.Buffer WriteProc(AIFileWriteProcI value)

Sets the specified value to the AIFile#WriteProc field.