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.NativeResourceMeta 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 classAIImporterDesc.BufferAn array ofAIImporterDescstructs.
-
Constructor Summary
Constructors Constructor Description AIImporterDesc(java.nio.ByteBuffer container)Creates aAIImporterDescinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static AIImporterDesccalloc()Returns a newAIImporterDescinstance allocated withmemCalloc.static AIImporterDesc.Buffercalloc(int capacity)Returns a newAIImporterDesc.Bufferinstance allocated withmemCalloc.static AIImporterDesccallocStack()Returns a newAIImporterDescinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static AIImporterDesc.BuffercallocStack(int capacity)Returns a newAIImporterDesc.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static AIImporterDesc.BuffercallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newAIImporterDesc.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static AIImporterDesccallocStack(org.lwjgl.system.MemoryStack stack)Returns a newAIImporterDescinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static AIImporterDesccreate()Returns a newAIImporterDescinstance allocated withBufferUtils.static AIImporterDesc.Buffercreate(int capacity)Returns a newAIImporterDesc.Bufferinstance allocated withBufferUtils.static AIImporterDesccreate(long address)Returns a newAIImporterDescinstance for the specified memory address.static AIImporterDesc.Buffercreate(long address, int capacity)Create aAIImporterDesc.Bufferinstance at the specified memory.static AIImporterDesccreateSafe(long address)static AIImporterDesc.BuffercreateSafe(long address, int capacity)static AIImporterDescmalloc()Returns a newAIImporterDescinstance allocated withmemAlloc.static AIImporterDesc.Buffermalloc(int capacity)Returns a newAIImporterDesc.Bufferinstance allocated withmemAlloc.static AIImporterDescmallocStack()Returns a newAIImporterDescinstance allocated on the thread-localMemoryStack.static AIImporterDesc.BuffermallocStack(int capacity)Returns a newAIImporterDesc.Bufferinstance allocated on the thread-localMemoryStack.static AIImporterDesc.BuffermallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newAIImporterDesc.Bufferinstance allocated on the specifiedMemoryStack.static AIImporterDescmallocStack(org.lwjgl.system.MemoryStack stack)Returns a newAIImporterDescinstance allocated on the specifiedMemoryStack.java.nio.ByteBuffermAuthor()Returns aByteBufferview of the null-terminated string pointed to by themAuthorfield.AIImporterDescmAuthor(java.nio.ByteBuffer value)Sets the address of the specified encoded string to themAuthorfield.java.lang.StringmAuthorString()Decodes the null-terminated string pointed to by themAuthorfield.java.nio.ByteBuffermComments()Returns aByteBufferview of the null-terminated string pointed to by themCommentsfield.AIImporterDescmComments(java.nio.ByteBuffer value)Sets the address of the specified encoded string to themCommentsfield.java.lang.StringmCommentsString()Decodes the null-terminated string pointed to by themCommentsfield.java.nio.ByteBuffermFileExtensions()Returns aByteBufferview of the null-terminated string pointed to by themFileExtensionsfield.AIImporterDescmFileExtensions(java.nio.ByteBuffer value)Sets the address of the specified encoded string to themFileExtensionsfield.java.lang.StringmFileExtensionsString()Decodes the null-terminated string pointed to by themFileExtensionsfield.intmFlags()Returns the value of themFlagsfield.AIImporterDescmFlags(int value)Sets the specified value to themFlagsfield.java.nio.ByteBuffermMaintainer()Returns aByteBufferview of the null-terminated string pointed to by themMaintainerfield.AIImporterDescmMaintainer(java.nio.ByteBuffer value)Sets the address of the specified encoded string to themMaintainerfield.java.lang.StringmMaintainerString()Decodes the null-terminated string pointed to by themMaintainerfield.intmMaxMajor()Returns the value of themMaxMajorfield.AIImporterDescmMaxMajor(int value)Sets the specified value to themMaxMajorfield.intmMaxMinor()Returns the value of themMaxMinorfield.AIImporterDescmMaxMinor(int value)Sets the specified value to themMaxMinorfield.intmMinMajor()Returns the value of themMinMajorfield.AIImporterDescmMinMajor(int value)Sets the specified value to themMinMajorfield.intmMinMinor()Returns the value of themMinMinorfield.AIImporterDescmMinMinor(int value)Sets the specified value to themMinMinorfield.java.nio.ByteBuffermName()Returns aByteBufferview of the null-terminated string pointed to by themNamefield.AIImporterDescmName(java.nio.ByteBuffer value)Sets the address of the specified encoded string to themNamefield.java.lang.StringmNameString()Decodes the null-terminated string pointed to by themNamefield.static java.nio.ByteBuffernmAuthor(long struct)Unsafe version ofmAuthor().static voidnmAuthor(long struct, java.nio.ByteBuffer value)Unsafe version ofmAuthor.static java.lang.StringnmAuthorString(long struct)Unsafe version ofmAuthorString().static java.nio.ByteBuffernmComments(long struct)Unsafe version ofmComments().static voidnmComments(long struct, java.nio.ByteBuffer value)Unsafe version ofmComments.static java.lang.StringnmCommentsString(long struct)Unsafe version ofmCommentsString().static java.nio.ByteBuffernmFileExtensions(long struct)Unsafe version ofmFileExtensions().static voidnmFileExtensions(long struct, java.nio.ByteBuffer value)Unsafe version ofmFileExtensions.static java.lang.StringnmFileExtensionsString(long struct)Unsafe version ofmFileExtensionsString().static intnmFlags(long struct)Unsafe version ofmFlags().static voidnmFlags(long struct, int value)Unsafe version ofmFlags.static java.nio.ByteBuffernmMaintainer(long struct)Unsafe version ofmMaintainer().static voidnmMaintainer(long struct, java.nio.ByteBuffer value)Unsafe version ofmMaintainer.static java.lang.StringnmMaintainerString(long struct)Unsafe version ofmMaintainerString().static intnmMaxMajor(long struct)Unsafe version ofmMaxMajor().static voidnmMaxMajor(long struct, int value)Unsafe version ofmMaxMajor.static intnmMaxMinor(long struct)Unsafe version ofmMaxMinor().static voidnmMaxMinor(long struct, int value)Unsafe version ofmMaxMinor.static intnmMinMajor(long struct)Unsafe version ofmMinMajor().static voidnmMinMajor(long struct, int value)Unsafe version ofmMinMajor.static intnmMinMinor(long struct)Unsafe version ofmMinMinor().static voidnmMinMinor(long struct, int value)Unsafe version ofmMinMinor.static java.nio.ByteBuffernmName(long struct)Unsafe version ofmName().static voidnmName(long struct, java.nio.ByteBuffer value)Unsafe version ofmName.static java.lang.StringnmNameString(long struct)Unsafe version ofmNameString().AIImporterDescset(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.AIImporterDescset(AIImporterDesc src)Copies the specified struct data to this struct.intsizeof()static voidvalidate(long struct)Validates pointer members that should not beNULL.static voidvalidate(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 aAIImporterDescinstance at the current position of the specifiedByteBuffercontainer. 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:
sizeofin classorg.lwjgl.system.Struct
-
mName
public java.nio.ByteBuffer mName()
Returns aByteBufferview of the null-terminated string pointed to by themNamefield.
-
mNameString
public java.lang.String mNameString()
Decodes the null-terminated string pointed to by themNamefield.
-
mAuthor
public java.nio.ByteBuffer mAuthor()
Returns aByteBufferview of the null-terminated string pointed to by themAuthorfield.
-
mAuthorString
public java.lang.String mAuthorString()
Decodes the null-terminated string pointed to by themAuthorfield.
-
mMaintainer
public java.nio.ByteBuffer mMaintainer()
Returns aByteBufferview of the null-terminated string pointed to by themMaintainerfield.
-
mMaintainerString
public java.lang.String mMaintainerString()
Decodes the null-terminated string pointed to by themMaintainerfield.
-
mComments
public java.nio.ByteBuffer mComments()
Returns aByteBufferview of the null-terminated string pointed to by themCommentsfield.
-
mCommentsString
public java.lang.String mCommentsString()
Decodes the null-terminated string pointed to by themCommentsfield.
-
mFlags
public int mFlags()
Returns the value of themFlagsfield.
-
mMinMajor
public int mMinMajor()
Returns the value of themMinMajorfield.
-
mMinMinor
public int mMinMinor()
Returns the value of themMinMinorfield.
-
mMaxMajor
public int mMaxMajor()
Returns the value of themMaxMajorfield.
-
mMaxMinor
public int mMaxMinor()
Returns the value of themMaxMinorfield.
-
mFileExtensions
public java.nio.ByteBuffer mFileExtensions()
Returns aByteBufferview of the null-terminated string pointed to by themFileExtensionsfield.
-
mFileExtensionsString
public java.lang.String mFileExtensionsString()
Decodes the null-terminated string pointed to by themFileExtensionsfield.
-
mName
public AIImporterDesc mName(java.nio.ByteBuffer value)
Sets the address of the specified encoded string to themNamefield.
-
mAuthor
public AIImporterDesc mAuthor(java.nio.ByteBuffer value)
Sets the address of the specified encoded string to themAuthorfield.
-
mMaintainer
public AIImporterDesc mMaintainer(java.nio.ByteBuffer value)
Sets the address of the specified encoded string to themMaintainerfield.
-
mComments
public AIImporterDesc mComments(java.nio.ByteBuffer value)
Sets the address of the specified encoded string to themCommentsfield.
-
mFlags
public AIImporterDesc mFlags(int value)
Sets the specified value to themFlagsfield.
-
mMinMajor
public AIImporterDesc mMinMajor(int value)
Sets the specified value to themMinMajorfield.
-
mMinMinor
public AIImporterDesc mMinMinor(int value)
Sets the specified value to themMinMinorfield.
-
mMaxMajor
public AIImporterDesc mMaxMajor(int value)
Sets the specified value to themMaxMajorfield.
-
mMaxMinor
public AIImporterDesc mMaxMinor(int value)
Sets the specified value to themMaxMinorfield.
-
mFileExtensions
public AIImporterDesc mFileExtensions(java.nio.ByteBuffer value)
Sets the address of the specified encoded string to themFileExtensionsfield.
-
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 newAIImporterDescinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static AIImporterDesc calloc()
Returns a newAIImporterDescinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static AIImporterDesc create()
Returns a newAIImporterDescinstance allocated withBufferUtils.
-
create
public static AIImporterDesc create(long address)
Returns a newAIImporterDescinstance for the specified memory address.
-
createSafe
@Nullable public static AIImporterDesc createSafe(long address)
-
malloc
public static AIImporterDesc.Buffer malloc(int capacity)
Returns a newAIImporterDesc.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static AIImporterDesc.Buffer calloc(int capacity)
Returns a newAIImporterDesc.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static AIImporterDesc.Buffer create(int capacity)
Returns a newAIImporterDesc.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static AIImporterDesc.Buffer create(long address, int capacity)
Create aAIImporterDesc.Bufferinstance 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 newAIImporterDescinstance allocated on the thread-localMemoryStack.
-
callocStack
public static AIImporterDesc callocStack()
Returns a newAIImporterDescinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.
-
mallocStack
public static AIImporterDesc mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newAIImporterDescinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
callocStack
public static AIImporterDesc callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newAIImporterDescinstance allocated on the specifiedMemoryStackand 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.Bufferinstance allocated on the thread-localMemoryStack.- Parameters:
capacity- the buffer capacity
-
callocStack
public static AIImporterDesc.Buffer callocStack(int capacity)
Returns a newAIImporterDesc.Bufferinstance allocated on the thread-localMemoryStackand 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.Bufferinstance 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.Bufferinstance allocated on the specifiedMemoryStackand 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
-
-