Package org.lwjgl.assimp
Class AIImporterDesc
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.assimp.AIImporterDesc
-
- All Implemented Interfaces:
java.lang.AutoCloseable
,org.lwjgl.system.NativeResource
,org.lwjgl.system.Pointer
public class AIImporterDesc extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResource
Meta information about a particular importer. Importers need to fill this structure, but they can freely decide how talkative they are. A common use case for loader meta info is a user interface in which the user can choose between various import/export file formats. Building such an UI by hand means a lot of maintenance as importers / exporters are added to Assimp, so it might be useful to have a common mechanism to query some rough importer characteristics.Member documentation
mName
– Full name of the importer (i.e. Blender3D importer)mAuthor
– Original author (left blank if unknown or whole assimp team)mMaintainer
– Current maintainer, left blank if the author maintainsmComments
– Implementation comments, i.e. unimplemented featuresmFlags
– These flags indicate some characteristics common to many importers.mMinMajor
– Minimum major format that can be loaded in major.minor style.mMinMinor
– Minimum minor format that can be loaded in major.minor style.mMaxMajor
– Maximum major format that can be loaded in major.minor style.mMaxMinor
– Maximum minor format that can be loaded in major.minor style.mFileExtensions
– List of file extensions this importer can handle. List entries are separated by space characters. All entries are lower case without a leading dot (i.e. "xml dae" would be a valid value. Note that multiple importers may respond to the same file extension - assimp calls all importers in the order in which they are registered and each importer gets the opportunity to load the file until one importer "claims" the file. Apart from file extension checks, importers typically use other methods to quickly reject files (i.e. magic words) so this does not mean that common or generic file extensions such as XML would be tediously slow.
Layout
struct aiImporterDesc { char const * mName; char const * mAuthor; char const * mMaintainer; char const * mComments; unsigned int mFlags; unsigned int mMinMajor; unsigned int mMinMinor; unsigned int mMaxMajor; unsigned int mMaxMinor; char const * mFileExtensions; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
AIImporterDesc.Buffer
An array ofAIImporterDesc
structs.
-
Constructor Summary
Constructors Constructor Description AIImporterDesc(java.nio.ByteBuffer container)
Creates aAIImporterDesc
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 AIImporterDesc
calloc()
Returns a newAIImporterDesc
instance allocated withmemCalloc
.static AIImporterDesc.Buffer
calloc(int capacity)
Returns a newAIImporterDesc.Buffer
instance allocated withmemCalloc
.static AIImporterDesc
callocStack()
Returns a newAIImporterDesc
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static AIImporterDesc.Buffer
callocStack(int capacity)
Returns a newAIImporterDesc.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static AIImporterDesc.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newAIImporterDesc.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static AIImporterDesc
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newAIImporterDesc
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static AIImporterDesc
create()
Returns a newAIImporterDesc
instance allocated withBufferUtils
.static AIImporterDesc.Buffer
create(int capacity)
Returns a newAIImporterDesc.Buffer
instance allocated withBufferUtils
.static AIImporterDesc
create(long address)
Returns a newAIImporterDesc
instance for the specified memory address.static AIImporterDesc.Buffer
create(long address, int capacity)
Create aAIImporterDesc.Buffer
instance at the specified memory.static AIImporterDesc
createSafe(long address)
static AIImporterDesc.Buffer
createSafe(long address, int capacity)
static AIImporterDesc
malloc()
Returns a newAIImporterDesc
instance allocated withmemAlloc
.static AIImporterDesc.Buffer
malloc(int capacity)
Returns a newAIImporterDesc.Buffer
instance allocated withmemAlloc
.static AIImporterDesc
mallocStack()
Returns a newAIImporterDesc
instance allocated on the thread-localMemoryStack
.static AIImporterDesc.Buffer
mallocStack(int capacity)
Returns a newAIImporterDesc.Buffer
instance allocated on the thread-localMemoryStack
.static AIImporterDesc.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newAIImporterDesc.Buffer
instance allocated on the specifiedMemoryStack
.static AIImporterDesc
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newAIImporterDesc
instance allocated on the specifiedMemoryStack
.java.nio.ByteBuffer
mAuthor()
Returns aByteBuffer
view of the null-terminated string pointed to by themAuthor
field.AIImporterDesc
mAuthor(java.nio.ByteBuffer value)
Sets the address of the specified encoded string to themAuthor
field.java.lang.String
mAuthorString()
Decodes the null-terminated string pointed to by themAuthor
field.java.nio.ByteBuffer
mComments()
Returns aByteBuffer
view of the null-terminated string pointed to by themComments
field.AIImporterDesc
mComments(java.nio.ByteBuffer value)
Sets the address of the specified encoded string to themComments
field.java.lang.String
mCommentsString()
Decodes the null-terminated string pointed to by themComments
field.java.nio.ByteBuffer
mFileExtensions()
Returns aByteBuffer
view of the null-terminated string pointed to by themFileExtensions
field.AIImporterDesc
mFileExtensions(java.nio.ByteBuffer value)
Sets the address of the specified encoded string to themFileExtensions
field.java.lang.String
mFileExtensionsString()
Decodes the null-terminated string pointed to by themFileExtensions
field.int
mFlags()
Returns the value of themFlags
field.AIImporterDesc
mFlags(int value)
Sets the specified value to themFlags
field.java.nio.ByteBuffer
mMaintainer()
Returns aByteBuffer
view of the null-terminated string pointed to by themMaintainer
field.AIImporterDesc
mMaintainer(java.nio.ByteBuffer value)
Sets the address of the specified encoded string to themMaintainer
field.java.lang.String
mMaintainerString()
Decodes the null-terminated string pointed to by themMaintainer
field.int
mMaxMajor()
Returns the value of themMaxMajor
field.AIImporterDesc
mMaxMajor(int value)
Sets the specified value to themMaxMajor
field.int
mMaxMinor()
Returns the value of themMaxMinor
field.AIImporterDesc
mMaxMinor(int value)
Sets the specified value to themMaxMinor
field.int
mMinMajor()
Returns the value of themMinMajor
field.AIImporterDesc
mMinMajor(int value)
Sets the specified value to themMinMajor
field.int
mMinMinor()
Returns the value of themMinMinor
field.AIImporterDesc
mMinMinor(int value)
Sets the specified value to themMinMinor
field.java.nio.ByteBuffer
mName()
Returns aByteBuffer
view of the null-terminated string pointed to by themName
field.AIImporterDesc
mName(java.nio.ByteBuffer value)
Sets the address of the specified encoded string to themName
field.java.lang.String
mNameString()
Decodes the null-terminated string pointed to by themName
field.static java.nio.ByteBuffer
nmAuthor(long struct)
Unsafe version ofmAuthor()
.static void
nmAuthor(long struct, java.nio.ByteBuffer value)
Unsafe version ofmAuthor
.static java.lang.String
nmAuthorString(long struct)
Unsafe version ofmAuthorString()
.static java.nio.ByteBuffer
nmComments(long struct)
Unsafe version ofmComments()
.static void
nmComments(long struct, java.nio.ByteBuffer value)
Unsafe version ofmComments
.static java.lang.String
nmCommentsString(long struct)
Unsafe version ofmCommentsString()
.static java.nio.ByteBuffer
nmFileExtensions(long struct)
Unsafe version ofmFileExtensions()
.static void
nmFileExtensions(long struct, java.nio.ByteBuffer value)
Unsafe version ofmFileExtensions
.static java.lang.String
nmFileExtensionsString(long struct)
Unsafe version ofmFileExtensionsString()
.static int
nmFlags(long struct)
Unsafe version ofmFlags()
.static void
nmFlags(long struct, int value)
Unsafe version ofmFlags
.static java.nio.ByteBuffer
nmMaintainer(long struct)
Unsafe version ofmMaintainer()
.static void
nmMaintainer(long struct, java.nio.ByteBuffer value)
Unsafe version ofmMaintainer
.static java.lang.String
nmMaintainerString(long struct)
Unsafe version ofmMaintainerString()
.static int
nmMaxMajor(long struct)
Unsafe version ofmMaxMajor()
.static void
nmMaxMajor(long struct, int value)
Unsafe version ofmMaxMajor
.static int
nmMaxMinor(long struct)
Unsafe version ofmMaxMinor()
.static void
nmMaxMinor(long struct, int value)
Unsafe version ofmMaxMinor
.static int
nmMinMajor(long struct)
Unsafe version ofmMinMajor()
.static void
nmMinMajor(long struct, int value)
Unsafe version ofmMinMajor
.static int
nmMinMinor(long struct)
Unsafe version ofmMinMinor()
.static void
nmMinMinor(long struct, int value)
Unsafe version ofmMinMinor
.static java.nio.ByteBuffer
nmName(long struct)
Unsafe version ofmName()
.static void
nmName(long struct, java.nio.ByteBuffer value)
Unsafe version ofmName
.static java.lang.String
nmNameString(long struct)
Unsafe version ofmNameString()
.AIImporterDesc
set(java.nio.ByteBuffer mName, java.nio.ByteBuffer mAuthor, java.nio.ByteBuffer mMaintainer, java.nio.ByteBuffer mComments, int mFlags, int mMinMajor, int mMinMinor, int mMaxMajor, int mMaxMinor, java.nio.ByteBuffer mFileExtensions)
Initializes this struct with the specified values.AIImporterDesc
set(AIImporterDesc 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
-
AIImporterDesc
public AIImporterDesc(java.nio.ByteBuffer container)
Creates aAIImporterDesc
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
-
mName
public java.nio.ByteBuffer mName()
Returns aByteBuffer
view of the null-terminated string pointed to by themName
field.
-
mNameString
public java.lang.String mNameString()
Decodes the null-terminated string pointed to by themName
field.
-
mAuthor
public java.nio.ByteBuffer mAuthor()
Returns aByteBuffer
view of the null-terminated string pointed to by themAuthor
field.
-
mAuthorString
public java.lang.String mAuthorString()
Decodes the null-terminated string pointed to by themAuthor
field.
-
mMaintainer
public java.nio.ByteBuffer mMaintainer()
Returns aByteBuffer
view of the null-terminated string pointed to by themMaintainer
field.
-
mMaintainerString
public java.lang.String mMaintainerString()
Decodes the null-terminated string pointed to by themMaintainer
field.
-
mComments
public java.nio.ByteBuffer mComments()
Returns aByteBuffer
view of the null-terminated string pointed to by themComments
field.
-
mCommentsString
public java.lang.String mCommentsString()
Decodes the null-terminated string pointed to by themComments
field.
-
mFlags
public int mFlags()
Returns the value of themFlags
field.
-
mMinMajor
public int mMinMajor()
Returns the value of themMinMajor
field.
-
mMinMinor
public int mMinMinor()
Returns the value of themMinMinor
field.
-
mMaxMajor
public int mMaxMajor()
Returns the value of themMaxMajor
field.
-
mMaxMinor
public int mMaxMinor()
Returns the value of themMaxMinor
field.
-
mFileExtensions
public java.nio.ByteBuffer mFileExtensions()
Returns aByteBuffer
view of the null-terminated string pointed to by themFileExtensions
field.
-
mFileExtensionsString
public java.lang.String mFileExtensionsString()
Decodes the null-terminated string pointed to by themFileExtensions
field.
-
mName
public AIImporterDesc mName(java.nio.ByteBuffer value)
Sets the address of the specified encoded string to themName
field.
-
mAuthor
public AIImporterDesc mAuthor(java.nio.ByteBuffer value)
Sets the address of the specified encoded string to themAuthor
field.
-
mMaintainer
public AIImporterDesc mMaintainer(java.nio.ByteBuffer value)
Sets the address of the specified encoded string to themMaintainer
field.
-
mComments
public AIImporterDesc mComments(java.nio.ByteBuffer value)
Sets the address of the specified encoded string to themComments
field.
-
mFlags
public AIImporterDesc mFlags(int value)
Sets the specified value to themFlags
field.
-
mMinMajor
public AIImporterDesc mMinMajor(int value)
Sets the specified value to themMinMajor
field.
-
mMinMinor
public AIImporterDesc mMinMinor(int value)
Sets the specified value to themMinMinor
field.
-
mMaxMajor
public AIImporterDesc mMaxMajor(int value)
Sets the specified value to themMaxMajor
field.
-
mMaxMinor
public AIImporterDesc mMaxMinor(int value)
Sets the specified value to themMaxMinor
field.
-
mFileExtensions
public AIImporterDesc mFileExtensions(java.nio.ByteBuffer value)
Sets the address of the specified encoded string to themFileExtensions
field.
-
set
public AIImporterDesc set(java.nio.ByteBuffer mName, java.nio.ByteBuffer mAuthor, java.nio.ByteBuffer mMaintainer, java.nio.ByteBuffer mComments, int mFlags, int mMinMajor, int mMinMinor, int mMaxMajor, int mMaxMinor, java.nio.ByteBuffer mFileExtensions)
Initializes this struct with the specified values.
-
set
public AIImporterDesc set(AIImporterDesc src)
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
public static AIImporterDesc malloc()
Returns a newAIImporterDesc
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static AIImporterDesc calloc()
Returns a newAIImporterDesc
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static AIImporterDesc create()
Returns a newAIImporterDesc
instance allocated withBufferUtils
.
-
create
public static AIImporterDesc create(long address)
Returns a newAIImporterDesc
instance for the specified memory address.
-
createSafe
@Nullable public static AIImporterDesc createSafe(long address)
-
malloc
public static AIImporterDesc.Buffer malloc(int capacity)
Returns a newAIImporterDesc.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static AIImporterDesc.Buffer calloc(int capacity)
Returns a newAIImporterDesc.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static AIImporterDesc.Buffer create(int capacity)
Returns a newAIImporterDesc.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static AIImporterDesc.Buffer create(long address, int capacity)
Create aAIImporterDesc.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static AIImporterDesc.Buffer createSafe(long address, int capacity)
-
mallocStack
public static AIImporterDesc mallocStack()
Returns a newAIImporterDesc
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static AIImporterDesc callocStack()
Returns a newAIImporterDesc
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static AIImporterDesc mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newAIImporterDesc
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static AIImporterDesc callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newAIImporterDesc
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static AIImporterDesc.Buffer mallocStack(int capacity)
Returns a newAIImporterDesc.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static AIImporterDesc.Buffer callocStack(int capacity)
Returns a newAIImporterDesc.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static AIImporterDesc.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newAIImporterDesc.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static AIImporterDesc.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newAIImporterDesc.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
nmName
public static java.nio.ByteBuffer nmName(long struct)
Unsafe version ofmName()
.
-
nmNameString
public static java.lang.String nmNameString(long struct)
Unsafe version ofmNameString()
.
-
nmAuthor
public static java.nio.ByteBuffer nmAuthor(long struct)
Unsafe version ofmAuthor()
.
-
nmAuthorString
public static java.lang.String nmAuthorString(long struct)
Unsafe version ofmAuthorString()
.
-
nmMaintainer
public static java.nio.ByteBuffer nmMaintainer(long struct)
Unsafe version ofmMaintainer()
.
-
nmMaintainerString
public static java.lang.String nmMaintainerString(long struct)
Unsafe version ofmMaintainerString()
.
-
nmComments
public static java.nio.ByteBuffer nmComments(long struct)
Unsafe version ofmComments()
.
-
nmCommentsString
public static java.lang.String nmCommentsString(long struct)
Unsafe version ofmCommentsString()
.
-
nmFlags
public static int nmFlags(long struct)
Unsafe version ofmFlags()
.
-
nmMinMajor
public static int nmMinMajor(long struct)
Unsafe version ofmMinMajor()
.
-
nmMinMinor
public static int nmMinMinor(long struct)
Unsafe version ofmMinMinor()
.
-
nmMaxMajor
public static int nmMaxMajor(long struct)
Unsafe version ofmMaxMajor()
.
-
nmMaxMinor
public static int nmMaxMinor(long struct)
Unsafe version ofmMaxMinor()
.
-
nmFileExtensions
public static java.nio.ByteBuffer nmFileExtensions(long struct)
Unsafe version ofmFileExtensions()
.
-
nmFileExtensionsString
public static java.lang.String nmFileExtensionsString(long struct)
Unsafe version ofmFileExtensionsString()
.
-
nmName
public static void nmName(long struct, java.nio.ByteBuffer value)
Unsafe version ofmName
.
-
nmAuthor
public static void nmAuthor(long struct, java.nio.ByteBuffer value)
Unsafe version ofmAuthor
.
-
nmMaintainer
public static void nmMaintainer(long struct, java.nio.ByteBuffer value)
Unsafe version ofmMaintainer
.
-
nmComments
public static void nmComments(long struct, java.nio.ByteBuffer value)
Unsafe version ofmComments
.
-
nmFlags
public static void nmFlags(long struct, int value)
Unsafe version ofmFlags
.
-
nmMinMajor
public static void nmMinMajor(long struct, int value)
Unsafe version ofmMinMajor
.
-
nmMinMinor
public static void nmMinMinor(long struct, int value)
Unsafe version ofmMinMinor
.
-
nmMaxMajor
public static void nmMaxMajor(long struct, int value)
Unsafe version ofmMaxMajor
.
-
nmMaxMinor
public static void nmMaxMinor(long struct, int value)
Unsafe version ofmMaxMinor
.
-
nmFileExtensions
public static void nmFileExtensions(long struct, java.nio.ByteBuffer value)
Unsafe version ofmFileExtensions
.
-
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
-
-