ストリーム読み込みクラス More...

#include <GxStreamReader.h>

Collaboration diagram for GxStreamReader:

[legend]

Public Types
定義
enum class	RESULT { SUCCESS = 0 , ERROR_CANCELED = -1 , ERROR_ADDRESS = -2 , ERROR_SIZE = -3 , ERROR_READ_FAILED = -4 , ERROR_RESERVE_FAILED = -5 }
	処理結果定義 More...

Public Member Functions
アクセサ
constexpr GxStream *	getStream (void) const
	ストリーム取得

GX_FORCE_INLINE u32	getCurrentPosition (void) const
	現在ストリーム位置取得

constexpr RESULT	getResult (void) const
	詳細結果取得

constexpr void	setEndian (GX_ENDIAN endian)
	エンディアン指定

constexpr GX_ENDIAN	getEndian (void) const
	エンディアン取得

Protected Attributes
メンバ変数
GxStream *	_pStream
	読み込みストリーム

GxMemoryStream *	_pExport
	エクスポート用ストリーム

RESULT	_result
	処理結果

GX_ENDIAN	_endian
	ストリーム内エンディアン定義

初期化
	GxStreamReader (void)
	ディフォルトコンストラクタ (※使用禁止)

	GxStreamReader (GxStream &stream, GX_ENDIAN endian=GX_ENDIAN::NATIVE, GxMemoryStream *pExport=nullptr)
	コンストラクタ

virtual	~GxStreamReader (void)
	デストラクタ

操作
virtual b32	read (void *pDst, u32 size)
	読み込み処理

b32	readS8 (s8 &dst)
	変数指定読み込み：符号つき 8bit整数

b32	readU8 (u8 &dst)
	変数指定読み込み：符号なし 8bit整数

b32	readS16 (s16 &dst)
	変数指定読み込み：符号つき 16bit整数

b32	readU16 (u16 &dst)
	変数指定読み込み：符号なし 16bit整数

b32	readS32 (s32 &dst)
	変数指定読み込み：符号つき 32bit整数

b32	readU32 (u32 &dst)
	変数指定読み込み：符号なし 32bit整数

b32	readS64 (s64 &dst)
	変数指定読み込み：符号つき 64bit整数

b32	readU64 (u64 &dst)
	変数指定読み込み：符号なし 64bit整数

b32	readS128 (s128 &dst)
	変数指定読み込み：符号つき 128bit整数

b32	readU128 (u128 &dst)
	変数指定読み込み：符号なし 128bit整数

b32	readB32 (b32 &dst)
	変数指定読み込み：ブール型

b32	readF32 (f32 &dst)
	変数指定読み込み：単精度浮動小数

b32	readF64 (f64 &dst)
	変数指定読み込み：倍精度浮動小数

void *	readBlock (void *pDst, u32 size)
	ブロック読み込み

void *	readPlane (void *pDst, u32 size)
	プレーン読み込み (エンディアン考慮しない)

constexpr void	setExportStream (GxMemoryStream *pExport)
	エクスポートストリーム設定

void *	exportS8 (void)
	変数指定エクスポート：符号つき 8bit整数

void *	exportU8 (void)
	変数指定エクスポート：符号なし 8bit整数

void *	exportS16 (void)
	変数指定エクスポート：符号つき 16bit整数

void *	exportU16 (void)
	変数指定エクスポート：符号なし 16bit整数

void *	exportS32 (void)
	変数指定エクスポート：符号つき 32bit整数

void *	exportU32 (void)
	変数指定エクスポート：符号なし 32bit整数

void *	exportS64 (void)
	変数指定エクスポート：符号つき 64bit整数

void *	exportU64 (void)
	変数指定エクスポート：符号なし 64bit整数

void *	exportB32 (void)
	変数指定エクスポート：ブール型

void *	exportF32 (void)
	変数指定エクスポート：単精度浮動小数

void *	exportF64 (void)
	変数指定エクスポート：倍精度浮動小数

void *	exportBlock (u32 size, GxMemory::ALIGNMENT alignment=GxMemory::ALIGNMENT::_4)
	エクスポート領域へブロック指定読み込み

void *	exportReserve (u32 size, GxMemory::ALIGNMENT alignment=GxMemory::ALIGNMENT::_4)
	エクスポート領域からメモリ指定確保

void *	getExportCurrent (GxMemory::ALIGNMENT alignment=GxMemory::ALIGNMENT::_4)
	エクスポート領域の現在アドレス取得

Detailed Description

ストリーム読み込みクラス

Member Enumeration Documentation

◆ RESULT

enum class GxStreamReader::RESULT

strong

処理結果定義

Enumerator
SUCCESS	正常：成功
ERROR_CANCELED	エラー：キャンセルされた
ERROR_ADDRESS	エラー：アドレスが不正
ERROR_SIZE	エラー：サイズが不正
ERROR_READ_FAILED	エラー：読み込み失敗
ERROR_RESERVE_FAILED	エラー：エクスポート領域リザーブ失敗

Member Function Documentation

◆ exportB32()

void * GxStreamReader::exportB32 ( void )

変数指定エクスポート：ブール型

Returns: 読み込んだエクスポート領域先頭アドレス (nullptrの場合、エクスポート失敗)

Here is the call graph for this function:

◆ exportBlock()

void * GxStreamReader::exportBlock	(	u32	size,
		GxMemory::ALIGNMENT	alignment = GxMemory::ALIGNMENT::_4 )

エクスポート領域へブロック指定読み込み

Parameters

size	[in] 読み込みサイズ
alignment	[in] 読み込みアライメント

Returns: 読み込んだエクスポート領域先頭アドレス (nullptrの場合、エクスポート失敗)

Here is the call graph for this function:

◆ exportF32()

void * GxStreamReader::exportF32 ( void )

変数指定エクスポート：単精度浮動小数

Returns: 読み込んだエクスポート領域先頭アドレス (nullptrの場合、エクスポート失敗)

Here is the call graph for this function:

◆ exportF64()

void * GxStreamReader::exportF64 ( void )

変数指定エクスポート：倍精度浮動小数

Returns: 読み込んだエクスポート領域先頭アドレス (nullptrの場合、エクスポート失敗)

Here is the call graph for this function:

◆ exportReserve()

void * GxStreamReader::exportReserve	(	u32	size,
		GxMemory::ALIGNMENT	alignment = GxMemory::ALIGNMENT::_4 )

エクスポート領域からメモリ指定確保

Parameters

size	[in] 確保サイズ
alignment	[in] 確保アライメント

Returns: 確保したエクスポート領域先頭アドレス (nullptrの場合、確保失敗)

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exportS16()

void * GxStreamReader::exportS16 ( void )

変数指定エクスポート：符号つき 16bit整数

Returns: 読み込んだエクスポート領域先頭アドレス (nullptrの場合、エクスポート失敗)

Here is the call graph for this function:

◆ exportS32()

void * GxStreamReader::exportS32 ( void )

変数指定エクスポート：符号つき 32bit整数

Returns: 読み込んだエクスポート領域先頭アドレス (nullptrの場合、エクスポート失敗)

Here is the call graph for this function:

◆ exportS64()

void * GxStreamReader::exportS64 ( void )

変数指定エクスポート：符号つき 64bit整数

Returns: 読み込んだエクスポート領域先頭アドレス (nullptrの場合、エクスポート失敗)

Here is the call graph for this function:

◆ exportS8()

void * GxStreamReader::exportS8 ( void )

変数指定エクスポート：符号つき 8bit整数

Returns: 読み込んだエクスポート領域先頭アドレス (nullptrの場合、エクスポート失敗)

Here is the call graph for this function:

◆ exportU16()

void * GxStreamReader::exportU16 ( void )

変数指定エクスポート：符号なし 16bit整数

Returns: 読み込んだエクスポート領域先頭アドレス (nullptrの場合、エクスポート失敗)

Here is the call graph for this function:

◆ exportU32()

void * GxStreamReader::exportU32 ( void )

変数指定エクスポート：符号なし 32bit整数

Returns: 読み込んだエクスポート領域先頭アドレス (nullptrの場合、エクスポート失敗)

Here is the call graph for this function:

◆ exportU64()

void * GxStreamReader::exportU64 ( void )

変数指定エクスポート：符号なし 64bit整数

Returns: 読み込んだエクスポート領域先頭アドレス (nullptrの場合、エクスポート失敗)

Here is the call graph for this function:

◆ exportU8()

void * GxStreamReader::exportU8 ( void )

変数指定エクスポート：符号なし 8bit整数

Returns: 読み込んだエクスポート領域先頭アドレス (nullptrの場合、エクスポート失敗)

Here is the call graph for this function:

◆ getExportCurrent()

void * GxStreamReader::getExportCurrent ( GxMemory::ALIGNMENT alignment = GxMemory::ALIGNMENT::_4 )

エクスポート領域の現在アドレス取得

Parameters

alignment [in] アライメント

Returns: エクスポート領域先頭アドレス (nullptrの場合、取得失敗)

Here is the call graph for this function:

◆ read()

b32 GxStreamReader::read	(	void *	pDst,
		u32	size )

protectedvirtual

読み込み処理

Parameters

pDst	[out] 読込先バッファポインタ
size	[in] 読み込みサイズ

Returns: 成功ならtrue

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readB32()

b32 GxStreamReader::readB32 ( b32 & dst )

変数指定読み込み：ブール型

Parameters

dst	[out] 読込先ワーク

Returns: 成功ならtrue

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readBlock()

void * GxStreamReader::readBlock	(	void *	pDst,
		u32	size )

ブロック読み込み

Parameters

pDst	[out] 読込先バッファポインタ (※4byteアライメント必須)
size	[in] 読み込みサイズ (※4byteアライメント必須)

Returns: 読み込み後移動バッファポインタ位置 (nullptrの場合、読み込み失敗)

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readF32()

b32 GxStreamReader::readF32 ( f32 & dst )

変数指定読み込み：単精度浮動小数

Parameters

dst	[out] 読込先ワーク

Returns: 成功ならtrue

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readF64()

b32 GxStreamReader::readF64 ( f64 & dst )

変数指定読み込み：倍精度浮動小数

Parameters

dst	[out] 読込先ワーク

Returns: 成功ならtrue

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readPlane()

void * GxStreamReader::readPlane	(	void *	pDst,
		u32	size )

プレーン読み込み (エンディアン考慮しない)

Parameters

pDst	[out] 読込先バッファポインタ
size	[in] 読み込みサイズ

Returns: 読み込み後移動バッファポインタ位置 (nullptrの場合、読み込み失敗)

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readS128()

b32 GxStreamReader::readS128 ( s128 & dst )

変数指定読み込み：符号つき 128bit整数

Parameters

dst	[out] 読込先ワーク

Returns: 成功ならtrue

Here is the call graph for this function:

◆ readS16()

b32 GxStreamReader::readS16 ( s16 & dst )

変数指定読み込み：符号つき 16bit整数

Parameters

dst	[out] 読込先ワーク

Returns: 成功ならtrue

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readS32()

b32 GxStreamReader::readS32 ( s32 & dst )

変数指定読み込み：符号つき 32bit整数

Parameters

dst	[out] 読込先ワーク

Returns: 成功ならtrue

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readS64()

b32 GxStreamReader::readS64 ( s64 & dst )

変数指定読み込み：符号つき 64bit整数

Parameters

dst	[out] 読込先ワーク

Returns: 成功ならtrue

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readS8()

b32 GxStreamReader::readS8 ( s8 & dst )

変数指定読み込み：符号つき 8bit整数

Parameters

dst	[out] 読込先ワーク

Returns: 成功ならtrue

Here is the caller graph for this function:

◆ readU128()

b32 GxStreamReader::readU128 ( u128 & dst )

変数指定読み込み：符号なし 128bit整数

Parameters

dst	[out] 読込先ワーク

Returns: 成功ならtrue

Here is the call graph for this function:

◆ readU16()

b32 GxStreamReader::readU16 ( u16 & dst )

変数指定読み込み：符号なし 16bit整数

Parameters

dst	[out] 読込先ワーク

Returns: 成功ならtrue

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readU32()

b32 GxStreamReader::readU32 ( u32 & dst )

変数指定読み込み：符号なし 32bit整数

Parameters

dst	[out] 読込先ワーク

Returns: 成功ならtrue

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readU64()

b32 GxStreamReader::readU64 ( u64 & dst )

変数指定読み込み：符号なし 64bit整数

Parameters

dst	[out] 読込先ワーク

Returns: 成功ならtrue

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readU8()

b32 GxStreamReader::readU8 ( u8 & dst )

変数指定読み込み：符号なし 8bit整数

Parameters

dst	[out] 読込先ワーク

Returns: 成功ならtrue

Here is the call graph for this function:

Here is the caller graph for this function:

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

C:/Users/t-arai/Documents/workspace/orochi_package_windows/middleware/GxCore/src/GxStreamReader.h
C:/Users/t-arai/Documents/workspace/orochi_package_windows/middleware/GxCore/src/GxStreamReader.cpp

Public Types

Public Member Functions

Protected Attributes

初期化

操作

Detailed Description

Member Enumeration Documentation

◆ RESULT

Member Function Documentation

◆ exportB32()

◆ exportBlock()

◆ exportF32()

◆ exportF64()

◆ exportReserve()

◆ exportS16()

◆ exportS32()

◆ exportS64()

◆ exportS8()

◆ exportU16()

◆ exportU32()

◆ exportU64()

◆ exportU8()

◆ getExportCurrent()

◆ read()

◆ readB32()

◆ readBlock()

◆ readF32()

◆ readF64()

◆ readPlane()

◆ readS128()

◆ readS16()

◆ readS32()

◆ readS64()

◆ readS8()

◆ readU128()

◆ readU16()

◆ readU32()

◆ readU64()

◆ readU8()