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::ReadRequestData Struct Reference

#include <FileRequest.h>

Public Member Functions

 ReadRequestData (RequestPath path, void *output, u64 outputSize, u64 offset, u64 size, AZStd::chrono::steady_clock::time_point deadline, IStreamerTypes::Priority priority)
 
 ReadRequestData (RequestPath path, IStreamerTypes::RequestMemoryAllocator *allocator, u64 offset, u64 size, AZStd::chrono::steady_clock::time_point deadline, IStreamerTypes::Priority priority)
 

Public Attributes

RequestPath m_path
 Relative path to the target file.
 
IStreamerTypes::RequestMemoryAllocatorm_allocator
 Allocator used to manage the memory for this request.
 
AZStd::chrono::steady_clock::time_point m_deadline
 Time by which this request should have been completed.
 
void * m_output
 The memory address assigned (during processing) to store the read data to.
 
u64 m_outputSize
 The memory size of the addressed used to store the read data.
 
u64 m_offset
 The offset in bytes into the file.
 
u64 m_size
 The number of bytes to read from the file.
 
IStreamerTypes::Priority m_priority
 Priority used for ordering requests. This is used when requests have the same deadline.
 
IStreamerTypes::MemoryType m_memoryType
 The type of memory provided by the allocator if used.
 

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 an untranslated request and holds a relative path. The Scheduler will translate this to the appropriate ReadData or CompressedReadData.


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