Assimp v5.2.2 (January 2022)
The Asset-Importer-Lib API documentation.
Assimp::DefaultIOStream Class Reference

Default IO implementation, use standard IO operations. More...

#include <DefaultIOStream.h>

Inherits Assimp::IOStream.

Public Member Functions

size_t FileSize () const override
 Get size of file.
 
void Flush () override
 Flush file contents.
 
size_t Read (void *pvBuffer, size_t pSize, size_t pCount) override
 Read from stream.
 
aiReturn Seek (size_t pOffset, aiOrigin pOrigin) override
 Seek specific position.
 
size_t Tell () const override
 Get current seek position.
 
size_t Write (const void *pvBuffer, size_t pSize, size_t pCount) override
 Write to stream.
 
 ~DefaultIOStream () override
 Destructor public to allow simple deletion to close the file.
 
- Public Member Functions inherited from Assimp::IOStream
virtual ~IOStream ()=default
 Destructor.
 

Protected Member Functions

 DefaultIOStream () AI_NO_EXCEPT
 
 DefaultIOStream (FILE *pFile, const std::string &strFilename)
 The class constructor with the file name and the stream.
 
- Protected Member Functions inherited from Assimp::IOStream
 IOStream () AI_NO_EXCEPT=default
 Constructor protected, use IOSystem::Open() to create an instance.
 

Friends

class DefaultIOSystem
 

Detailed Description

Default IO implementation, use standard IO operations.

Note
An instance of this class can exist without a valid file handle attached to it. All calls fail, but the instance can nevertheless be used with no restrictions.

Constructor & Destructor Documentation

◆ DefaultIOStream() [1/2]

AI_FORCE_INLINE Assimp::DefaultIOStream::DefaultIOStream ( )
protected

◆ DefaultIOStream() [2/2]

AI_FORCE_INLINE Assimp::DefaultIOStream::DefaultIOStream ( FILE pFile,
const std::string &  strFilename 
)
protected

The class constructor with the file name and the stream.

Parameters
pFileThe file-streaam
strFilenameThe file name

◆ ~DefaultIOStream()

Assimp::DefaultIOStream::~DefaultIOStream ( )
override

Destructor public to allow simple deletion to close the file.

Member Function Documentation

◆ FileSize()

size_t Assimp::DefaultIOStream::FileSize ( ) const
overridevirtual

Get size of file.

Implements Assimp::IOStream.

◆ Flush()

void Assimp::DefaultIOStream::Flush ( )
overridevirtual

Flush file contents.

Implements Assimp::IOStream.

◆ Read()

size_t Assimp::DefaultIOStream::Read ( void pvBuffer,
size_t  pSize,
size_t  pCount 
)
overridevirtual

Read from stream.

Implements Assimp::IOStream.

◆ Seek()

aiReturn Assimp::DefaultIOStream::Seek ( size_t  pOffset,
aiOrigin  pOrigin 
)
overridevirtual

Seek specific position.

Implements Assimp::IOStream.

◆ Tell()

size_t Assimp::DefaultIOStream::Tell ( ) const
overridevirtual

Get current seek position.

Implements Assimp::IOStream.

◆ Write()

size_t Assimp::DefaultIOStream::Write ( const void pvBuffer,
size_t  pSize,
size_t  pCount 
)
overridevirtual

Write to stream.

Implements Assimp::IOStream.

Friends And Related Symbol Documentation

◆ DefaultIOSystem


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