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::StorageDriveWin::ConstructionOptions Struct Reference

Public Attributes

u8 m_hasSeekPenalty: 1
 
u8 m_enableUnbufferedReads: 1
 
u8 m_enableSharing: 1
 
u8 m_minimalReporting: 1
 

Member Data Documentation

◆ m_enableSharing

u8 AZ::IO::StorageDriveWin::ConstructionOptions::m_enableSharing

Globally enable file sharing. This allows files to used outside AZ::IO::Streamer, including other applications while in use by AZ::IO::Streamer.

◆ m_enableUnbufferedReads

u8 AZ::IO::StorageDriveWin::ConstructionOptions::m_enableUnbufferedReads

Use unbuffered reads for the fastest possible read speeds by bypassing the Windows file cache. This results in a faster read the first time a file is read, but subsequent reads will possibly be slower as those could have been serviced from the faster OS cache. During development or for games that reread files frequently it's recommended to set this option to false, but generally it's best to be turned on. Unbuffered reads have alignment restrictions. Many of the other stream stack entry are (optionally) aware and make adjustments. For the most optimal performance align read buffers to the physicalSectorSize.

◆ m_hasSeekPenalty

u8 AZ::IO::StorageDriveWin::ConstructionOptions::m_hasSeekPenalty

Whether or not the device has a cost for seeking, such as happens on platter disks. This will be accounted for when predicting file reads.

◆ m_minimalReporting

u8 AZ::IO::StorageDriveWin::ConstructionOptions::m_minimalReporting

If true, only information that's explicitly requested or issues are reported. If false, status information such as when drives are created and destroyed is reported as well.


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