Open 3D Engine AzCore API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
AZ::IO::Requests::ReadData Struct Reference

#include <FileRequest.h>

Public Member Functions

 ReadData (void *output, u64 outputSize, const RequestPath &path, u64 offset, u64 size, bool sharedRead)
 

Public Attributes

const RequestPathm_path
 The path to the file that contains the requested data.
 
void * m_output
 Target output to write the read data to.
 
u64 m_outputSize
 Size of memory m_output points to. This needs to be at least as big as m_size, but can be bigger.
 
u64 m_offset
 The offset in bytes into the file.
 
u64 m_size
 The number of bytes to read from the file.
 
bool m_sharedRead
 True if other code will be reading from the file or the stack entry can exclusively lock.
 

Static Public Attributes

static constexpr IStreamerTypes::Priority s_orderPriority = IStreamerTypes::s_priorityMedium
 
static constexpr bool s_failWhenUnhandled = true
 

Detailed Description

Request to read data. This is a translated request and holds an absolute path and has been resolved to the archive file if needed.


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