Share via

XGameRuntimeOptions

  • Article

Information about the XGameRuntimeOptions structure.

Syntax

struct XGameRuntimeOptions 
{ 
    XGameRuntimeGameConfigSource gameConfigSource; 
    const char* gameConfig; 
}

Members

gameConfigSource
Type: XGameRuntimeGameConfigSource

gameConfig
Type: const char*

Remarks

The gameConfig field allows an app to pass a game config to the runtime. The gameConfig can be specified in different ways, as dictated by the gameConfigSource field. It may be one of:
| Game Config Type | Interpretation |
| --- | --- |
| Default | gameConfig must be null here. The default game config for the process will be used. | | Inline | gameConfig is a UTF-8 string containing the entire game config contents. | | File | gameConfig is a path to a game config file. This can be an absolute path or a relative path relative to the current directory. |

Requirements

Header: XGameRuntimeInit.h

Library: xgameruntime.lib

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

See also

XGameRuntimeInitializeWithOptions
XGameRuntimeConfigSource
XGameRuntimeInit
Developing new titles using Gaming Runtime