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.Layout
struct aiImporterDesc { char const *
mName()
; char const *mAuthor()
; char const *mMaintainer()
; char const *mComments()
; unsigned intmFlags()
; unsigned intmMinMajor()
; unsigned intmMinMinor()
; unsigned intmMaxMajor()
; unsigned intmMaxMinor()
; 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 Deprecated 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.Buffer
calloc(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
calloc(org.lwjgl.system.MemoryStack stack)
Returns a newAIImporterDesc
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static AIImporterDesc
callocStack()
Deprecated.static AIImporterDesc.Buffer
callocStack(int capacity)
Deprecated.static AIImporterDesc.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Deprecated.static AIImporterDesc
callocStack(org.lwjgl.system.MemoryStack stack)
Deprecated.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.Buffer
malloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newAIImporterDesc.Buffer
instance allocated on the specifiedMemoryStack
.static AIImporterDesc
malloc(org.lwjgl.system.MemoryStack stack)
Returns a newAIImporterDesc
instance allocated on the specifiedMemoryStack
.static AIImporterDesc
mallocStack()
Deprecated.static AIImporterDesc.Buffer
mallocStack(int capacity)
Deprecated.static AIImporterDesc.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Deprecated.static AIImporterDesc
mallocStack(org.lwjgl.system.MemoryStack stack)
Deprecated.java.nio.ByteBuffer
mAuthor()
Original author (left blank if unknown or whole assimp team)AIImporterDesc
mAuthor(java.nio.ByteBuffer value)
Sets the address of the specified encoded string to themAuthor()
field.java.lang.String
mAuthorString()
Original author (left blank if unknown or whole assimp team)java.nio.ByteBuffer
mComments()
Implementation comments, i.e.AIImporterDesc
mComments(java.nio.ByteBuffer value)
Sets the address of the specified encoded string to themComments()
field.java.lang.String
mCommentsString()
Implementation comments, i.e.java.nio.ByteBuffer
mFileExtensions()
List of file extensions this importer can handle.AIImporterDesc
mFileExtensions(java.nio.ByteBuffer value)
Sets the address of the specified encoded string to themFileExtensions()
field.java.lang.String
mFileExtensionsString()
List of file extensions this importer can handle.int
mFlags()
These flags indicate some characteristics common to many importers.AIImporterDesc
mFlags(int value)
Sets the specified value to themFlags()
field.java.nio.ByteBuffer
mMaintainer()
Current maintainer, left blank if the author maintainsAIImporterDesc
mMaintainer(java.nio.ByteBuffer value)
Sets the address of the specified encoded string to themMaintainer()
field.java.lang.String
mMaintainerString()
Current maintainer, left blank if the author maintainsint
mMaxMajor()
Maximum major format that can be loaded in major.minor style.AIImporterDesc
mMaxMajor(int value)
Sets the specified value to themMaxMajor()
field.int
mMaxMinor()
Maximum minor format that can be loaded in major.minor style.AIImporterDesc
mMaxMinor(int value)
Sets the specified value to themMaxMinor()
field.int
mMinMajor()
Minimum major format that can be loaded in major.minor style.AIImporterDesc
mMinMajor(int value)
Sets the specified value to themMinMajor()
field.int
mMinMinor()
Minimum minor format that can be loaded in major.minor style.AIImporterDesc
mMinMinor(int value)
Sets the specified value to themMinMinor()
field.java.nio.ByteBuffer
mName()
Full name of the importer (i.e.AIImporterDesc
mName(java.nio.ByteBuffer value)
Sets the address of the specified encoded string to themName()
field.java.lang.String
mNameString()
Full name of the importer (i.e.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
.
-
-
-
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, mNameString
public java.nio.ByteBuffer mName() public java.lang.String mNameString()
Full name of the importer (i.e. Blender3D importer)
-
mAuthor, mAuthorString
public java.nio.ByteBuffer mAuthor() public java.lang.String mAuthorString()
Original author (left blank if unknown or whole assimp team)
-
mMaintainer, mMaintainerString
public java.nio.ByteBuffer mMaintainer() public java.lang.String mMaintainerString()
Current maintainer, left blank if the author maintains
-
mComments, mCommentsString
public java.nio.ByteBuffer mComments() public java.lang.String mCommentsString()
Implementation comments, i.e. unimplemented features
-
mFlags
public int mFlags()
These flags indicate some characteristics common to many importers.
-
mMinMajor
public int mMinMajor()
Minimum major format that can be loaded in major.minor style.
-
mMinMinor
public int mMinMinor()
Minimum minor format that can be loaded in major.minor style.
-
mMaxMajor
public int mMaxMajor()
Maximum major format that can be loaded in major.minor style.
-
mMaxMinor
public int mMaxMinor()
Maximum minor format that can be loaded in major.minor style.
-
mFileExtensions, mFileExtensionsString
public java.nio.ByteBuffer mFileExtensions() public java.lang.String mFileExtensionsString()
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.
-
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
@Deprecated public static AIImporterDesc mallocStack()
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)
instead.
-
callocStack
@Deprecated public static AIImporterDesc callocStack()
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)
instead.
-
mallocStack
@Deprecated public static AIImporterDesc mallocStack(org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)
instead.
-
callocStack
@Deprecated public static AIImporterDesc callocStack(org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)
instead.
-
mallocStack
@Deprecated public static AIImporterDesc.Buffer mallocStack(int capacity)
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead.
-
callocStack
@Deprecated public static AIImporterDesc.Buffer callocStack(int capacity)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead.
-
mallocStack
@Deprecated public static AIImporterDesc.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead.
-
callocStack
@Deprecated public static AIImporterDesc.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead.
-
malloc
public static AIImporterDesc malloc(org.lwjgl.system.MemoryStack stack)
Returns a newAIImporterDesc
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
calloc
public static AIImporterDesc calloc(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
-
malloc
public static AIImporterDesc.Buffer malloc(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
-
calloc
public static AIImporterDesc.Buffer calloc(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
-
-