SFXStream

ストリームの基底クラスです。

#include <SFXStream.h.hpp>

class SFXStream;

SFMTYPEDEFCLASS(SFXStream)

継承図

SFXStream は、ストリームの基底クラスです。

SFXStream を継承する SFXInputStream / SFXOutputStream クラスは、読み込み用ストリーム / 書き込み用ストリームの基底クラスです。

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

パブリック関数
`Void`	Cancel( `Void` ) ストリームの読み込み/書き込みをキャンセルします。
`SFCError`	ResetTrigger( `Void` ) コールバック関数が呼ばれるトリガーをリセットします。
`SFCError`	SetTrigger( `UInt32` size ) トリガー(コールバック関数が呼ばれるタイミング)を設定します。
`SFCError`	SetTrigger( `SFXBufferConstRef` buffer ) トリガー(コールバック関数が呼ばれるタイミング)を設定します。
`SFCError`	SetTrigger( `VoidConstPtr` buffer , `UInt32` size ) トリガー(コールバック関数が呼ばれるタイミング)を設定します。
`Bool`	Triggers( `Void` ) トリガーによりコールバック関数が呼び出されたか判定します。

型
CallbackSPP コールバック関数を表す型です。

SFXStream::SFXStream

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

[ protected, explicit ]
SFXStream(Void);

特に何も行いません。

SFXStream::~SFXStream

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

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

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

SFXStream::Cancel

ストリームの読み込み/書き込みをキャンセルします。

[ public, pure-virtual ]
Void Cancel(Void);

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

SFXStream::ResetTrigger

コールバック関数が呼ばれるトリガーをリセットします。

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

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

SFXStream::SetTrigger

トリガー(コールバック関数が呼ばれるタイミング)を設定します。

[ public, pure-virtual ]
SFCError SetTrigger(
    UInt32 size   // トリガーとなるサイズ
);

[ public, pure-virtual ]
SFCError SetTrigger(
    SFXBufferConstRef buffer   // トリガーとなるデータ
);

[ public, pure-virtual ]
SFCError SetTrigger(
    VoidConstPtr buffer   // トリガーとなるデータ
    UInt32 size           // トリガーとなるデータのサイズ
);

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

SFXStream::Triggers

トリガーによりコールバック関数が呼び出されたか判定します。

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

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

SFXStream::CallbackSPP

コールバック関数を表す型です。

typedef Void(* SFXStream::CallbackSPP)(SFCError error, VoidPtr reference)