ID3D12InfoQueue interface

An information-queue interface stores, retrieves, and filters debug messages. The queue consists of a message queue, an optional storage filter stack, and a optional retrieval filter stack.

Methods

The ID3D12InfoQueue interface has these methods.

Method Description
ID3D12InfoQueue::AddApplicationMessage Adds a user-defined message to the message queue and sends that message to debug output.
ID3D12InfoQueue::AddMessage Adds a debug message to the message queue and sends that message to debug output.
ID3D12InfoQueue::AddRetrievalFilterEntries Add storage filters to the top of the retrieval-filter stack.
ID3D12InfoQueue::AddStorageFilterEntries Add storage filters to the top of the storage-filter stack.
ID3D12InfoQueue::ClearRetrievalFilter Remove a retrieval filter from the top of the retrieval-filter stack.
ID3D12InfoQueue::ClearStorageFilter Remove a storage filter from the top of the storage-filter stack.
ID3D12InfoQueue::ClearStoredMessages Clear all messages from the message queue.
ID3D12InfoQueue::GetBreakOnCategory Get a message category to break on when a message with that category passes through the storage filter.
ID3D12InfoQueue::GetBreakOnID Get a message identifier to break on when a message with that identifier passes through the storage filter.
ID3D12InfoQueue::GetBreakOnSeverity Get a message severity level to break on when a message with that severity level passes through the storage filter.
ID3D12InfoQueue::GetMessage Get a message from the message queue.
ID3D12InfoQueue::GetMessageCountLimit Get the maximum number of messages that can be added to the message queue.
ID3D12InfoQueue::GetMuteDebugOutput Get a boolean that determines if debug output is on or off.
ID3D12InfoQueue::GetNumMessagesAllowedByStorageFilter Get the number of messages that were allowed to pass through a storage filter.
ID3D12InfoQueue::GetNumMessagesDeniedByStorageFilter Get the number of messages that were denied passage through a storage filter.
ID3D12InfoQueue::GetNumMessagesDiscardedByMessageCountLimit Get the number of messages that were discarded due to the message count limit.
ID3D12InfoQueue::GetNumStoredMessages Get the number of messages currently stored in the message queue.
ID3D12InfoQueue::GetNumStoredMessagesAllowedByRetrievalFilter Get the number of messages that are able to pass through a retrieval filter.
ID3D12InfoQueue::GetRetrievalFilter Get the retrieval filter at the top of the retrieval-filter stack.
ID3D12InfoQueue::GetRetrievalFilterStackSize Get the size of the retrieval-filter stack in bytes.
ID3D12InfoQueue::GetStorageFilter Get the storage filter at the top of the storage-filter stack.
ID3D12InfoQueue::GetStorageFilterStackSize Get the size of the storage-filter stack in bytes.
ID3D12InfoQueue::PopRetrievalFilter Pop a retrieval filter from the top of the retrieval-filter stack.
ID3D12InfoQueue::PopStorageFilter Pop a storage filter from the top of the storage-filter stack.
ID3D12InfoQueue::PushCopyOfRetrievalFilter Push a copy of retrieval filter currently on the top of the retrieval-filter stack onto the retrieval-filter stack.
ID3D12InfoQueue::PushCopyOfStorageFilter Push a copy of storage filter currently on the top of the storage-filter stack onto the storage-filter stack.
ID3D12InfoQueue::PushEmptyRetrievalFilter Push an empty retrieval filter onto the retrieval-filter stack.
ID3D12InfoQueue::PushEmptyStorageFilter Push an empty storage filter onto the storage-filter stack.
ID3D12InfoQueue::PushRetrievalFilter Push a retrieval filter onto the retrieval-filter stack.
ID3D12InfoQueue::PushStorageFilter Push a storage filter onto the storage-filter stack.
ID3D12InfoQueue::SetBreakOnCategory Set a message category to break on when a message with that category passes through the storage filter.
ID3D12InfoQueue::SetBreakOnID Set a message identifier to break on when a message with that identifier passes through the storage filter.
ID3D12InfoQueue::SetBreakOnSeverity Set a message severity level to break on when a message with that severity level passes through the storage filter.
ID3D12InfoQueue::SetMessageCountLimit Set the maximum number of messages that can be added to the message queue.
ID3D12InfoQueue::SetMuteDebugOutput Set a boolean that turns the debug output on or off.

Remarks

This interface is obtained by querying it from the ID3D12Device using IUnknown::QueryInterface.

Requirements

   
Target Platform Windows
Header d3d12sdklayers.h

See Also

Debug Layer Interfaces

IUnknown