AIExportDataBlob (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class AIExportDataBlob
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
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.

Member documentation
- size – Size of the data in bytes
- data – The data.
- 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.
- next – Pointer to the next blob in the chain or NULL if there is none.
Layout
```
 struct aiExportDataBlob {
     size_t size;
     void * data;
     struct aiString name;
     struct aiExportDataBlob * next;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`DATA` The struct member offsets.
`static int`	`NAME` The struct member offsets.
`static int`	`NEXT` The struct member offsets.
`static int`	`SIZE` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor and Description

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

Constructors
Constructor and Description
`AIExportDataBlob(java.nio.ByteBuffer container)` Creates a `AIExportDataBlob` 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 AIExportDataBlob`	`calloc()` Returns a new `AIExportDataBlob` instance allocated with `memCalloc`.
`static AIExportDataBlob.Buffer`	`calloc(int capacity)` Returns a new `AIExportDataBlob.Buffer` instance allocated with `memCalloc`.
`static AIExportDataBlob`	`callocStack()` Returns a new `AIExportDataBlob` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static AIExportDataBlob.Buffer`	`callocStack(int capacity)` Returns a new `AIExportDataBlob.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static AIExportDataBlob.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `AIExportDataBlob.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static AIExportDataBlob`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `AIExportDataBlob` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static AIExportDataBlob`	`create()` Returns a new `AIExportDataBlob` instance allocated with `BufferUtils`.
`static AIExportDataBlob.Buffer`	`create(int capacity)` Returns a new `AIExportDataBlob.Buffer` instance allocated with `BufferUtils`.
`static AIExportDataBlob`	`create(long address)` Returns a new `AIExportDataBlob` instance for the specified memory address.
`static AIExportDataBlob.Buffer`	`create(long address, int capacity)` Create a `AIExportDataBlob.Buffer` instance at the specified memory.
`static AIExportDataBlob`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static AIExportDataBlob.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`java.nio.ByteBuffer`	`data()` Returns a `ByteBuffer` view of the data pointed to by the `data` field.
`AIExportDataBlob`	`data(java.nio.ByteBuffer value)` Sets the address of the specified `ByteBuffer` to the `data` field.
`static AIExportDataBlob`	`malloc()` Returns a new `AIExportDataBlob` instance allocated with `memAlloc`.
`static AIExportDataBlob.Buffer`	`malloc(int capacity)` Returns a new `AIExportDataBlob.Buffer` instance allocated with `memAlloc`.
`static AIExportDataBlob`	`mallocStack()` Returns a new `AIExportDataBlob` instance allocated on the thread-local `MemoryStack`.
`static AIExportDataBlob.Buffer`	`mallocStack(int capacity)` Returns a new `AIExportDataBlob.Buffer` instance allocated on the thread-local `MemoryStack`.
`static AIExportDataBlob.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `AIExportDataBlob.Buffer` instance allocated on the specified `MemoryStack`.
`static AIExportDataBlob`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `AIExportDataBlob` instance allocated on the specified `MemoryStack`.
`AIString`	`name()` Returns a `AIString` view of the `name` field.
`AIExportDataBlob`	`name(AIString value)` Copies the specified `AIString` to the `name` field.
`AIExportDataBlob`	`name(java.util.function.Consumer<AIString> consumer)` Passes the `name` field to the specified `Consumer`.
`static java.nio.ByteBuffer`	`ndata(long struct)` Unsafe version of `data`.
`static void`	`ndata(long struct, java.nio.ByteBuffer value)` Unsafe version of `data`.
`AIExportDataBlob`	`next()` Returns a `AIExportDataBlob` view of the struct pointed to by the `next` field.
`AIExportDataBlob`	`next(AIExportDataBlob value)` Sets the address of the specified `AIExportDataBlob` to the `next` field.
`static AIString`	`nname(long struct)` Unsafe version of `name()`.
`static void`	`nname(long struct, AIString value)` Unsafe version of `name`.
`static AIExportDataBlob`	`nnext(long struct)` Unsafe version of `next()`.
`static void`	`nnext(long struct, AIExportDataBlob value)` Unsafe version of `next`.
`static long`	`nsize(long struct)` Unsafe version of `size()`.
`static void`	`nsize(long struct, long value)` Sets the specified value to the `size` field of the specified `struct`.
`AIExportDataBlob`	`set(AIExportDataBlob src)` Copies the specified struct data to this struct.
`AIExportDataBlob`	`set(java.nio.ByteBuffer data, AIString name, AIExportDataBlob next)` Initializes this struct with the specified values.
`long`	`size()` Returns the value of the `size` field.
`int`	`sizeof()`
`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.

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.
  - SIZE
```
public static final int SIZE
```
    The struct member offsets.
  - DATA
```
public static final int DATA
```
    The struct member offsets.
  - NAME
```
public static final int NAME
```
    The struct member offsets.
  - NEXT
```
public static final int NEXT
```
    The struct member offsets.
- Constructor Detail
  - AIExportDataBlob
```
public AIExportDataBlob(java.nio.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
  - sizeof
```
public int sizeof()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.Struct
  - size
```
public long size()
```
    Returns the value of the size field.
  - data
```
public java.nio.ByteBuffer data()
```
    Returns a ByteBuffer view of the data pointed to by the data field.
  - name
```
public AIString name()
```
    Returns a AIString view of the name field.
  - next
```
@Nullable
public AIExportDataBlob next()
```
    Returns a AIExportDataBlob view of the struct pointed to by the next field.
  - data
```
public AIExportDataBlob data(java.nio.ByteBuffer value)
```
    Sets the address of the specified ByteBuffer to the data field.
  - name
```
public AIExportDataBlob name(AIString value)
```
    Copies the specified AIString to the name field.
  - name
```
public AIExportDataBlob name(java.util.function.Consumer<AIString> consumer)
```
    Passes the name field to the specified Consumer.
  - next
```
public AIExportDataBlob next(@Nullable
                             AIExportDataBlob value)
```
    Sets the address of the specified AIExportDataBlob to the next field.
  - set
```
public AIExportDataBlob set(java.nio.ByteBuffer data,
                            AIString name,
                            @Nullable
                            AIExportDataBlob next)
```
    Initializes this struct with the specified values.
  - set
```
public AIExportDataBlob set(AIExportDataBlob src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static AIExportDataBlob malloc()
```
    Returns a new AIExportDataBlob instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static AIExportDataBlob calloc()
```
    Returns a new AIExportDataBlob instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static AIExportDataBlob create()
```
    Returns a new AIExportDataBlob instance allocated with BufferUtils.
  - create
```
public static AIExportDataBlob create(long address)
```
    Returns a new AIExportDataBlob instance for the specified memory address.
  - createSafe
```
@Nullable
public static AIExportDataBlob createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static AIExportDataBlob.Buffer malloc(int capacity)
```
    Returns a new AIExportDataBlob.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static AIExportDataBlob.Buffer calloc(int capacity)
```
    Returns a new AIExportDataBlob.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static AIExportDataBlob.Buffer create(int capacity)
```
    Returns a new AIExportDataBlob.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static AIExportDataBlob.Buffer create(long address,
                                             int capacity)
```
    Create a AIExportDataBlob.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static AIExportDataBlob.Buffer createSafe(long address,
                                                           int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static AIExportDataBlob mallocStack()
```
    Returns a new AIExportDataBlob instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static AIExportDataBlob callocStack()
```
    Returns a new AIExportDataBlob instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static AIExportDataBlob mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new AIExportDataBlob instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static AIExportDataBlob callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new AIExportDataBlob instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static AIExportDataBlob.Buffer mallocStack(int capacity)
```
    Returns a new AIExportDataBlob.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static AIExportDataBlob.Buffer callocStack(int capacity)
```
    Returns a new AIExportDataBlob.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static AIExportDataBlob.Buffer mallocStack(int capacity,
                                                  org.lwjgl.system.MemoryStack stack)
```
    Returns a new AIExportDataBlob.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static AIExportDataBlob.Buffer callocStack(int capacity,
                                                  org.lwjgl.system.MemoryStack stack)
```
    Returns a new AIExportDataBlob.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
  - nsize
```
public static long nsize(long struct)
```
    Unsafe version of size().
  - ndata
```
public static java.nio.ByteBuffer ndata(long struct)
```
    Unsafe version of data.
  - nname
```
public static AIString nname(long struct)
```
    Unsafe version of name().
  - nnext
```
@Nullable
public static AIExportDataBlob nnext(long struct)
```
    Unsafe version of next().
  - nsize
```
public static void nsize(long struct,
                         long value)
```
    Sets the specified value to the size field of the specified struct.
  - ndata
```
public static void ndata(long struct,
                         java.nio.ByteBuffer value)
```
    Unsafe version of data.
  - nname
```
public static void nname(long struct,
                         AIString value)
```
    Unsafe version of name.
  - nnext
```
public static void nnext(long struct,
                         @Nullable
                         AIExportDataBlob value)
```
    Unsafe version of next.
  - 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 AIExportDataBlob

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

SIZE

DATA

NAME

NEXT

Constructor Detail

AIExportDataBlob

Method Detail

sizeof

size

data

name

next

data

name

name

next

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsize

ndata

nname

nnext

nsize

ndata

nname

nnext

validate

validate