OpenSiv3D  v0.6.5
C++20 framework for creative coding
s3d::IWriter Class Referenceabstract

Writer インタフェース More...

#include <IWriter.hpp>

Inherited by s3d::BinaryWriter, and s3d::MemoryWriter.

Public Member Functions

virtual ~IWriter ()=default
 デストラクタ More...
 
virtual bool isOpen () const noexcept=0
 Writer が使用可能かを返します。 More...
 
virtual int64 size () const =0
 Writer のサイズを返します。 More...
 
virtual int64 getPos () const =0
 Writer の現在の書き込み位置を返します。 More...
 
virtual bool setPos (int64 pos)=0
 Writer の書き込み位置を変更します。 More...
 
virtual int64 write (const void *src, int64 sizeBytes)=0
 Writer にデータを書き込みます。 More...
 
SIV3D_CONCEPT_TRIVIALLY_COPYABLE bool write (const TriviallyCopyable &src)
 Writer にデータを書き込みます。 More...
 

Detailed Description

Writer インタフェース

Constructor & Destructor Documentation

◆ ~IWriter()

virtual s3d::IWriter::~IWriter ( )
virtualdefault

デストラクタ

Member Function Documentation

◆ getPos()

virtual int64 s3d::IWriter::getPos ( ) const
pure virtual

Writer の現在の書き込み位置を返します。

Returns
現在の書き込み位置(バイト)

Implemented in s3d::BinaryWriter, and s3d::MemoryWriter.

◆ isOpen()

virtual bool s3d::IWriter::isOpen ( ) const
pure virtualnoexcept

Writer が使用可能かを返します。

Returns
Writer が使用可能な場合 true, それ以外の場合は false

Implemented in s3d::BinaryWriter, and s3d::MemoryWriter.

◆ setPos()

virtual bool s3d::IWriter::setPos ( int64  pos)
pure virtual

Writer の書き込み位置を変更します。

Parameters
pos新しい書き込み位置(バイト)
Returns
書き込み位置の変更に成功した場合 true, それ以外の場合は false

Implemented in s3d::BinaryWriter, and s3d::MemoryWriter.

◆ size()

virtual int64 s3d::IWriter::size ( ) const
pure virtual

Writer のサイズを返します。

Returns
Writer のサイズ(バイト)

Implemented in s3d::BinaryWriter, and s3d::MemoryWriter.

◆ write() [1/2]

SIV3D_CONCEPT_TRIVIALLY_COPYABLE bool s3d::IWriter::write ( const TriviallyCopyable &  src)

Writer にデータを書き込みます。

Template Parameters
TriviallyCopyable書き込む値の型
Parameters
src書き込むデータ
Returns
書き込みに成功した場合 true, それ以外の場合は false

◆ write() [2/2]

virtual int64 s3d::IWriter::write ( const void *  src,
int64  sizeBytes 
)
pure virtual

Writer にデータを書き込みます。

Parameters
src書き込むデータ
sizeBytes書き込むサイズ(バイト)
Returns
実際に書き込んだサイズ(バイト)

Implemented in s3d::BinaryWriter, and s3d::MemoryWriter.


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