IDStorageQueueX

Represents a DirectStorage queue.

Syntax

class IDStorageQueueX : public IUnknown  

Methods

Method Description
CancelRequestsWithTag Attempts to cancel a group of previously enqueued read requests.
IDStorageQueueX::Close Closes the DirectStorage queue.
EnqueueRequest Enqueues a read request.
EnqueueSignal Enqueues a fence write.
EnqueueStatus Enqueues a status write.
GetErrorEvent Obtains an event to wait on.
RetrieveErrorRecord Retrieves an error record.
Submit Submits enqueued requests to DirectStorage.
Query Obtains information about the queue.

Remarks

A DirectStorage queue holds entries until the title calls Submit on the queue, or one of the Enqueue methods fills more than half of the queue's capacity since last submission and triggers an automatic submission. All entries in a DirectStorage queue complete in the order they are enqueued.

For more information, see the "IDStorageQueueX" section in DirectStorage overview.

Requirements

Header: dstorage_xs.h

Library: dstorage.lib

Supported platforms: Xbox Series consoles

See also

IDStorageFactoryX::CreateQueue
DStorage