XGameRuntimeIsFeatureAvailable

Article
06/22/2023

Indicates whether a Gaming Runtime feature is available.

Syntax

bool XGameRuntimeIsFeatureAvailable(  
         XGameRuntimeFeature feature  
)

Parameters

feature
Type: XGameRuntimeFeature

The Gaming Runtime feature to query.

Return value

Type: bool

Returns true if the Gaming Runtime feature is available; false otherwise.

Remarks

After the Gaming Runtime is initialized with XGameRuntimeInitialize, use this function to check whether specific Gaming Runtime features are available to your game.

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

Library: xgameruntime.lib

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

Share via