dawn::io_data_view_t Struct Reference

Non-owning I/O data view over caller-provided storage. More...

#include <viewdata.hxx>

Inherits io_data_cmn_t.

Public Member Functions
	io_data_view_t (void *dataBuffer, size_t dataBytes, size_t dataItems=1)
	Constructor.
void *	getDataPtr (size_t batch=0)
	Get pointer to viewed data.
size_t	getDataSize ()
	Get viewed data size in bytes.
size_t	getItems ()
	Get number of items in the viewed buffer.
void *	getPtr (size_t batch=0)
	Get pointer to viewed buffer.
io_ts_t &	getTs (size_t batch=0)
	Get timestamp reference (returns shared dummy).
bool	hasTimestamp ()
	This view has no per-batch timestamp storage.

Public Attributes
void *	buffer
	Caller-owned data buffer.
size_t	bytes
	Buffer size in bytes.
io_ts_t	dummyTs
	Dummy timestamp for API compatibility.
size_t	items
	Number of data items in the buffer.

Detailed Description

Non-owning I/O data view over caller-provided storage.

Definition at line 17 of file viewdata.hxx.

Constructor & Destructor Documentation

io_data_view_t()

dawn::io_data_view_t::io_data_view_t ( void *  dataBuffer, size_t  dataBytes, size_t  dataItems = 1  )

inline

Constructor.

Parameters

dataBuffer	Caller-owned data buffer.
dataBytes	Buffer size in bytes.
dataItems	Number of data items in the buffer (default 1).

Definition at line 32 of file viewdata.hxx.

Member Function Documentation

getDataPtr()

void * dawn::io_data_view_t::getDataPtr ( size_t  batch = 0 )

inline

Get pointer to viewed data.

Parameters

batch

Batch index (ignored; views expose one contiguous buffer).

Returns

Void pointer to viewed data.

Definition at line 74 of file viewdata.hxx.

References buffer.

getPtr()

void * dawn::io_data_view_t::getPtr ( size_t  batch = 0 )

inline

Get pointer to viewed buffer.

Parameters

batch

Batch index (ignored; views expose one contiguous buffer).

Returns

Void pointer to viewed buffer.

Definition at line 61 of file viewdata.hxx.

References buffer.

getTs()

io_ts_t & dawn::io_data_view_t::getTs ( size_t  batch = 0 )

inline

Get timestamp reference (returns shared dummy).

Parameters

batch

Batch index (ignored).

Returns

Reference to dummy timestamp.

Definition at line 94 of file viewdata.hxx.

References dummyTs.

---

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

• dawn/include/dawn/io/viewdata.hxx