SFXInputStream

読み込み用ストリームの基底クラスです。

#include <SFXInputStream.h.hpp>

class SFXInputStream : public SFXStream;

SFMTYPEDEFCLASS(SFXInputStream)

継承図

解説

SFXInputStream は、読み込み用ストリームの基底クラスです。

ストリームから読み込むデータの種類に応じて、 SFXInputStream を継承する SFXAnsiStringStreamReader / SFXWideStringStreamReader / SFXBinaryStreamReader クラスを使い分けます。

参照

SFXAnsiStringStreamReader | SFXWideStringStreamReader | SFXBinaryStreamReader | ストリーム

メンバ

コンストラクタ/デストラクタ
SFXInputStream( `Void` ) SFXInputStream クラスのコンストラクタです。
~SFXInputStream( `Void` ) SFXInputStream クラスのデストラクタです。

パブリック関数
`Bool`	Ends( `Void` ) ストリームの終端かどうかを判定します。
`SFCError`	Fetch( `Void` ) ストレージからストリームバッファにデータを読み込みます。
`SFCError`	Fetch( `CallbackSPP` spp , `VoidPtr` reference ) ストレージからストリームバッファにデータを読み込みます。
`SInt32`	FirstIndexOf( `SFXBufferConstRef` buffer , `SInt32` index = SINT32_MINIMUM ) ストリームを先頭から検索して、指定したデータと一致する最初のインデックスを取得します。
`SInt32`	FirstIndexOf( `VoidConstPtr` buffer , `UInt32` size , `SInt32` index = SINT32_MINIMUM ) ストリームを先頭から検索して、指定したデータと一致する最初のインデックスを取得します。
`SInt32`	FirstIndexOf( `Byte` byte , `SInt32` index = SINT32_MINIMUM ) ストリームを先頭から検索して、指定したデータと一致する最初のインデックスを取得します。
`UInt32`	GetReadableSize( `Void` ) ストリームバッファから読み込み可能なデータサイズを取得します。
`SInt32`	LastIndexOf( `SFXBufferConstRef` buffer , `SInt32` index = SINT32_MAXIMUM ) ストリームを終端から検索して、指定したデータと一致する最後のインデックスを取得します。
`SInt32`	LastIndexOf( `VoidConstPtr` buffer , `UInt32` size , `SInt32` index = SINT32_MAXIMUM ) ストリームを終端から検索して、指定したデータと一致する最後のインデックスを取得します。
`SInt32`	LastIndexOf( `Byte` byte , `SInt32` index = SINT32_MAXIMUM ) ストリームを終端から検索して、指定したデータと一致する最後のインデックスを取得します。
`SFCError`	Read( `SFXBufferPtr` buffer ) ストリームからデータを読み込みます。
`SFCError`	Read( `VoidPtr` buffer , `UInt32` size ) ストリームからデータを読み込みます。
`SFCError`	Seek( `UInt32` size ) 読み込みポインタを進めます。
`Void`	Cancel( `Void` ) (SFXStream から継承) ストリームの読み込み/書き込みをキャンセルします。
`SFCError`	ResetTrigger( `Void` ) (SFXStream から継承) コールバック関数が呼ばれるトリガーをリセットします。
`SFCError`	SetTrigger( `UInt32` size ) (SFXStream から継承) トリガー(コールバック関数が呼ばれるタイミング)を設定します。
`SFCError`	SetTrigger( `SFXBufferConstRef` buffer ) (SFXStream から継承) トリガー(コールバック関数が呼ばれるタイミング)を設定します。
`SFCError`	SetTrigger( `VoidConstPtr` buffer , `UInt32` size ) (SFXStream から継承) トリガー(コールバック関数が呼ばれるタイミング)を設定します。
`Bool`	Triggers( `Void` ) (SFXStream から継承) トリガーによりコールバック関数が呼び出されたか判定します。

型
CallbackSPP (SFXStream から継承) コールバック関数を表す型です。

SFXInputStream::SFXInputStream

SFXInputStream クラスのコンストラクタです。

[ protected, explicit ]
SFXInputStream(Void);

解説

特に何も行いません。

SFXInputStream::~SFXInputStream

SFXInputStream クラスのデストラクタです。

[ public, pure-virtual ]
virtual ~SFXInputStream(Void);

解説

この関数は純粋仮想関数です。

SFXInputStream::Ends

ストリームの終端かどうかを判定します。

[ public, pure-virtual, const ]
Bool Ends(Void);

解説

この関数は純粋仮想関数です。

SFXInputStream::Fetch

ストレージからストリームバッファにデータを読み込みます。

[ public, pure-virtual ]
SFCError Fetch(Void);

[ public, pure-virtual ]
SFCError Fetch(
    CallbackSPP spp     // コールバック関数
    VoidPtr reference   // コールバック関数に渡すデータ（参照値）
);

解説

この関数は純粋仮想関数です。

SFXInputStream::FirstIndexOf

ストリームを先頭から検索して、指定したデータと一致する最初のインデックスを取得します。

[ public, pure-virtual, const ]
SInt32 FirstIndexOf(
    SFXBufferConstRef buffer        // 検索するバッファ
    SInt32 index = SINT32_MINIMUM   // 検索開始位置
);

[ public, pure-virtual, const ]
SInt32 FirstIndexOf(
    VoidConstPtr buffer             // 検索するデータ
    UInt32 size                     // 検索するデータのサイズ
    SInt32 index = SINT32_MINIMUM   // 検索開始位置
);

[ public, pure-virtual, const ]
SInt32 FirstIndexOf(
    Byte byte                       // 検索する Byte データ
    SInt32 index = SINT32_MINIMUM   // 検索開始位置
);

解説

この関数は純粋仮想関数です。

参照

SFXInputStream::LastIndexOf

SFXInputStream::GetReadableSize

ストリームバッファから読み込み可能なデータサイズを取得します。

[ public, pure-virtual, const ]
UInt32 GetReadableSize(Void);

解説

この関数は純粋仮想関数です。

SFXInputStream::LastIndexOf

ストリームを終端から検索して、指定したデータと一致する最後のインデックスを取得します。

[ public, pure-virtual, const ]
SInt32 LastIndexOf(
    SFXBufferConstRef buffer        // 検索するバッファ
    SInt32 index = SINT32_MAXIMUM   // 検索開始位置
);

[ public, pure-virtual, const ]
SInt32 LastIndexOf(
    VoidConstPtr buffer             // 検索するデータ
    UInt32 size                     // 検索するデータのサイズ
    SInt32 index = SINT32_MAXIMUM   // 検索開始位置
);

[ public, pure-virtual, const ]
SInt32 LastIndexOf(
    Byte byte                       // 検索する Byte データ
    SInt32 index = SINT32_MAXIMUM   // 検索開始位置
);

解説

この関数は純粋仮想関数です。

参照

SFXInputStream::FirstIndexOf

SFXInputStream::Read

ストリームからデータを読み込みます。

[ public, pure-virtual ]
SFCError Read(
    SFXBufferPtr buffer   // 読み込んだデータ
);

[ public, pure-virtual ]
SFCError Read(
    VoidPtr buffer   // 読み込んだデータ
    UInt32 size      // 読み込んだデータのサイズ
);

解説

この関数は純粋仮想関数です。

SFXInputStream::Seek

読み込みポインタを進めます。

[ public, pure-virtual ]
SFCError Seek(
    UInt32 size   // 進めるサイズ
);

解説

この関数は純粋仮想関数です。