OROCHI
 
Loading...
Searching...
No Matches
List of all members
GxRingStream Class Reference

リングストリームクラス More...

#include <GxStream.h>

Inheritance diagram for GxRingStream:
Inheritance graph
[legend]
Collaboration diagram for GxRingStream:
Collaboration graph
[legend]

Public Member Functions

初期化
 GxRingStream (void)
 コンストラクタ
 
 ~GxRingStream (void) override
 デストラクタ
 
b32 initialize (u32 size, GxAllocator *pAllocator=nullptr, GxMemory::ALIGNMENT alignment=GxMemory::ALIGNMENT::_16)
 初期化 (新規メモリ確保)
 
b32 initialize (void *pBuffer, u32 size)
 初期化 (既存メモリ指定)
 
void terminate (void)
 終了
 
操作
u32 read (void *pDst, u32 size) override
 読み込み
 
u32 write (const void *pSrc, u32 size) override
 書き込み
 
アクセサ
GX_FORCE_INLINE u32 getSize (void) const override
 ストリームサイズ取得
 
constexpr u32 getFreeSize (void) const
 空き領域サイズ取得
 
constexpr u32 getUsedSize (void) const
 使用領域サイズ取得
 
- Public Member Functions inherited from GxStream
virtual void close (void)
 クローズ
 
virtual void flush (void)
 フラッシュ
 
virtual u32 seek (s32, GxFile::SEEK_TYPE=GxFile::SEEK_TYPE::BEGIN)
 シーク
 
u32 copy (GxStream &dst, u32 size)
 コピー
 
virtual u32 getPosition (void) const
 ストリーム位置を取得
 
virtual void setSize (u32)
 ストリームサイズ設定
 
virtual b32 isReadable (void) const
 読み込み可能判定
 
virtual b32 isWritable (void) const
 書き込み可能判定
 
virtual b32 isEnd (void) const
 ファイル終端判定
 
GX_FORCE_INLINE s32 getRemainSize (void) const
 残サイズ取得
 
GX_FORCE_INLINE b32 isCanceled (void) const
 キャンセルされた判定
 
constexpr void setAttribute (ATTRIBUTE attribute)
 
constexpr void clearAttribute (ATTRIBUTE attribute)
 
GX_FORCE_INLINE b32 getAttribute (ATTRIBUTE attribute) const
 
- Public Member Functions inherited from GxClassBase
constexpr GxClassBase (void)
 コンストラクタ
 
constexpr GxClassBase (const GxClassBase &base)
 コピーコンストラクタ
 
 ~GxClassBase (void) override
 デストラクタ
 
- Public Member Functions inherited from GxClassBaseRoot
constexpr GxClassBaseRoot (void)
 コンストラクタ
 
constexpr GxClassBaseRoot (const GxClassBaseRoot &)
 コピーコンストラクタ
 
virtual ~GxClassBaseRoot (void)
 デストラクタ
 
constexpr GxClassBaseRoot & operator= (const GxClassBaseRoot &)
 代入演算子
 
virtual GxRtti & getRtti (void) const =0
 Rttiの取得
 
virtual GX_FORCE_INLINE const GxTypedObject * getDefaultObject (void)
 デフォルトオブジェクトを取得
 
GX_FORCE_INLINE b32 isDefaultObject (void)
 デフォルトオブジェクト判定
 

Additional Inherited Members

- Public Types inherited from GxStream
enum  ATTRIBUTE { ATTRIBUTE_SEEKABLE = (1 << 0) , ATTRIBUTE_CANCELED = (1 << 1) }
 属性 More...
 
- Static Public Member Functions inherited from GxClassBaseRoot
static GX_FORCE_INLINE GxRtti & __getStaticRtti (void)
 Rttiの取得
 
- Static Public Attributes inherited from GxStream
static constexpr u32 COPY_TEMPORARY_BUFFER_SIZE = GxMath::VALUE_32K
 ストリームコピー用テンポラリバッファサイズ
 
- Protected Member Functions inherited from GxStream
 GxStream (void)
 コンストラクタ (継承先でのみインスタンス生成)
 
 ~GxStream (void) override
 デストラクタ
 

Detailed Description

リングストリームクラス

Member Function Documentation

◆ getSize()

GX_FORCE_INLINE u32 GxRingStream::getSize ( void ) const
inlineoverridevirtual

ストリームサイズ取得

Reimplemented from GxStream.

◆ initialize() [1/2]

b32 GxRingStream::initialize ( u32 size,
GxAllocator * pAllocator = nullptr,
GxMemory::ALIGNMENT alignment = GxMemory::ALIGNMENT::_16 )

初期化 (新規メモリ確保)

Parameters
size[in] 確保メモリサイズ
pAllocator[in] メモリ確保アロケータ (※nullptr指定の場合、テンポラリを使用)
alignment[in] メモリ確保アライメント
Returns
成功ならtrue
Here is the call graph for this function:

◆ initialize() [2/2]

b32 GxRingStream::initialize ( void * pBuffer,
u32 size )

初期化 (既存メモリ指定)

Parameters
pBuffer[in] 割付メモリアドレス
size[in] 割付メモリサイズ
Returns
成功ならtrue

◆ read()

u32 GxRingStream::read ( void * pDst,
u32 size )
overridevirtual

読み込み

Parameters
pDst[out] 読込先アドレス
size[in] 読み込みサイズ
Returns
実際読み込んだサイズ

Reimplemented from GxStream.

◆ write()

u32 GxRingStream::write ( const void * pSrc,
u32 size )
overridevirtual

書き込み

Parameters
pSrc[in] 書き込み元データアドレス
size[in] 書き込みサイズ
Returns
実際書き込んだサイズ

Reimplemented from GxStream.

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