Top Description Inners Fields Constructors Methods
org.lwjgl.assimp

public Class AIExportDataBlob

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

Describes a blob of exported scene data. Use ExportSceneToBlob to create a blob containing an exported scene. The memory referred by this structure is owned by Assimp. to free its resources. Don't try to free the memory on your side - it will crash for most build configurations due to conflicting heaps.

Blobs can be nested - each blob may reference another blob, which may in turn reference another blob and so on. This is used when exporters write more than one output file for a given AIScene. See the remarks for aiExportDataBlob::name for more information.

Layout


struct aiExportDataBlob {
    size_t size;
    void * data;
    struct aiString name;
    struct aiExportDataBlob * next;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

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
NAME

The struct member offsets.

public static final int
NEXT

The struct member offsets.

public static final int
SIZE

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
AIExportDataBlob(long address, ByteBuffer container)

public
AIExportDataBlob(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static AIExportDataBlob
calloc()

Returns a new AIExportDataBlob instance allocated with memCalloc.

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

Returns a new AIExportDataBlob.Buffer instance allocated with memCalloc.

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

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

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

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

public static AIExportDataBlob
callocStack()

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

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

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

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

Returns a new AIExportDataBlob instance allocated with BufferUtils.

public static AIExportDataBlob
create(long address)

Returns a new AIExportDataBlob instance for the specified memory address.

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

Returns a new AIExportDataBlob.Buffer instance allocated with BufferUtils.

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

Create a AIExportDataBlob.Buffer instance at the specified memory.

public static AIExportDataBlob
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public ByteBuffer
data()

The data.

public AIExportDataBlob
data(ByteBuffer value)

Sets the address of the specified ByteBuffer to the data field.

public static AIExportDataBlob
malloc()

Returns a new AIExportDataBlob instance allocated with memAlloc.

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

Returns a new AIExportDataBlob.Buffer instance allocated with memAlloc.

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

Returns a new AIExportDataBlob instance allocated on the specified MemoryStack.

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

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

public static AIExportDataBlob
mallocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
public AIString
name()

Name of the blob.

public AIExportDataBlob
name(AIString value)

Copies the specified AIString to the name field.

public AIExportDataBlob
name(Consumer<AIString> consumer)

Passes the name field to the specified Consumer.

public static ByteBuffer
ndata(long struct)

Unsafe version of data.

public static void
ndata(long struct, ByteBuffer value)

Unsafe version of data.

public AIExportDataBlob
next()

Pointer to the next blob in the chain or NULL if there is none.

public AIExportDataBlob
next(AIExportDataBlob value)

Sets the address of the specified AIExportDataBlob to the next field.

public static AIString
nname(long struct)

Unsafe version of name.

public static void
nname(long struct, AIString value)

Unsafe version of name.

public static AIExportDataBlob
nnext(long struct)

Unsafe version of next.

public static void
nnext(long struct, AIExportDataBlob value)

Unsafe version of next.

public static long
nsize(long struct)

Unsafe version of size.

public static void
nsize(long struct, long value)

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

public AIExportDataBlob
set(ByteBuffer data, AIString name, AIExportDataBlob next)

Initializes this struct with the specified values.

public AIExportDataBlob

Returns:

this struct
set
(AIExportDataBlob
the source struct
src
)

Copies the specified struct data to this struct.

public long
size()

Size of the data in bytes

public int
sizeof()

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

Returns sizeof(struct).
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.

DATAback to summary
public static final int DATA

The struct member offsets.

NAMEback to summary
public static final int NAME

The struct member offsets.

NEXTback to summary
public static final int NEXT

The struct member offsets.

SIZEback to summary
public static final int SIZE

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

AIExportDataBlobback to summary
protected AIExportDataBlob(long address, ByteBuffer container)
AIExportDataBlobback to summary
public AIExportDataBlob(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static AIExportDataBlob calloc(MemoryStack stack)

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Returns a new AIExportDataBlob instance allocated with BufferUtils.

createback to summary
public static AIExportDataBlob create(long address)

Returns a new AIExportDataBlob instance for the specified memory address.

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

Returns a new AIExportDataBlob.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a AIExportDataBlob.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static AIExportDataBlob createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
databack to summary
public ByteBuffer data()

The data.

Annotations
@NativeType:void *
databack to summary
public AIExportDataBlob data(ByteBuffer value)

Sets the address of the specified ByteBuffer to the data field.

mallocback to summary
public static AIExportDataBlob malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static AIExportDataBlob malloc(MemoryStack stack)

Returns a new AIExportDataBlob instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
nameback to summary
public AIString name()

Name of the blob. An empty string always indicates the first (and primary) blob, which contains the actual file data. Any other blobs are auxiliary files produced by exporters (i.e. material files). Existence of such files depends on the file format. Most formats don't split assets across multiple files.

If used, blob names usually contain the file extension that should be used when writing the data to disc.

The blob names generated can be influenced by setting the Assimp#AI_CONFIG_EXPORT_BLOB_NAME export property to the name that is used for the master blob. All other names are typically derived from the base name, by the file format exporter.

Annotations
@NativeType:struct aiString
nameback to summary
public AIExportDataBlob name(AIString value)

Copies the specified AIString to the name field.

nameback to summary
public AIExportDataBlob name(Consumer<AIString> consumer)

Passes the name field to the specified Consumer.

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.

nextback to summary
public AIExportDataBlob next()

Pointer to the next blob in the chain or NULL if there is none.

Annotations
@Nullable
@NativeType:struct aiExportDataBlob *
nextback to summary
public AIExportDataBlob next(AIExportDataBlob value)

Sets the address of the specified AIExportDataBlob to the next field.

nnameback to summary
public static AIString nname(long struct)

Unsafe version of name.

nnameback to summary
public static void nname(long struct, AIString value)

Unsafe version of name.

nnextback to summary
public static AIExportDataBlob nnext(long struct)

Unsafe version of next.

Annotations
@Nullable
nnextback to summary
public static void nnext(long struct, AIExportDataBlob value)

Unsafe version of next.

nsizeback to summary
public static long nsize(long struct)

Unsafe version of size.

nsizeback to summary
public static void nsize(long struct, long value)

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

setback to summary
public AIExportDataBlob set(ByteBuffer data, AIString name, AIExportDataBlob next)

Initializes this struct with the specified values.

setback to summary
public AIExportDataBlob set(AIExportDataBlob src)

Copies the specified struct data to this struct.

Parameters
src:AIExportDataBlob

the source struct

Returns:AIExportDataBlob

this struct

sizeback to summary
public long size()

Size of the data in bytes

Annotations
@NativeType:size_t
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
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 AIExportDataBlob.Buffer

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

An array of AIExportDataBlob structs.

Field Summary

Modifier and TypeField and Description
private static final AIExportDataBlob

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new AIExportDataBlob.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 data pointed to by the AIExportDataBlob#data field.
data
()

public AIExportDataBlob.Buffer
data(ByteBuffer value)

Sets the address of the specified ByteBuffer to the AIExportDataBlob#data field.

protected AIExportDataBlob
public AIString

Returns:

a AIString view of the AIExportDataBlob#name field.
name
()

public AIExportDataBlob.Buffer
name(AIString value)

Copies the specified AIString to the AIExportDataBlob#name field.

public AIExportDataBlob.Buffer
name(Consumer<AIString> consumer)

Passes the AIExportDataBlob#name field to the specified Consumer.

public AIExportDataBlob

Returns:

a AIExportDataBlob view of the struct pointed to by the AIExportDataBlob#next field.
next
()

public AIExportDataBlob.Buffer
next(AIExportDataBlob value)

Sets the address of the specified AIExportDataBlob to the AIExportDataBlob#next field.

protected AIExportDataBlob.Buffer
public long

Returns:

the value of the AIExportDataBlob#size field.
size
()

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final AIExportDataBlob ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new AIExportDataBlob.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 AIExportDataBlob#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 data pointed to by the AIExportDataBlob#data field.

Annotations
@NativeType:void *
databack to summary
public AIExportDataBlob.Buffer data(ByteBuffer value)

Sets the address of the specified ByteBuffer to the AIExportDataBlob#data field.

getElementFactoryback to summary
protected AIExportDataBlob getElementFactory()

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

Annotations
@Override
nameback to summary
public AIString name()
Returns:AIString

a AIString view of the AIExportDataBlob#name field.

Annotations
@NativeType:struct aiString
nameback to summary
public AIExportDataBlob.Buffer name(AIString value)

Copies the specified AIString to the AIExportDataBlob#name field.

nameback to summary
public AIExportDataBlob.Buffer name(Consumer<AIString> consumer)

Passes the AIExportDataBlob#name field to the specified Consumer.

nextback to summary
public AIExportDataBlob next()
Returns:AIExportDataBlob

a AIExportDataBlob view of the struct pointed to by the AIExportDataBlob#next field.

Annotations
@Nullable
@NativeType:struct aiExportDataBlob *
nextback to summary
public AIExportDataBlob.Buffer next(AIExportDataBlob value)

Sets the address of the specified AIExportDataBlob to the AIExportDataBlob#next field.

selfback to summary
protected AIExportDataBlob.Buffer self()

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

Annotations
@Override
sizeback to summary
public long size()
Returns:long

the value of the AIExportDataBlob#size field.

Annotations
@NativeType:size_t