Top Description Inners Fields Constructors Methods
org.lwjgl.assimp

public Class AIFileIO

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

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.

Layout


struct aiFileIO {
    aiFileOpenProc OpenProc;
    aiFileCloseProc CloseProc;
    aiUserData UserData;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
AIFileIO.Buffer

An array of AIFileIO structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
CLOSEPROC

The struct member offsets.

public static final int
OPENPROC

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
USERDATA

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
AIFileIO(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static AIFileIO
calloc()

Returns a new AIFileIO instance allocated with memCalloc.

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

Returns a new AIFileIO.Buffer instance allocated with memCalloc.

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

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

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

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

public static AIFileIO
callocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
public AIFileCloseProc
CloseProc()

Function used to close an existing file

public AIFileIO
CloseProc(AIFileCloseProcI value)

Sets the specified value to the CloseProc field.

protected AIFileIO
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 AIFileIO
create()

Returns a new AIFileIO instance allocated with BufferUtils.

public static AIFileIO
create(long address)

Returns a new AIFileIO instance for the specified memory address.

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

Returns a new AIFileIO.Buffer instance allocated with BufferUtils.

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

Create a AIFileIO.Buffer instance at the specified memory.

public static AIFileIO
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static AIFileIO
malloc()

Returns a new AIFileIO instance allocated with memAlloc.

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

Returns a new AIFileIO.Buffer instance allocated with memAlloc.

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

Returns a new AIFileIO instance allocated on the specified MemoryStack.

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

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

public static AIFileIO
mallocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
public static AIFileCloseProc
nCloseProc(long struct)

Unsafe version of CloseProc.

public static void
nCloseProc(long struct, AIFileCloseProcI value)

Unsafe version of CloseProc.

public static AIFileOpenProc
nOpenProc(long struct)

Unsafe version of OpenProc.

public static void
nOpenProc(long struct, AIFileOpenProcI value)

Unsafe version of OpenProc.

public static long
nUserData(long struct)

Unsafe version of UserData.

public static void
nUserData(long struct, long value)

Unsafe version of UserData.

public AIFileOpenProc
OpenProc()

Function used to open a new file

public AIFileIO
OpenProc(AIFileOpenProcI value)

Sets the specified value to the OpenProc field.

public AIFileIO
set(AIFileOpenProcI OpenProc, AIFileCloseProcI CloseProc, long UserData)

Initializes this struct with the specified values.

public AIFileIO

Returns:

this struct
set
(AIFileIO
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 long
UserData()

User-defined, opaque data

public AIFileIO
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.

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.

CLOSEPROCback to summary
public static final int CLOSEPROC

The struct member offsets.

OPENPROCback to summary
public static final int OPENPROC

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

USERDATAback to summary
public static final int USERDATA

The struct member offsets.

Constructor Detail

AIFileIOback to summary
protected AIFileIO(long address, ByteBuffer container)
AIFileIOback to summary
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 Detail

callocback to summary
public static AIFileIO calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
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:MemoryStack

the stack from which to allocate

callocback to summary
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:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

callocStackback to summary
public static AIFileIO callocStack()

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
CloseProcback to summary
public AIFileCloseProc CloseProc()

Function used to close an existing file

Annotations
@NativeType:aiFileCloseProc
CloseProcback to summary
public AIFileIO CloseProc(AIFileCloseProcI value)

Sets the specified value to the CloseProc field.

createback to summary
protected AIFileIO 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 AIFileIO create()

Returns a new AIFileIO instance allocated with BufferUtils.

createback to summary
public static AIFileIO create(long address)

Returns a new AIFileIO instance for the specified memory address.

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

Returns a new AIFileIO.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a AIFileIO.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static AIFileIO createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static AIFileIO malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static AIFileIO malloc(MemoryStack stack)

Returns a new AIFileIO instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

Returns a new AIFileIO.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 AIFileIO mallocStack()

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
nCloseProcback to summary
public static AIFileCloseProc nCloseProc(long struct)

Unsafe version of CloseProc.

nCloseProcback to summary
public static void nCloseProc(long struct, AIFileCloseProcI value)

Unsafe version of CloseProc.

nOpenProcback to summary
public static AIFileOpenProc nOpenProc(long struct)

Unsafe version of OpenProc.

nOpenProcback to summary
public static void nOpenProc(long struct, AIFileOpenProcI value)

Unsafe version of OpenProc.

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.

OpenProcback to summary
public AIFileOpenProc OpenProc()

Function used to open a new file

Annotations
@NativeType:aiFileOpenProc
OpenProcback to summary
public AIFileIO OpenProc(AIFileOpenProcI value)

Sets the specified value to the OpenProc field.

setback to summary
public AIFileIO set(AIFileOpenProcI OpenProc, AIFileCloseProcI CloseProc, long UserData)

Initializes this struct with the specified values.

setback to summary
public AIFileIO set(AIFileIO src)

Copies the specified struct data to this struct.

Parameters
src:AIFileIO

the source struct

Returns:AIFileIO

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
UserDataback to summary
public long UserData()

User-defined, opaque data

Annotations
@NativeType:aiUserData
UserDataback to summary
public AIFileIO 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

org.lwjgl.assimp back to summary

public Class AIFileIO.Buffer

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

An array of AIFileIO structs.

Field Summary

Modifier and TypeField and Description
private static final AIFileIO

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new AIFileIO.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 AIFileCloseProc

Returns:

the value of the AIFileIO#CloseProc field.
CloseProc
()

public AIFileIO.Buffer
CloseProc(AIFileCloseProcI value)

Sets the specified value to the AIFileIO#CloseProc field.

protected AIFileIO
public AIFileOpenProc

Returns:

the value of the AIFileIO#OpenProc field.
OpenProc
()

public AIFileIO.Buffer
OpenProc(AIFileOpenProcI value)

Sets the specified value to the AIFileIO#OpenProc field.

protected AIFileIO.Buffer
public long

Returns:

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

public AIFileIO.Buffer
UserData(long value)

Sets the specified value to the AIFileIO#UserData field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final AIFileIO ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new AIFileIO.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 AIFileIO#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

CloseProcback to summary
public AIFileCloseProc CloseProc()
Returns:AIFileCloseProc

the value of the AIFileIO#CloseProc field.

Annotations
@NativeType:aiFileCloseProc
CloseProcback to summary
public AIFileIO.Buffer CloseProc(AIFileCloseProcI value)

Sets the specified value to the AIFileIO#CloseProc field.

getElementFactoryback to summary
protected AIFileIO getElementFactory()

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

Annotations
@Override
OpenProcback to summary
public AIFileOpenProc OpenProc()
Returns:AIFileOpenProc

the value of the AIFileIO#OpenProc field.

Annotations
@NativeType:aiFileOpenProc
OpenProcback to summary
public AIFileIO.Buffer OpenProc(AIFileOpenProcI value)

Sets the specified value to the AIFileIO#OpenProc field.

selfback to summary
protected AIFileIO.Buffer self()

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

Annotations
@Override
UserDataback to summary
public long UserData()
Returns:long

the value of the AIFileIO#UserData field.

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

Sets the specified value to the AIFileIO#UserData field.