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::ReadSplitter Class Reference

Inherits AZ::IO::StreamStackEntry.

Public Member Functions

 ReadSplitter (u64 maxReadSize, u32 memoryAlignment, u32 sizeAlignment, size_t bufferSize, bool adjustOffset, bool splitAlignedRequests)
 
void QueueRequest (FileRequest *request) override
 
void UpdateStatus (Status &status) const override
 Gets a combined status update from all the nodes in the stack.
 
void CollectStatistics (AZStd::vector< Statistic > &statistics) const override
 
- Public Member Functions inherited from AZ::IO::StreamStackEntry
 StreamStackEntry (AZStd::string &&name)
 
virtual const AZStd::stringGetName () const
 Returns the name that uniquely identifies this entry.
 
virtual void SetNext (AZStd::shared_ptr< StreamStackEntry > next)
 
virtual AZStd::shared_ptr< StreamStackEntryGetNext () const
 
virtual void SetContext (StreamerContext &context)
 
virtual void PrepareRequest (FileRequest *request)
 
virtual void QueueRequest (FileRequest *request)
 
virtual bool ExecuteRequests ()
 
virtual void UpdateStatus (Status &status) const
 Gets a combined status update from all the nodes in the stack.
 
virtual void UpdateCompletionEstimates (AZStd::chrono::steady_clock::time_point now, AZStd::vector< FileRequest * > &internalPending, StreamerContext::PreparedQueue::iterator pendingBegin, StreamerContext::PreparedQueue::iterator pendingEnd)
 
virtual void CollectStatistics (AZStd::vector< Statistic > &statistics) const
 

Additional Inherited Members

- Protected Attributes inherited from AZ::IO::StreamStackEntry
AZStd::string m_name
 The name that uniquely identifies this entry.
 
AZStd::shared_ptr< StreamStackEntrym_next
 The next entry in the stack.
 
StreamerContextm_context
 Context information for the entire streaming stack.
 

Member Function Documentation

◆ CollectStatistics()

void AZ::IO::ReadSplitter::CollectStatistics ( AZStd::vector< Statistic > &  statistics) const
overridevirtual

Collect various statistics on this stack entry. These are for profiling and debugging purposes only.

Reimplemented from AZ::IO::StreamStackEntry.

◆ QueueRequest()

void AZ::IO::ReadSplitter::QueueRequest ( FileRequest request)
overridevirtual

Queues a request to be executed at a later point when ExecuteRequests is called. This can include splitting up the request in more fine-grained steps.

Reimplemented from AZ::IO::StreamStackEntry.

◆ UpdateStatus()

void AZ::IO::ReadSplitter::UpdateStatus ( Status status) const
overridevirtual

Gets a combined status update from all the nodes in the stack.

Reimplemented from AZ::IO::StreamStackEntry.


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