AIExportFormatDesc (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class AIExportFormatDesc
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Describes an file format which Assimp can export to. Use GetExportFormatCount to learn how many export formats the current Assimp build supports and GetExportFormatDescription to retrieve a description of an export format option.
Member documentation
- id – a short string ID to uniquely identify the export format. Use this ID string to specify which file format you want to export to when calling ExportScene. Example: "dae" or "obj"
- description – A short description of the file format to present to users. Useful if you want to allow the user to select an export format.
- fileExtension – Recommended file extension for the exported file in lower case.
Layout
```
 struct aiExportFormatDesc {
     char const * id;
     char const * description;
     char const * fileExtension;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`DESCRIPTION` The struct member offsets.
`static int`	`FILEEXTENSION` The struct member offsets.
`static int`	`ID` 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
`AIExportFormatDesc(java.nio.ByteBuffer container)` Creates a `AIExportFormatDesc` 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 AIExportFormatDesc`	`calloc()` Returns a new `AIExportFormatDesc` instance allocated with `memCalloc`.
`static AIExportFormatDesc.Buffer`	`calloc(int capacity)` Returns a new `AIExportFormatDesc.Buffer` instance allocated with `memCalloc`.
`static AIExportFormatDesc`	`callocStack()` Returns a new `AIExportFormatDesc` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static AIExportFormatDesc.Buffer`	`callocStack(int capacity)` Returns a new `AIExportFormatDesc.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static AIExportFormatDesc.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `AIExportFormatDesc.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static AIExportFormatDesc`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `AIExportFormatDesc` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static AIExportFormatDesc`	`create()` Returns a new `AIExportFormatDesc` instance allocated with `BufferUtils`.
`static AIExportFormatDesc.Buffer`	`create(int capacity)` Returns a new `AIExportFormatDesc.Buffer` instance allocated with `BufferUtils`.
`static AIExportFormatDesc`	`create(long address)` Returns a new `AIExportFormatDesc` instance for the specified memory address.
`static AIExportFormatDesc.Buffer`	`create(long address, int capacity)` Create a `AIExportFormatDesc.Buffer` instance at the specified memory.
`static AIExportFormatDesc`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static AIExportFormatDesc.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`java.nio.ByteBuffer`	`description()` Returns a `ByteBuffer` view of the null-terminated string pointed to by the `description` field.
`AIExportFormatDesc`	`description(java.nio.ByteBuffer value)` Sets the address of the specified encoded string to the `description` field.
`java.lang.String`	`descriptionString()` Decodes the null-terminated string pointed to by the `description` field.
`java.nio.ByteBuffer`	`fileExtension()` Returns a `ByteBuffer` view of the null-terminated string pointed to by the `fileExtension` field.
`AIExportFormatDesc`	`fileExtension(java.nio.ByteBuffer value)` Sets the address of the specified encoded string to the `fileExtension` field.
`java.lang.String`	`fileExtensionString()` Decodes the null-terminated string pointed to by the `fileExtension` field.
`java.nio.ByteBuffer`	`id()` Returns a `ByteBuffer` view of the null-terminated string pointed to by the `id` field.
`AIExportFormatDesc`	`id(java.nio.ByteBuffer value)` Sets the address of the specified encoded string to the `id` field.
`java.lang.String`	`idString()` Decodes the null-terminated string pointed to by the `id` field.
`static AIExportFormatDesc`	`malloc()` Returns a new `AIExportFormatDesc` instance allocated with `memAlloc`.
`static AIExportFormatDesc.Buffer`	`malloc(int capacity)` Returns a new `AIExportFormatDesc.Buffer` instance allocated with `memAlloc`.
`static AIExportFormatDesc`	`mallocStack()` Returns a new `AIExportFormatDesc` instance allocated on the thread-local `MemoryStack`.
`static AIExportFormatDesc.Buffer`	`mallocStack(int capacity)` Returns a new `AIExportFormatDesc.Buffer` instance allocated on the thread-local `MemoryStack`.
`static AIExportFormatDesc.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `AIExportFormatDesc.Buffer` instance allocated on the specified `MemoryStack`.
`static AIExportFormatDesc`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `AIExportFormatDesc` instance allocated on the specified `MemoryStack`.
`static java.nio.ByteBuffer`	`ndescription(long struct)` Unsafe version of `description()`.
`static void`	`ndescription(long struct, java.nio.ByteBuffer value)` Unsafe version of `description`.
`static java.lang.String`	`ndescriptionString(long struct)` Unsafe version of `descriptionString()`.
`static java.nio.ByteBuffer`	`nfileExtension(long struct)` Unsafe version of `fileExtension()`.
`static void`	`nfileExtension(long struct, java.nio.ByteBuffer value)` Unsafe version of `fileExtension`.
`static java.lang.String`	`nfileExtensionString(long struct)` Unsafe version of `fileExtensionString()`.
`static java.nio.ByteBuffer`	`nid(long struct)` Unsafe version of `id()`.
`static void`	`nid(long struct, java.nio.ByteBuffer value)` Unsafe version of `id`.
`static java.lang.String`	`nidString(long struct)` Unsafe version of `idString()`.
`AIExportFormatDesc`	`set(AIExportFormatDesc src)` Copies the specified struct data to this struct.
`AIExportFormatDesc`	`set(java.nio.ByteBuffer id, java.nio.ByteBuffer description, java.nio.ByteBuffer fileExtension)` Initializes this struct with the specified values.
`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.
  - ID
```
public static final int ID
```
    The struct member offsets.
  - DESCRIPTION
```
public static final int DESCRIPTION
```
    The struct member offsets.
  - FILEEXTENSION
```
public static final int FILEEXTENSION
```
    The struct member offsets.
- Constructor Detail
  - AIExportFormatDesc
```
public AIExportFormatDesc(java.nio.ByteBuffer container)
```
    Creates a AIExportFormatDesc 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
  - id
```
public java.nio.ByteBuffer id()
```
    Returns a ByteBuffer view of the null-terminated string pointed to by the id field.
  - idString
```
public java.lang.String idString()
```
    Decodes the null-terminated string pointed to by the id field.
  - description
```
public java.nio.ByteBuffer description()
```
    Returns a ByteBuffer view of the null-terminated string pointed to by the description field.
  - descriptionString
```
public java.lang.String descriptionString()
```
    Decodes the null-terminated string pointed to by the description field.
  - fileExtension
```
public java.nio.ByteBuffer fileExtension()
```
    Returns a ByteBuffer view of the null-terminated string pointed to by the fileExtension field.
  - fileExtensionString
```
public java.lang.String fileExtensionString()
```
    Decodes the null-terminated string pointed to by the fileExtension field.
  - id
```
public AIExportFormatDesc id(java.nio.ByteBuffer value)
```
    Sets the address of the specified encoded string to the id field.
  - description
```
public AIExportFormatDesc description(java.nio.ByteBuffer value)
```
    Sets the address of the specified encoded string to the description field.
  - fileExtension
```
public AIExportFormatDesc fileExtension(java.nio.ByteBuffer value)
```
    Sets the address of the specified encoded string to the fileExtension field.
  - set
```
public AIExportFormatDesc set(java.nio.ByteBuffer id,
                              java.nio.ByteBuffer description,
                              java.nio.ByteBuffer fileExtension)
```
    Initializes this struct with the specified values.
  - set
```
public AIExportFormatDesc set(AIExportFormatDesc src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static AIExportFormatDesc malloc()
```
    Returns a new AIExportFormatDesc instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static AIExportFormatDesc calloc()
```
    Returns a new AIExportFormatDesc instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static AIExportFormatDesc create()
```
    Returns a new AIExportFormatDesc instance allocated with BufferUtils.
  - create
```
public static AIExportFormatDesc create(long address)
```
    Returns a new AIExportFormatDesc instance for the specified memory address.
  - createSafe
```
@Nullable
public static AIExportFormatDesc createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static AIExportFormatDesc.Buffer malloc(int capacity)
```
    Returns a new AIExportFormatDesc.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static AIExportFormatDesc.Buffer calloc(int capacity)
```
    Returns a new AIExportFormatDesc.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static AIExportFormatDesc.Buffer create(int capacity)
```
    Returns a new AIExportFormatDesc.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static AIExportFormatDesc.Buffer create(long address,
                                               int capacity)
```
    Create a AIExportFormatDesc.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static AIExportFormatDesc.Buffer createSafe(long address,
                                                             int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static AIExportFormatDesc mallocStack()
```
    Returns a new AIExportFormatDesc instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static AIExportFormatDesc callocStack()
```
    Returns a new AIExportFormatDesc instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static AIExportFormatDesc mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new AIExportFormatDesc instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static AIExportFormatDesc callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new AIExportFormatDesc instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static AIExportFormatDesc.Buffer mallocStack(int capacity)
```
    Returns a new AIExportFormatDesc.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static AIExportFormatDesc.Buffer callocStack(int capacity)
```
    Returns a new AIExportFormatDesc.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static AIExportFormatDesc.Buffer mallocStack(int capacity,
                                                    org.lwjgl.system.MemoryStack stack)
```
    Returns a new AIExportFormatDesc.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static AIExportFormatDesc.Buffer callocStack(int capacity,
                                                    org.lwjgl.system.MemoryStack stack)
```
    Returns a new AIExportFormatDesc.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
  - nid
```
public static java.nio.ByteBuffer nid(long struct)
```
    Unsafe version of id().
  - nidString
```
public static java.lang.String nidString(long struct)
```
    Unsafe version of idString().
  - ndescription
```
public static java.nio.ByteBuffer ndescription(long struct)
```
    Unsafe version of description().
  - ndescriptionString
```
public static java.lang.String ndescriptionString(long struct)
```
    Unsafe version of descriptionString().
  - nfileExtension
```
public static java.nio.ByteBuffer nfileExtension(long struct)
```
    Unsafe version of fileExtension().
  - nfileExtensionString
```
public static java.lang.String nfileExtensionString(long struct)
```
    Unsafe version of fileExtensionString().
  - nid
```
public static void nid(long struct,
                       java.nio.ByteBuffer value)
```
    Unsafe version of id.
  - ndescription
```
public static void ndescription(long struct,
                                java.nio.ByteBuffer value)
```
    Unsafe version of description.
  - nfileExtension
```
public static void nfileExtension(long struct,
                                  java.nio.ByteBuffer value)
```
    Unsafe version of fileExtension.
  - 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 AIExportFormatDesc

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

ID

DESCRIPTION

FILEEXTENSION

Constructor Detail

AIExportFormatDesc

Method Detail

sizeof

id

idString

description

descriptionString

fileExtension

fileExtensionString

id

description

fileExtension

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nid

nidString

ndescription

ndescriptionString

nfileExtension

nfileExtensionString

nid

ndescription

nfileExtension

validate

validate