OpenSiv3D  v0.6.5
C++20 framework for creative coding
s3d::MemoryViewReader Class Reference

#include <MemoryViewReader.hpp>

Inherits s3d::IReader.

Public Member Functions

SIV3D_NODISCARD_CXX20 MemoryViewReader ()=default
 
SIV3D_NODISCARD_CXX20 MemoryViewReader (const void *data, size_t size_bytes) noexcept
 
bool supportsLookahead () const noexcept override
 読み込み位置を変更しないデータ読み込みをサポートしているかを返します。 More...
 
bool isOpen () const noexcept override
 Reader が使用可能かを返します。 More...
 
int64 size () const override
 Reader のサイズを返します。 More...
 
int64 getPos () const override
 Reader の現在の読み込み位置を返します。 More...
 
bool setPos (int64 pos) override
 Reader の読み込み位置を変更します。 More...
 
int64 skip (int64 offset) override
 Reader を読み飛ばし、読み込み位置を変更します。 More...
 
int64 read (void *dst, int64 size) override
 Reader からデータを読み込みます。 More...
 
int64 read (void *dst, int64 pos, int64 size) override
 Reader からデータを読み込みます。 More...
 
SIV3D_CONCEPT_TRIVIALLY_COPYABLE bool read (TriviallyCopyable &dst)
 Reader からデータを読み込みます。 More...
 
int64 lookahead (void *dst, int64 size) const override
 Reader から読み込み位置を変更しないでデータを読み込みます。 More...
 
int64 lookahead (void *dst, int64 pos, int64 size) const override
 Reader から読み込み位置を変更しないでデータを読み込みます。 More...
 
SIV3D_CONCEPT_TRIVIALLY_COPYABLE bool lookahead (TriviallyCopyable &dst) const
 読み込み位置を変更しないで Reader からデータを読み込みます。 More...
 
- Public Member Functions inherited from s3d::IReader
virtual ~IReader ()=default
 デストラクタ More...
 
SIV3D_CONCEPT_TRIVIALLY_COPYABLE bool read (TriviallyCopyable &dst)
 Reader からデータを読み込みます。 More...
 
SIV3D_CONCEPT_TRIVIALLY_COPYABLE bool lookahead (TriviallyCopyable &dst) const
 読み込み位置を変更しないで Reader からデータを読み込みます。 More...
 

Constructor & Destructor Documentation

◆ MemoryViewReader() [1/2]

SIV3D_NODISCARD_CXX20 s3d::MemoryViewReader::MemoryViewReader ( )
default

◆ MemoryViewReader() [2/2]

SIV3D_NODISCARD_CXX20 s3d::MemoryViewReader::MemoryViewReader ( const void *  data,
size_t  size_bytes 
)
noexcept

Member Function Documentation

◆ getPos()

int64 s3d::MemoryViewReader::getPos ( ) const
overridevirtual

Reader の現在の読み込み位置を返します。

Returns
現在の読み込み位置(バイト)

Implements s3d::IReader.

◆ isOpen()

bool s3d::MemoryViewReader::isOpen ( ) const
overridevirtualnoexcept

Reader が使用可能かを返します。

Returns
Reader が使用可能な場合 true, それ以外の場合は false

Implements s3d::IReader.

◆ lookahead() [1/3]

SIV3D_CONCEPT_TRIVIALLY_COPYABLE bool s3d::MemoryViewReader::lookahead ( TriviallyCopyable &  dst) const

読み込み位置を変更しないで Reader からデータを読み込みます。

Template Parameters
Type読み込む値の型
Parameters
dst読み込み先
Returns
読み込みに成功したら true, それ以外の場合は false

◆ lookahead() [2/3]

int64 s3d::MemoryViewReader::lookahead ( void *  dst,
int64  pos,
int64  size 
) const
overridevirtual

Reader から読み込み位置を変更しないでデータを読み込みます。

Parameters
dst読み込み先
pos先頭から数えた読み込み開始位置(バイト)
size読み込むサイズ(バイト)
Returns
実際に読み込んだサイズ(バイト)

Implements s3d::IReader.

◆ lookahead() [3/3]

int64 s3d::MemoryViewReader::lookahead ( void *  dst,
int64  size 
) const
overridevirtual

Reader から読み込み位置を変更しないでデータを読み込みます。

Parameters
dst読み込み先
size読み込むサイズ(バイト)
Returns
実際に読み込んだサイズ(バイト)

Implements s3d::IReader.

◆ read() [1/3]

SIV3D_CONCEPT_TRIVIALLY_COPYABLE bool s3d::MemoryViewReader::read ( TriviallyCopyable &  dst)

Reader からデータを読み込みます。

Template Parameters
Type読み込む値の型
Parameters
dst読み込み先
Returns
読み込みに成功した場合 true, それ以外の場合は false

◆ read() [2/3]

int64 s3d::MemoryViewReader::read ( void *  dst,
int64  pos,
int64  size 
)
overridevirtual

Reader からデータを読み込みます。

Parameters
dst読み込み先
pos先頭から数えた読み込み開始位置(バイト)
size読み込むサイズ(バイト)
Returns
実際に読み込んだサイズ(バイト)

Implements s3d::IReader.

◆ read() [3/3]

int64 s3d::MemoryViewReader::read ( void *  dst,
int64  size 
)
overridevirtual

Reader からデータを読み込みます。

Parameters
dst読み込み先
size読み込むサイズ(バイト)
Returns
実際に読み込んだサイズ(バイト)

Implements s3d::IReader.

◆ setPos()

bool s3d::MemoryViewReader::setPos ( int64  pos)
overridevirtual

Reader の読み込み位置を変更します。

Parameters
pos新しい読み込み位置(バイト)
Returns
読み込み位置の変更に成功した場合 true, それ以外の場合は false

Implements s3d::IReader.

◆ size()

int64 s3d::MemoryViewReader::size ( ) const
overridevirtual

Reader のサイズを返します。

Returns
Reader のサイズ(バイト)

Implements s3d::IReader.

◆ skip()

int64 s3d::MemoryViewReader::skip ( int64  offset)
overridevirtual

Reader を読み飛ばし、読み込み位置を変更します。

Parameters
offset読み飛ばすサイズ(バイト)
Returns
新しい読み込み位置(バイト)

Implements s3d::IReader.

◆ supportsLookahead()

bool s3d::MemoryViewReader::supportsLookahead ( ) const
overridevirtualnoexcept

読み込み位置を変更しないデータ読み込みをサポートしているかを返します。

Returns
読み込み位置を変更しないデータ読み込みをサポートしている場合 true, それ以外の場合は false

Implements s3d::IReader.


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