Assimp v5.2.2 (January 2022)
The Asset-Importer-Lib API documentation.
importerdesc.h File Reference

aiImporterFlags, aiImporterDesc implementation. More...

Classes

struct  aiImporterDesc
 Meta information about a particular importer. More...
 

Macros

#define AI_IMPORTER_DESC_H_INC
 

Enumerations

enum  aiImporterFlags {
  aiImporterFlags_SupportTextFlavour = 0x1 , aiImporterFlags_SupportBinaryFlavour = 0x2 , aiImporterFlags_SupportCompressedFlavour = 0x4 , aiImporterFlags_LimitedSupport = 0x8 ,
  aiImporterFlags_Experimental = 0x10
}
 Mixed set of flags for aiImporterDesc, indicating some features common to many importers. More...
 

Functions

ASSIMP_API const C_STRUCT aiImporterDescaiGetImporterDesc (const char *extension)
 Returns the Importer description for a given extension. More...
 

Detailed Description

Macro Definition Documentation

◆ AI_IMPORTER_DESC_H_INC

#define AI_IMPORTER_DESC_H_INC

Enumeration Type Documentation

◆ aiImporterFlags

Mixed set of flags for aiImporterDesc, indicating some features common to many importers.

Enumerator
aiImporterFlags_SupportTextFlavour 

Indicates that there is a textual encoding of the file format; and that it is supported.

aiImporterFlags_SupportBinaryFlavour 

Indicates that there is a binary encoding of the file format; and that it is supported.

aiImporterFlags_SupportCompressedFlavour 

Indicates that there is a compressed encoding of the file format; and that it is supported.

aiImporterFlags_LimitedSupport 

Indicates that the importer reads only a very particular subset of the file format.

This happens commonly for declarative or procedural formats which cannot easily be mapped to aiScene

aiImporterFlags_Experimental 

Indicates that the importer is highly experimental and should be used with care.

This only happens for trunk (i.e. SVN) versions, experimental code is not included in releases.

Function Documentation

◆ aiGetImporterDesc()

ASSIMP_API const C_STRUCT aiImporterDesc * aiGetImporterDesc ( const char *  extension)

Returns the Importer description for a given extension.

Will return a nullptr if no assigned importer desc. was found for the given extension

Parameters
extension[in] The extension to look for
Returns
A pointer showing to the ImporterDesc,
See also
aiImporterDesc.