Top Description Inners Fields Constructors Methods
org.lwjgl.assimp

public Class AIExportFormatDesc

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

Describes an file format which Assimp can export to. Use GetExportFormatCount to learn how many export-formats are supported by the current Assimp-build and GetExportFormatDescription to retrieve the description of the export format option.

Layout


struct aiExportFormatDesc {
    char const * id;
    char const * description;
    char const * fileExtension;
}

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
DESCRIPTION

The struct member offsets.

public static final int
FILEEXTENSION

The struct member offsets.

public static final int
ID

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

public
AIExportFormatDesc(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static AIExportFormatDesc
calloc()

Returns a new AIExportFormatDesc instance allocated with memCalloc.

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

Returns a new AIExportFormatDesc.Buffer instance allocated with memCalloc.

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

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

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

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

public static AIExportFormatDesc
callocStack()

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

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

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

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

Returns a new AIExportFormatDesc instance allocated with BufferUtils.

public static AIExportFormatDesc
create(long address)

Returns a new AIExportFormatDesc instance for the specified memory address.

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

Returns a new AIExportFormatDesc.Buffer instance allocated with BufferUtils.

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

Create a AIExportFormatDesc.Buffer instance at the specified memory.

public static AIExportFormatDesc
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public ByteBuffer
description()

A short description of the file format to present to users.

public AIExportFormatDesc
description(ByteBuffer value)

Sets the address of the specified encoded string to the description field.

public String
descriptionString()

A short description of the file format to present to users.

public ByteBuffer
fileExtension()

Recommended file extension for the exported file in lower case.

public AIExportFormatDesc
fileExtension(ByteBuffer value)

Sets the address of the specified encoded string to the fileExtension field.

public String
fileExtensionString()

Recommended file extension for the exported file in lower case.

public ByteBuffer
id()

a short string ID to uniquely identify the export format.

public AIExportFormatDesc
id(ByteBuffer value)

Sets the address of the specified encoded string to the id field.

public String
idString()

a short string ID to uniquely identify the export format.

public static AIExportFormatDesc
malloc()

Returns a new AIExportFormatDesc instance allocated with memAlloc.

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

Returns a new AIExportFormatDesc.Buffer instance allocated with memAlloc.

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

Returns a new AIExportFormatDesc instance allocated on the specified MemoryStack.

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

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

public static AIExportFormatDesc
mallocStack()

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

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

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

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

Unsafe version of description.

public static void
ndescription(long struct, ByteBuffer value)

Unsafe version of description.

public static String
ndescriptionString(long struct)

Unsafe version of descriptionString.

public static ByteBuffer
nfileExtension(long struct)

Unsafe version of fileExtension.

public static void
nfileExtension(long struct, ByteBuffer value)

Unsafe version of fileExtension.

public static String
nfileExtensionString(long struct)

Unsafe version of fileExtensionString.

public static ByteBuffer
nid(long struct)

Unsafe version of id.

public static void
nid(long struct, ByteBuffer value)

Unsafe version of id.

public static String
nidString(long struct)

Unsafe version of idString.

public AIExportFormatDesc
set(ByteBuffer id, ByteBuffer description, ByteBuffer fileExtension)

Initializes this struct with the specified values.

public AIExportFormatDesc

Returns:

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

DESCRIPTIONback to summary
public static final int DESCRIPTION

The struct member offsets.

FILEEXTENSIONback to summary
public static final int FILEEXTENSION

The struct member offsets.

IDback to summary
public static final int ID

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

AIExportFormatDescback to summary
protected AIExportFormatDesc(long address, ByteBuffer container)
AIExportFormatDescback to summary
public AIExportFormatDesc(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

callocback to summary
public static AIExportFormatDesc calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static AIExportFormatDesc calloc(MemoryStack stack)

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Returns a new AIExportFormatDesc instance allocated with BufferUtils.

createback to summary
public static AIExportFormatDesc create(long address)

Returns a new AIExportFormatDesc instance for the specified memory address.

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

Returns a new AIExportFormatDesc.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a AIExportFormatDesc.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static AIExportFormatDesc createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
descriptionback to summary
public ByteBuffer 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.

Annotations
@NativeType:char const *
descriptionback to summary
public AIExportFormatDesc description(ByteBuffer value)

Sets the address of the specified encoded string to the description field.

descriptionStringback to summary
public String descriptionString()

A short description of the file format to present to users. Useful if you want to allow the user to select an export format.

Annotations
@NativeType:char const *
fileExtensionback to summary
public ByteBuffer fileExtension()

Recommended file extension for the exported file in lower case.

Annotations
@NativeType:char const *
fileExtensionback to summary
public AIExportFormatDesc fileExtension(ByteBuffer value)

Sets the address of the specified encoded string to the fileExtension field.

fileExtensionStringback to summary
public String fileExtensionString()

Recommended file extension for the exported file in lower case.

Annotations
@NativeType:char const *
idback to summary
public ByteBuffer 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"

Annotations
@NativeType:char const *
idback to summary
public AIExportFormatDesc id(ByteBuffer value)

Sets the address of the specified encoded string to the id field.

idStringback to summary
public String idString()

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"

Annotations
@NativeType:char const *
mallocback to summary
public static AIExportFormatDesc malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static AIExportFormatDesc malloc(MemoryStack stack)

Returns a new AIExportFormatDesc instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
ndescriptionback to summary
public static ByteBuffer ndescription(long struct)

Unsafe version of description.

ndescriptionback to summary
public static void ndescription(long struct, ByteBuffer value)

Unsafe version of description.

ndescriptionStringback to summary
public static String ndescriptionString(long struct)

Unsafe version of descriptionString.

nfileExtensionback to summary
public static ByteBuffer nfileExtension(long struct)

Unsafe version of fileExtension.

nfileExtensionback to summary
public static void nfileExtension(long struct, ByteBuffer value)

Unsafe version of fileExtension.

nfileExtensionStringback to summary
public static String nfileExtensionString(long struct)

Unsafe version of fileExtensionString.

nidback to summary
public static ByteBuffer nid(long struct)

Unsafe version of id.

nidback to summary
public static void nid(long struct, ByteBuffer value)

Unsafe version of id.

nidStringback to summary
public static String nidString(long struct)

Unsafe version of idString.

setback to summary
public AIExportFormatDesc set(ByteBuffer id, ByteBuffer description, ByteBuffer fileExtension)

Initializes this struct with the specified values.

setback to summary
public AIExportFormatDesc set(AIExportFormatDesc src)

Copies the specified struct data to this struct.

Parameters
src:AIExportFormatDesc

the source struct

Returns:AIExportFormatDesc

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
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 AIExportFormatDesc.Buffer

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

An array of AIExportFormatDesc structs.

Field Summary

Modifier and TypeField and Description
private static final AIExportFormatDesc

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new AIExportFormatDesc.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 null-terminated string pointed to by the AIExportFormatDesc#description field.
description
()

public AIExportFormatDesc.Buffer
description(ByteBuffer value)

Sets the address of the specified encoded string to the AIExportFormatDesc#description field.

public String

Returns:

the null-terminated string pointed to by the AIExportFormatDesc#description field.
descriptionString
()

public ByteBuffer

Returns:

a ByteBuffer view of the null-terminated string pointed to by the AIExportFormatDesc#fileExtension field.
fileExtension
()

public AIExportFormatDesc.Buffer
fileExtension(ByteBuffer value)

Sets the address of the specified encoded string to the AIExportFormatDesc#fileExtension field.

public String

Returns:

the null-terminated string pointed to by the AIExportFormatDesc#fileExtension field.
fileExtensionString
()

protected AIExportFormatDesc
public ByteBuffer

Returns:

a ByteBuffer view of the null-terminated string pointed to by the AIExportFormatDesc#id field.
id
()

public AIExportFormatDesc.Buffer
id(ByteBuffer value)

Sets the address of the specified encoded string to the AIExportFormatDesc#id field.

public String

Returns:

the null-terminated string pointed to by the AIExportFormatDesc#id field.
idString
()

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

Field Detail

ELEMENT_FACTORYback to summary
private static final AIExportFormatDesc ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

descriptionback to summary
public ByteBuffer description()
Returns:ByteBuffer

a ByteBuffer view of the null-terminated string pointed to by the AIExportFormatDesc#description field.

Annotations
@NativeType:char const *
descriptionback to summary
public AIExportFormatDesc.Buffer description(ByteBuffer value)

Sets the address of the specified encoded string to the AIExportFormatDesc#description field.

descriptionStringback to summary
public String descriptionString()
Returns:String

the null-terminated string pointed to by the AIExportFormatDesc#description field.

Annotations
@NativeType:char const *
fileExtensionback to summary
public ByteBuffer fileExtension()
Returns:ByteBuffer

a ByteBuffer view of the null-terminated string pointed to by the AIExportFormatDesc#fileExtension field.

Annotations
@NativeType:char const *
fileExtensionback to summary
public AIExportFormatDesc.Buffer fileExtension(ByteBuffer value)

Sets the address of the specified encoded string to the AIExportFormatDesc#fileExtension field.

fileExtensionStringback to summary
public String fileExtensionString()
Returns:String

the null-terminated string pointed to by the AIExportFormatDesc#fileExtension field.

Annotations
@NativeType:char const *
getElementFactoryback to summary
protected AIExportFormatDesc getElementFactory()

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

Annotations
@Override
idback to summary
public ByteBuffer id()
Returns:ByteBuffer

a ByteBuffer view of the null-terminated string pointed to by the AIExportFormatDesc#id field.

Annotations
@NativeType:char const *
idback to summary
public AIExportFormatDesc.Buffer id(ByteBuffer value)

Sets the address of the specified encoded string to the AIExportFormatDesc#id field.

idStringback to summary
public String idString()
Returns:String

the null-terminated string pointed to by the AIExportFormatDesc#id field.

Annotations
@NativeType:char const *
selfback to summary
protected AIExportFormatDesc.Buffer self()

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

Annotations
@Override