Partager via

XGameRuntimeFeature

  • Article

Enumerates Gaming Runtime features.

Syntax

enum class XGameRuntimeFeature  : uint32_t  
{  
    XAccessibility = 0,  
    XAppCapture = 1,  
    XAsync = 2,  
    XAsyncProvider = 3,  
    XDisplay = 4,  
    XGame = 5,  
    XGameInvite = 6,  
    XGameSave = 7,  
    XGameUI = 8,  
    XLauncher = 9,  
    XNetworking = 10,  
    XPackage = 11,  
    XPersistentLocalStorage = 12,  
    XSpeechSynthesizer = 13,  
    XStore = 14,  
    XSystem = 15,  
    XTaskQueue = 16,  
    XThread = 17,  
    XUser = 18,  
    XError = 19,  
    XGameEvent = 20, 
    XGameStreaming = 21, 
}

Constants

Constant Description
XAccessibility Represents the Accessibility feature. For more information, see XAccessibility.
XAppCapture Represents the AppCapture feature. For more information, see XAppCapture.
XAsync Represents the Async feature. For more information about using the Async feature, see Asynchronous Programming Model and XAsync.
XAsyncProvider Represents the AsyncProvider feature. For more information about using the AsyncProvider feature, see Asynchronous Programming Model and XAsyncProvider.
XDisplay Represents the Display feature. For more information, see XDisplay.
XGame Represents the Game feature. For more information, see XGame.
XGameInvite Represents the GameInvite feature. For more information, see XGameInvite.
XGameSave Represents the GameSave feature. For more information, see XGameSave.
XGameUI Represents the GameUI feature. For more information, see XGameUI.
XLauncher Represents the Launcher feature. For more information, see XLauncher.
XNetworking Represents the Networking feature. For more information about using the Networking feature, see Networking and XNetworking.
XPackage Represents the Package feature. For more information about using the Package feature, see Packaging and XPackage.
XPersistentLocalStorage Represents the PersistentLocalStorage feature. For more information about using the PersistentLocalStorage feature, see Local Storage and XPersistentLocalStorage.
XSpeechSynthesizer Represents the SpeechSynthesizer feature. For more information, see XSpeechSynthesizer.
XStore Represents the Store feature. For more information, see XStore.
XSystem Represents the System feature. For more information, see XSystem.
XTaskQueue Represents the TaskQueue feature. For more information about using the TaskQueue feature, see Async Task Queue Design and XTaskQueue.
XThread Represents the Thread feature. For more information, see XThread.
XUser Represents the User feature. For more information, see XUser.
XError Represents the Error feature. For more information, see XError.
XGameEvent Represents the GameEvent feature.
XGameStreaming Represents the GameStreaming feature. For more information, see XGameStreaming

Remarks

This enumeration is used by the XGameRuntimeIsFeatureAvailable function to specify a Gaming Runtime feature.

The following example uses the XGameRuntimeIsFeatureAvailable function to check whether the Async, AsyncProvider, and TaskQueue features are available. All three features are necessary for using task queues to run asynchronous tasks.

// Confirm that all of the features needed to run asynchronous tasks on 
// task queues are available.
bool Game::CheckAsyncTaskQueueFeatures()
{
    
    return (XGameRuntimeIsFeatureAvailable(XGameRuntimeFeature::XTaskQueue) &&
        XGameRuntimeIsFeatureAvailable(XGameRuntimeFeature::XAsyncProvider) &&
        XGameRuntimeIsFeatureAvailable(XGameRuntimeFeature::XAsync));

}

Requirements

Header: XGameRuntimeFeature.h

Supported platforms: Windows, Xbox One family consoles and Xbox Series consoles

See also

Gaming Runtime Glossary
XGameRuntimeFeature
XGameRuntimeIsFeatureAvailable