Struct DSTORAGE_CONFIGURATION1

Struct Documentation

struct DSTORAGE_CONFIGURATION1

DirectStorage Configuration. Zero initializing this will result in the default values.

Public Members

UINT32 NumSubmitThreads

Sets the number of threads to use for submitting IO operations. Specifying 0 means use the system's best guess at a good value. Default == 0.

INT32 NumBuiltInCpuDecompressionThreads

Sets the number of threads to be used by the DirectStorage runtime to decompress data using the CPU for built-in compressed formats that cannot be decompressed using the GPU.

Specifying 0 means to use the system's best guess at a good value.

Specifying DSTORAGE_DISABLE_BUILTIN_CPU_DECOMPRESSION means no decompression threads will be created and the title is fully responsible for checking the custom decompression queue and pulling off ALL entries to decompress.

Default == 0.

BOOL ForceMappingLayer

Forces the use of the IO mapping layer, even when running on an operation system that doesn't require it. This may be useful during development, but should be set to the FALSE for release. Default=FALSE.

BOOL DisableBypassIO

Disables the use of the bypass IO optimization, even if it is available. This might be useful during development, but should be set to FALSE for release unless ForceFileBuffering is set to TRUE. Default == FALSE.

BOOL DisableTelemetry

Disables the reporting of telemetry data when set to TRUE. Telemetry data is enabled by default in the DirectStorage runtime. Default == FALSE.

BOOL DisableGpuDecompressionMetacommand

Disables the use of a decompression metacommand, even if one is available. This will force the runtime to use the built-in GPU decompression fallback shader. This may be useful during development, but should be set to the FALSE for release. Default == FALSE.

BOOL DisableGpuDecompression

Disables the use of GPU based decompression, even if it is available. This will force the runtime to use the CPU. Default=FALSE.

BOOL ForceFileBuffering

Forces the use of the built-in file caching behaviors supported within the Windows operating system by not setting FILE_FLAG_NO_BUFFERING when opening files.

DisableBypassIO must be set to TRUE when using this option or E_DSTORAGE_FILEBUFFERING_REQUIRES_DISABLED_BYPASSIO will be returned.

It is the title's responsibility to know when to use this setting. This feature should ONLY be enabled for slower HDD drives that will benefit from the OS file buffering features.

WARNING: Enabling file buffering on high speed drives may reduce overall performance when reading from that drive because BypassIO is also disabled. Default=FALSE.