GameModeConfiguration Class

Reference

Definition

Namespace:: Windows.Gaming.Preview.GamesEnumeration

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

A collection of properties related to how a GameListEntry operates in Game Mode

public ref class GameModeConfiguration sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Gaming.Preview.GamesEnumerationContract, 131072)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class GameModeConfiguration final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Gaming.Preview.GamesEnumerationContract), 131072)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class GameModeConfiguration

Public NotInheritable Class GameModeConfiguration

Inheritance: Object Platform::Object IInspectable GameModeConfiguration

Attributes: ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Windows requirements

Device family	Windows Desktop Extension SDK (introduced in 10.0.16299.0) Windows Mobile Extension SDK (introduced in 10.0.16299.0)
API contract	Windows.Gaming.Preview.GamesEnumerationContract (introduced in v2.0)
App capabilities	gameList

Remarks

This API is not available to all apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.

Properties

AffinitizeToExclusiveCpus	CPUs are exclusive to the game’s process not shared with other processes.
CpuExclusivityMaskHigh	CPU exclusivity mask of logical cores dedicated to the game represented by a bitmask. Core 0 is specified by the lowest bit in the low int and each core is the next highest bit. No bits can be set beyond the number of cores returned by GetSystemCpuSetInformation or set function will throw.
CpuExclusivityMaskLow	CPU exclusivity mask of logical cores dedicated to the game represented by a bitmask. Core 0 is specified by the lowest bit in the low int and each core is the next highest bit. No bits can be set beyond the number of cores returned by GetSystemCpuSetInformation or set function will throw.
IsEnabled	The associated GameListEntry is enabled for Game Mode
MaxCpuCount	The max number of CPUs the game will use, this cannot exceed the total logical cores across the systems device processor
PercentGpuMemoryAllocatedToGame	The percentage of GPU memory that will be dedicated to the game when Game Mode is enabled.
PercentGpuMemoryAllocatedToSystemCompositor	The percentage of GPU memory that will be dedicated to the system compositor when Game Mode is enabled.
PercentGpuTimeAllocatedToGame	The percentage of GPU time that will be dedicated to the game when Game Mode is enabled.
RelatedProcessNames	Returns a list of gaming related processes that will not be affected by Game Mode. Processes names can be added and removed, however SaveAsync() will need to be called to persist the changes.

Methods

SaveAsync()

Saves changes to the GameModeConfiguration properties

Applies to

Share via