Top Description Inners Fields Constructors Methods
org.lwjgl.assimp

public Class AIString

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

Represents an UTF-8 string, zero byte terminated.

Layout


struct aiString {
    ai_uint32 length;
    char data[Assimp.MAXLEN];
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
AIString.Buffer

An array of AIString structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
DATA

The struct member offsets.

public static final int
LENGTH

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
AIString(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static AIString
calloc()

Returns a new AIString instance allocated with memCalloc.

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

Returns a new AIString.Buffer instance allocated with memCalloc.

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

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

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

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

public static AIString
callocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
protected AIString
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 AIString
create()

Returns a new AIString instance allocated with BufferUtils.

public static AIString
create(long address)

Returns a new AIString instance for the specified memory address.

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

Returns a new AIString.Buffer instance allocated with BufferUtils.

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

Create a AIString.Buffer instance at the specified memory.

public static AIString
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public ByteBuffer
data()

String buffer.

public AIString
data(ByteBuffer value)

Copies the specified encoded string to the data field.

public String
dataString()

String buffer.

public int
length()

Binary length of the string excluding the terminal 0.

public static AIString
malloc()

Returns a new AIString instance allocated with memAlloc.

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

Returns a new AIString.Buffer instance allocated with memAlloc.

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

Returns a new AIString instance allocated on the specified MemoryStack.

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

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

public static AIString
mallocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
public static ByteBuffer
ndata(long struct)

Unsafe version of data.

public static void
ndata(long struct, ByteBuffer value)

Unsafe version of data.

public static String
ndataString(long struct)

Unsafe version of dataString.

public static int
nlength(long struct)

Unsafe version of length.

public static void
nlength(long struct, int value)

Sets the specified value to the length field of the specified struct.

public AIString

Returns:

this struct
set
(AIString
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).
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.

DATAback to summary
public static final int DATA

The struct member offsets.

LENGTHback to summary
public static final int LENGTH

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

AIStringback to summary
protected AIString(long address, ByteBuffer container)
AIStringback to summary
public AIString(ByteBuffer container)

Creates a AIString 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 AIString calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static AIString calloc(MemoryStack stack)

Returns a new AIString 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 AIString.Buffer calloc(int capacity, MemoryStack stack)

Returns a new AIString.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 AIString callocStack()

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static AIString.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 AIString 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 AIString create()

Returns a new AIString instance allocated with BufferUtils.

createback to summary
public static AIString create(long address)

Returns a new AIString instance for the specified memory address.

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

Returns a new AIString.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a AIString.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static AIString createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
databack to summary
public ByteBuffer data()

String buffer.

Annotations
@NativeType:char[Assimp.MAXLEN]
databack to summary
public AIString data(ByteBuffer value)

Copies the specified encoded string to the data field.

dataStringback to summary
public String dataString()

String buffer.

Annotations
@NativeType:char[Assimp.MAXLEN]
lengthback to summary
public int length()

Binary length of the string excluding the terminal 0.

Annotations
@NativeType:ai_uint32
mallocback to summary
public static AIString malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static AIString malloc(MemoryStack stack)

Returns a new AIString instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
ndataback to summary
public static ByteBuffer ndata(long struct)

Unsafe version of data.

ndataback to summary
public static void ndata(long struct, ByteBuffer value)

Unsafe version of data.

ndataStringback to summary
public static String ndataString(long struct)

Unsafe version of dataString.

nlengthback to summary
public static int nlength(long struct)

Unsafe version of length.

nlengthback to summary
public static void nlength(long struct, int value)

Sets the specified value to the length field of the specified struct.

setback to summary
public AIString set(AIString src)

Copies the specified struct data to this struct.

Parameters
src:AIString

the source struct

Returns:AIString

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
org.lwjgl.assimp back to summary

public Class AIString.Buffer

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

An array of AIString structs.

Field Summary

Modifier and TypeField and Description
private static final AIString

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new AIString.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 ByteBuffer

Returns:

a ByteBuffer view of the AIString#data field.
data
()

public AIString.Buffer
data(ByteBuffer value)

Copies the specified encoded string to the AIString#data field.

public String

Returns:

the null-terminated string stored in the AIString#data field.
dataString
()

protected AIString
public int

Returns:

the value of the AIString#length field.
length
()

protected AIString.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final AIString ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

databack to summary
public ByteBuffer data()
Returns:ByteBuffer

a ByteBuffer view of the AIString#data field.

Annotations
@NativeType:char[Assimp.MAXLEN]
databack to summary
public AIString.Buffer data(ByteBuffer value)

Copies the specified encoded string to the AIString#data field.

dataStringback to summary
public String dataString()
Returns:String

the null-terminated string stored in the AIString#data field.

Annotations
@NativeType:char[Assimp.MAXLEN]
getElementFactoryback to summary
protected AIString getElementFactory()

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

Annotations
@Override
lengthback to summary
public int length()
Returns:int

the value of the AIString#length field.

Annotations
@NativeType:ai_uint32
selfback to summary
protected AIString.Buffer self()

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

Annotations
@Override