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

ストリーム基礎クラス More...

#include <GxStream.h>

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

Public Member Functions

操作
virtual void close (void)
 クローズ
 
virtual u32 read (void *, u32)
 読み込み
 
virtual u32 write (const void *, u32)
 書き込み
 
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 u32 getSize (void) const
 ストリームサイズ取得
 
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)
 デフォルトオブジェクト判定
 

Protected Member Functions

初期化
 GxStream (void)
 コンストラクタ (継承先でのみインスタンス生成)
 
 ~GxStream (void) override
 デストラクタ
 

定義

enum  ATTRIBUTE { ATTRIBUTE_SEEKABLE = (1 << 0) , ATTRIBUTE_CANCELED = (1 << 1) }
 属性 More...
 
static constexpr u32 COPY_TEMPORARY_BUFFER_SIZE = GxMath::VALUE_32K
 ストリームコピー用テンポラリバッファサイズ
 

Additional Inherited Members

- Static Public Member Functions inherited from GxClassBaseRoot
static GX_FORCE_INLINE GxRtti & __getStaticRtti (void)
 Rttiの取得
 

Detailed Description

ストリーム基礎クラス

Member Enumeration Documentation

◆ ATTRIBUTE

enum GxStream::ATTRIBUTE

属性

Enumerator
ATTRIBUTE_SEEKABLE 

シーク可能

ATTRIBUTE_CANCELED 

キャンセルされた

Member Function Documentation

◆ clearAttribute()

void GxStream::clearAttribute ( ATTRIBUTE attribute)
inlineconstexpr

属性のクリア

Parameters
attribute[in] 対象の属性マスク

◆ close()

virtual void GxStream::close ( void )
inlinevirtual

クローズ

Reimplemented in GxFileStream.

Here is the caller graph for this function:

◆ copy()

u32 GxStream::copy ( GxStream & dst,
u32 size )

コピー

Parameters
dst[in,out] コピー先ストリーム
size[in] コピーサイズ
Returns
実際コピーしたサイズ
Here is the call graph for this function:

◆ flush()

virtual void GxStream::flush ( void )
inlinevirtual

フラッシュ

Reimplemented in GxFileStream.

Here is the caller graph for this function:

◆ getAttribute()

GX_FORCE_INLINE b32 GxStream::getAttribute ( ATTRIBUTE attribute) const
inline

属性の取得

Parameters
attribute[in] 対象の属性マスク
Returns
対象の属性は設定されているならtrue
Here is the caller graph for this function:

◆ getPosition()

virtual u32 GxStream::getPosition ( void ) const
inlinevirtual

ストリーム位置を取得

Reimplemented in GxFileStream, GxMemoryStream, and GxZlibReadStream.

◆ getSize()

virtual u32 GxStream::getSize ( void ) const
inlinevirtual

ストリームサイズ取得

Reimplemented in GxFileStream, GxMemoryStream, GxRingStream, and GxZlibReadStream.

◆ isReadable()

virtual b32 GxStream::isReadable ( void ) const
inlinevirtual

読み込み可能判定

Reimplemented in GxFileStream, GxMemoryStream, and GxZlibReadStream.

◆ isWritable()

virtual b32 GxStream::isWritable ( void ) const
inlinevirtual

書き込み可能判定

Reimplemented in GxFileStream, GxMemoryStream, and GxZlibReadStream.

◆ read()

virtual u32 GxStream::read ( void * ,
u32  )
inlinevirtual

読み込み

Reimplemented in GxFileStream, GxMemoryStream, GxRingStream, and GxZlibReadStream.

Here is the caller graph for this function:

◆ seek()

virtual u32 GxStream::seek ( s32 ,
GxFile::SEEK_TYPE = GxFile::SEEK_TYPE::BEGIN )
inlinevirtual

シーク

Reimplemented in GxFileStream, GxMemoryStream, and GxZlibReadStream.

Here is the caller graph for this function:

◆ setAttribute()

void GxStream::setAttribute ( ATTRIBUTE attribute)
inlineconstexpr

属性の設定

Parameters
attribute[in] 対象の属性マスク
Here is the caller graph for this function:

◆ write()

virtual u32 GxStream::write ( const void * ,
u32  )
inlinevirtual

書き込み

Reimplemented in GxFileStream, GxMemoryStream, and GxRingStream.

Here is the caller graph for this function:
The documentation for this class was generated from the following files: