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

C-API: File callbacks. More...

#include <cfileio.h>

Public Attributes

aiFileTellProc FileSizeProc
 Callback to retrieve the size of the file, in bytes. More...
 
aiFileFlushProc FlushProc
 Callback to flush the file contents. More...
 
aiFileReadProc ReadProc
 Callback to read from a file. More...
 
aiFileSeek SeekProc
 Callback to set the current position of the file cursor (fseek()) More...
 
aiFileTellProc TellProc
 Callback to retrieve the current position of the file cursor (ftell()) More...
 
aiUserData UserData
 User-defined, opaque data. More...
 
aiFileWriteProc WriteProc
 Callback to write to a file. More...
 

Detailed Description

C-API: File callbacks.

Actually, it's a data structure to wrap a set of fXXXX (e.g fopen) replacement functions.

The default implementation of the functions utilizes the fXXX functions from the CRT. However, you can supply a custom implementation to Assimp by delivering a custom aiFileIO. Use this to enable reading from other sources, such as ZIP archives or memory locations.

Member Data Documentation

◆ FileSizeProc

aiFileTellProc aiFile::FileSizeProc

Callback to retrieve the size of the file, in bytes.

◆ FlushProc

aiFileFlushProc aiFile::FlushProc

Callback to flush the file contents.

◆ ReadProc

aiFileReadProc aiFile::ReadProc

Callback to read from a file.

◆ SeekProc

aiFileSeek aiFile::SeekProc

Callback to set the current position of the file cursor (fseek())

◆ TellProc

aiFileTellProc aiFile::TellProc

Callback to retrieve the current position of the file cursor (ftell())

◆ UserData

aiUserData aiFile::UserData

User-defined, opaque data.

◆ WriteProc

aiFileWriteProc aiFile::WriteProc

Callback to write to a file.


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