Package org.lwjgl.assimp
Class AIExportFormatDesc
- 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. UseGetExportFormatCount
to learn how many export formats the current Assimp build supports andGetExportFormatDescription
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 callingExportScene
. 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 Description static class
AIExportFormatDesc.Buffer
An array ofAIExportFormatDesc
structs.
-
Field Summary
Fields Modifier and Type Field Description static int
ALIGNOF
The struct alignment in bytes.static int
DESCRIPTION
FILEEXTENSION
IDThe struct member offsets.static int
SIZEOF
The struct size in bytes.
-
Constructor Summary
Constructors Constructor Description AIExportFormatDesc(java.nio.ByteBuffer container)
Creates aAIExportFormatDesc
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static AIExportFormatDesc
calloc()
Returns a newAIExportFormatDesc
instance allocated withmemCalloc
.static AIExportFormatDesc.Buffer
calloc(int capacity)
Returns a newAIExportFormatDesc.Buffer
instance allocated withmemCalloc
.static AIExportFormatDesc
callocStack()
Returns a newAIExportFormatDesc
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static AIExportFormatDesc.Buffer
callocStack(int capacity)
Returns a newAIExportFormatDesc.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static AIExportFormatDesc.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newAIExportFormatDesc.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static AIExportFormatDesc
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newAIExportFormatDesc
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static AIExportFormatDesc
create()
Returns a newAIExportFormatDesc
instance allocated withBufferUtils
.static AIExportFormatDesc.Buffer
create(int capacity)
Returns a newAIExportFormatDesc.Buffer
instance allocated withBufferUtils
.static AIExportFormatDesc
create(long address)
Returns a newAIExportFormatDesc
instance for the specified memory address.static AIExportFormatDesc.Buffer
create(long address, int capacity)
Create aAIExportFormatDesc.Buffer
instance at the specified memory.static AIExportFormatDesc
createSafe(long address)
static AIExportFormatDesc.Buffer
createSafe(long address, int capacity)
java.nio.ByteBuffer
description()
Returns aByteBuffer
view of the null-terminated string pointed to by thedescription
field.AIExportFormatDesc
description(java.nio.ByteBuffer value)
Sets the address of the specified encoded string to thedescription
field.java.lang.String
descriptionString()
Decodes the null-terminated string pointed to by thedescription
field.java.nio.ByteBuffer
fileExtension()
Returns aByteBuffer
view of the null-terminated string pointed to by thefileExtension
field.AIExportFormatDesc
fileExtension(java.nio.ByteBuffer value)
Sets the address of the specified encoded string to thefileExtension
field.java.lang.String
fileExtensionString()
Decodes the null-terminated string pointed to by thefileExtension
field.java.nio.ByteBuffer
id()
Returns aByteBuffer
view of the null-terminated string pointed to by theid
field.AIExportFormatDesc
id(java.nio.ByteBuffer value)
Sets the address of the specified encoded string to theid
field.java.lang.String
idString()
Decodes the null-terminated string pointed to by theid
field.static AIExportFormatDesc
malloc()
Returns a newAIExportFormatDesc
instance allocated withmemAlloc
.static AIExportFormatDesc.Buffer
malloc(int capacity)
Returns a newAIExportFormatDesc.Buffer
instance allocated withmemAlloc
.static AIExportFormatDesc
mallocStack()
Returns a newAIExportFormatDesc
instance allocated on the thread-localMemoryStack
.static AIExportFormatDesc.Buffer
mallocStack(int capacity)
Returns a newAIExportFormatDesc.Buffer
instance allocated on the thread-localMemoryStack
.static AIExportFormatDesc.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newAIExportFormatDesc.Buffer
instance allocated on the specifiedMemoryStack
.static AIExportFormatDesc
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newAIExportFormatDesc
instance allocated on the specifiedMemoryStack
.static java.nio.ByteBuffer
ndescription(long struct)
Unsafe version ofdescription()
.static void
ndescription(long struct, java.nio.ByteBuffer value)
Unsafe version ofdescription
.static java.lang.String
ndescriptionString(long struct)
Unsafe version ofdescriptionString()
.static java.nio.ByteBuffer
nfileExtension(long struct)
Unsafe version offileExtension()
.static void
nfileExtension(long struct, java.nio.ByteBuffer value)
Unsafe version offileExtension
.static java.lang.String
nfileExtensionString(long struct)
Unsafe version offileExtensionString()
.static java.nio.ByteBuffer
nid(long struct)
Unsafe version ofid()
.static void
nid(long struct, java.nio.ByteBuffer value)
Unsafe version ofid
.static java.lang.String
nidString(long struct)
Unsafe version ofidString()
.AIExportFormatDesc
set(java.nio.ByteBuffer id, java.nio.ByteBuffer description, java.nio.ByteBuffer fileExtension)
Initializes this struct with the specified values.AIExportFormatDesc
set(AIExportFormatDesc src)
Copies the specified struct data to this struct.int
sizeof()
static void
validate(long struct)
Validates pointer members that should not beNULL
.static void
validate(long array, int count)
Callsvalidate(long)
for each struct contained in the specified struct array.
-
-
-
Constructor Detail
-
AIExportFormatDesc
public AIExportFormatDesc(java.nio.ByteBuffer container)
Creates aAIExportFormatDesc
instance at the current position of the specifiedByteBuffer
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 classorg.lwjgl.system.Struct
-
id
public java.nio.ByteBuffer id()
Returns aByteBuffer
view of the null-terminated string pointed to by theid
field.
-
idString
public java.lang.String idString()
Decodes the null-terminated string pointed to by theid
field.
-
description
public java.nio.ByteBuffer description()
Returns aByteBuffer
view of the null-terminated string pointed to by thedescription
field.
-
descriptionString
public java.lang.String descriptionString()
Decodes the null-terminated string pointed to by thedescription
field.
-
fileExtension
public java.nio.ByteBuffer fileExtension()
Returns aByteBuffer
view of the null-terminated string pointed to by thefileExtension
field.
-
fileExtensionString
public java.lang.String fileExtensionString()
Decodes the null-terminated string pointed to by thefileExtension
field.
-
id
public AIExportFormatDesc id(java.nio.ByteBuffer value)
Sets the address of the specified encoded string to theid
field.
-
description
public AIExportFormatDesc description(java.nio.ByteBuffer value)
Sets the address of the specified encoded string to thedescription
field.
-
fileExtension
public AIExportFormatDesc fileExtension(java.nio.ByteBuffer value)
Sets the address of the specified encoded string to thefileExtension
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 newAIExportFormatDesc
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static AIExportFormatDesc calloc()
Returns a newAIExportFormatDesc
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static AIExportFormatDesc create()
Returns a newAIExportFormatDesc
instance allocated withBufferUtils
.
-
create
public static AIExportFormatDesc create(long address)
Returns a newAIExportFormatDesc
instance for the specified memory address.
-
createSafe
@Nullable public static AIExportFormatDesc createSafe(long address)
-
malloc
public static AIExportFormatDesc.Buffer malloc(int capacity)
Returns a newAIExportFormatDesc.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static AIExportFormatDesc.Buffer calloc(int capacity)
Returns a newAIExportFormatDesc.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static AIExportFormatDesc.Buffer create(int capacity)
Returns a newAIExportFormatDesc.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static AIExportFormatDesc.Buffer create(long address, int capacity)
Create aAIExportFormatDesc.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static AIExportFormatDesc.Buffer createSafe(long address, int capacity)
-
mallocStack
public static AIExportFormatDesc mallocStack()
Returns a newAIExportFormatDesc
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static AIExportFormatDesc callocStack()
Returns a newAIExportFormatDesc
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static AIExportFormatDesc mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newAIExportFormatDesc
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static AIExportFormatDesc callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newAIExportFormatDesc
instance allocated on the specifiedMemoryStack
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 newAIExportFormatDesc.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static AIExportFormatDesc.Buffer callocStack(int capacity)
Returns a newAIExportFormatDesc.Buffer
instance allocated on the thread-localMemoryStack
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 newAIExportFormatDesc.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static AIExportFormatDesc.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newAIExportFormatDesc.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
nid
public static java.nio.ByteBuffer nid(long struct)
Unsafe version ofid()
.
-
nidString
public static java.lang.String nidString(long struct)
Unsafe version ofidString()
.
-
ndescription
public static java.nio.ByteBuffer ndescription(long struct)
Unsafe version ofdescription()
.
-
ndescriptionString
public static java.lang.String ndescriptionString(long struct)
Unsafe version ofdescriptionString()
.
-
nfileExtension
public static java.nio.ByteBuffer nfileExtension(long struct)
Unsafe version offileExtension()
.
-
nfileExtensionString
public static java.lang.String nfileExtensionString(long struct)
Unsafe version offileExtensionString()
.
-
nid
public static void nid(long struct, java.nio.ByteBuffer value)
Unsafe version ofid
.
-
ndescription
public static void ndescription(long struct, java.nio.ByteBuffer value)
Unsafe version ofdescription
.
-
nfileExtension
public static void nfileExtension(long struct, java.nio.ByteBuffer value)
Unsafe version offileExtension
.
-
validate
public static void validate(long struct)
Validates pointer members that should not beNULL
.- Parameters:
struct
- the struct to validate
-
validate
public static void validate(long array, int count)
Callsvalidate(long)
for each struct contained in the specified struct array.- Parameters:
array
- the struct array to validatecount
- the number of structs inarray
-
-