Assimp v5.2.2 (January 2022)
The Asset-Importer-Lib API documentation.
aiImporterDesc Struct Reference

Meta information about a particular importer. More...

#include <importerdesc.h>

Public Attributes

const char * mAuthor
 Original author (left blank if unknown or whole assimp team) More...
 
const char * mComments
 Implementation comments, i.e. More...
 
const char * mFileExtensions
 List of file extensions this importer can handle. More...
 
unsigned int mFlags
 These flags indicate some characteristics common to many importers. More...
 
const char * mMaintainer
 Current maintainer, left blank if the author maintains. More...
 
unsigned int mMaxMajor
 Maximum format version that can be loaded im major.minor format, both are set to 0 if there is either no version scheme or if the loader doesn't care. More...
 
unsigned int mMaxMinor
 
unsigned int mMinMajor
 Minimum format version that can be loaded im major.minor format, both are set to 0 if there is either no version scheme or if the loader doesn't care. More...
 
unsigned int mMinMinor
 
const char * mName
 Full name of the importer (i.e. More...
 

Detailed Description

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 Data Documentation

◆ mAuthor

const char* aiImporterDesc::mAuthor

Original author (left blank if unknown or whole assimp team)

◆ mComments

const char* aiImporterDesc::mComments

Implementation comments, i.e.

unimplemented features

◆ mFileExtensions

const char* aiImporterDesc::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.

◆ mFlags

unsigned int aiImporterDesc::mFlags

These flags indicate some characteristics common to many importers.

◆ mMaintainer

const char* aiImporterDesc::mMaintainer

Current maintainer, left blank if the author maintains.

◆ mMaxMajor

unsigned int aiImporterDesc::mMaxMajor

Maximum format version that can be loaded im major.minor format, both are set to 0 if there is either no version scheme or if the loader doesn't care.

Loaders that expect to be forward-compatible to potential future format versions should indicate zero, otherwise they should specify the current maximum version.

◆ mMaxMinor

unsigned int aiImporterDesc::mMaxMinor

◆ mMinMajor

unsigned int aiImporterDesc::mMinMajor

Minimum format version that can be loaded im major.minor format, both are set to 0 if there is either no version scheme or if the loader doesn't care.

◆ mMinMinor

unsigned int aiImporterDesc::mMinMinor

◆ mName

const char* aiImporterDesc::mName

Full name of the importer (i.e.

Blender3D importer)


The documentation for this struct was generated from the following file: