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

Describes a blob of exported scene data. More...

#include <cexport.h>

Public Member Functions

 aiExportDataBlob ()
 Default constructor. More...
 
 aiExportDataBlob (const aiExportDataBlob &)=delete
 
aiExportDataBloboperator= (const aiExportDataBlob &)=delete
 
 ~aiExportDataBlob ()
 Releases the data. More...
 

Public Attributes

void * data
 The data. More...
 
C_STRUCT aiString name
 Name of the blob. More...
 
C_STRUCT aiExportDataBlobnext
 Pointer to the next blob in the chain or NULL if there is none. More...
 
size_t size
 Size of the data in bytes. More...
 

Detailed Description

Describes a blob of exported scene data.

Use aiExportSceneToBlob() to create a blob containing an exported scene. The memory referred by this structure is owned by Assimp. to free its resources. Don't try to free the memory on your side - it will crash for most build configurations due to conflicting heaps.

Blobs can be nested - each blob may reference another blob, which may in turn reference another blob and so on. This is used when exporters write more than one output file for a given aiScene. See the remarks for aiExportDataBlob::name for more information.

Constructor & Destructor Documentation

◆ aiExportDataBlob() [1/2]

aiExportDataBlob::aiExportDataBlob ( )
inline

Default constructor.

◆ ~aiExportDataBlob()

aiExportDataBlob::~aiExportDataBlob ( )
inline

Releases the data.

◆ aiExportDataBlob() [2/2]

aiExportDataBlob::aiExportDataBlob ( const aiExportDataBlob )
delete

Member Function Documentation

◆ operator=()

aiExportDataBlob & aiExportDataBlob::operator= ( const aiExportDataBlob )
delete

Member Data Documentation

◆ data

void* aiExportDataBlob::data

The data.

◆ name

C_STRUCT aiString aiExportDataBlob::name

Name of the blob.

An empty string always indicates the first (and primary) blob, which contains the actual file data. Any other blobs are auxiliary files produced by exporters (i.e. material files). Existence of such files depends on the file format. Most formats don't split assets across multiple files.

If used, blob names usually contain the file extension that should be used when writing the data to disc.

The blob names generated can be influenced by setting the #AI_CONFIG_EXPORT_BLOB_NAME export property to the name that is used for the master blob. All other names are typically derived from the base name, by the file format exporter.

◆ next

C_STRUCT aiExportDataBlob* aiExportDataBlob::next

Pointer to the next blob in the chain or NULL if there is none.

◆ size

size_t aiExportDataBlob::size

Size of the data in bytes.


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