SFXStream

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

#include <SFXStream.h.hpp>

class SFXStream;

SFMTYPEDEFCLASS(SFXStream)

継承図

参照

SFXInputStream | SFXOutputStream

メンバ

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

パブリック関数
`Void`	Cancel( `Void` ) ストレージクラスの Cancel 関数を呼び出します。登録したコールバック関数もキャンセルします。
`SFCError`	ResetTrigger( `Void` ) コールバック関数が呼ばれるトリガーをリセットします。
`SFCError`	SetTrigger( `UInt32` size ) SetTrigger( `VoidConstPtr` buffer , `UInt32` size ) SetTrigger( `SFXBufferConstRef` buffer ) コールバック関数が呼ばれるトリガーを設定します。
`Bool`	Triggers( `Void` ) トリガーによりコールバック関数が呼ばれたか判定します。

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

SFXStream::SFXStream

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

[ protected, explicit ]
SFXStream(Void);

SFXStream::~SFXStream

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

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

SFXStream::Cancel

ストレージクラスの Cancel 関数を呼び出します。登録したコールバック関数もキャンセルします。

[ public, virtual ]
Void Cancel(Void);

解説

Cancel 関数は純粋仮想関数です。

参照

SFXStorage::Cancel

SFXStream::ResetTrigger

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

[ public, virtual ]
SFCError ResetTrigger(Void);

解説

ResetTrigger 関数は純粋仮想関数です。

参照

SFXStream::SetTrigger | SFXStream::Triggers

SFXStream::SetTrigger

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

[ public, virtual ]
SFCError SetTrigger(
    UInt32 size   // ストリームを介して読み書きされたデータのサイズ
);

[ public, virtual ]
SFCError SetTrigger(
    SFXBufferConstRef buffer   // ストリームを介して読み書きされたバッファ オブジェクト
);

[ public, virtual ]
SFCError SetTrigger(
    VoidConstPtr buffer   // ストリームを介して読み書きされたデータ
    UInt32 size           // ストリームを介して読み書きされたデータ(buffer)のサイズ
);

解説

SetTrigger 関数は純粋仮想関数です。

参照

SFXStream::ResetTrigger | SFXStream::Triggers

SFXStream::Triggers

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

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

解説

Triggers 関数は純粋仮想関数です。

参照

SFXStream::SetTrigger | SFXStream::ResetTrigger

SFXStream::CallbackSPP

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

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