Edit

Msvm_Synthetic3DDisplayControllerSettingData class

  • Article

Represents settings for a synthetic 3-D display controller for a virtual machine. This class is only used with virtual machines that use RemoteFX.

The following syntax is simplified Managed Object Format (MOF) code, and it includes all of the inherited properties.

Syntax

[Dynamic, Provider("VmmsWmiInstanceAndMethodProvider"), AMENDMENT]
class Msvm_Synthetic3DDisplayControllerSettingData : CIM_ResourceAllocationSettingData
{
  string  InstanceID;
  string  Caption = "3D Display Controller Default Settings";
  string  Description = "Describes the default settings for the 3D video controller resource pool.";
  string  ElementName;
  uint16  ResourceType = 24;
  string  OtherResourceType;
  string  ResourceSubType = "Microsoft:Hyper-V:Synthetic 3D Display Controller";
  string  PoolID;
  uint16  ConsumerVisibility = 3;
  string  HostResource[];
  string  AllocationUnits = "count";
  uint64  VirtualQuantity = 1;
  uint64  Reservation = 1;
  uint64  Limit = 1;
  uint32  Weight = 0;
  boolean AutomaticAllocation = True;
  boolean AutomaticDeallocation = True;
  string  Parent;
  string  Connection[];
  string  Address;
  uint16  MappingBehavior;
  string  AddressOnParent;
  string  VirtualQuantityUnits = "count";
  uint8   MaximumScreenResolution;
  uint8   MaximumMonitors;
  uint64  VRAMSizeBytes;
};

Members

The Msvm_Synthetic3DDisplayControllerSettingData class has these types of members:

Properties

The Msvm_Synthetic3DDisplayControllerSettingData class has these properties.

Address

Data type: string

Access type: Read-only

The address of the resource. This property is inherited from CIM_ResourceAllocationSettingData.

This is a read-only property, but if the ResourceType property is 20 (Graphics controller), it can be changed by using the ModifyResourceSettings method of the Msvm_VirtualSystemManagementService class.

AddressOnParent

Data type: string

Access type: Read-only

Describes the address of this resource in the context of the parent. The Parent and AddressOnParent properties are used to describe the controller relationship as well as the ordering of devices on a controller. This property is inherited from CIM_ResourceAllocationSettingData.

AllocationUnits

Data type: string

Access type: Read-only

The units of allocation used by the Reservation and Limit properties. This property is inherited from CIM_ResourceAllocationSettingData.

AutomaticAllocation

Data type: boolean

Access type: Read-only

Indicates whether the resource will be automatically allocated. This property is inherited from CIM_ResourceAllocationSettingData.

AutomaticDeallocation

Data type: boolean

Access type: Read-only

Indicates whether the resource will be automatically deallocated. This property is inherited from CIM_ResourceAllocationSettingData.

Caption

Data type: string

Access type: Read-only

Qualifiers: MaxLen (64)

A short description of the object. This property is inherited from CIM_ManagedElement.

Connection

Data type: string array

Access type: Read-only

The device to which this resource is connected. This property is inherited from CIM_ResourceAllocationSettingData.

This is a read-only property, but if either 1) the ResourceType property is 17 (Serial port), or 2) the ResourceType property is 21 (Storage Extent) and the ResourceSubType property is "Microsoft Virtual Hard Disk", then it can be changed by using the ModifyResourceSettings method of the Msvm_VirtualSystemManagementService class.

ConsumerVisibility

Data type: uint16

Access type: Read-only

The consumer's visibility to the allocated resource. This property is inherited from CIM_ResourceAllocationSettingData.

Description

Data type: string

Access type: Read-only

A description of the object. This property is inherited from CIM_ManagedElement.

ElementName

Data type: string

Access type: Read-only

A display name for the object. This property is inherited from CIM_SettingData. Changing this property will change the element name of the associated logical device derivative.

HostResource

Data type: string array

Access type: Read-only

Only one host resource can be assigned to each device in the virtual machine, so only the first element of this array can be set. For devices that support this feature, set the first element of the HostResource array to contain a reference to the underlying host resource that is to be assigned. This property is inherited from CIM_ResourceAllocationSettingData.

InstanceID

Data type: string

Access type: Read-only

Uniquely identifies an instance of this class. This property is inherited from CIM_ManagedElement.

Limit

Data type: uint64

Access type: Read-only

The maximum amount of corresponding host resources that can be consumed by the virtual machine. This property is inherited from CIM_ResourceAllocationSettingData.

MappingBehavior

Data type: uint16

Access type: Read-only

Specifies how this resource maps to underlying resources. This property is inherited from CIM_ResourceAllocationSettingData.

MaximumMonitors

Data type: uint8

Access type: Read/write

The maximum number of monitors available to the 3-D display controller. The minimum number of monitors is 1 and the maximum is dependent upon the maximum screen resolution. The following table defines the maximum number of monitors allowed for different resolutions.

Resolution Maximum monitors
1024 768
 4
1280 1024
 4
1600 1200
 3
1920 1200
 2

MaximumScreenResolution

Data type: uint8

Access type: Read-only

Specifies the maximum screen resolution for the 3-D display controller. This must be one of the following values.

1024 * 768 (0)

The maximum resolution is 1024 768.

1280 * 1024 (1)

The maximum resolution is 1280 1024.

1600 * 1200 (2)

The maximum resolution is 1600 1200.

1920 * 1200 (3)

The maximum resolution is 1920 1200.

2560 * 1600 (4)

The maximum resolution is 2650 1600.

3840 * 2160 (5)

The maximum resolution is 3840 2160.

Note

Added in Windows 10 and Windows Server 2016.msvm_synte

OtherResourceType

Data type: string

Access type: Read-only

A string that describes the resource type when a well-defined value is not available and ResourceType has the value 1(Other). This property is inherited from CIM_ResourceAllocationSettingData.

Parent

Data type: string

Access type: Read-only

The parent of the resource. This property is inherited from CIM_ResourceAllocationSettingData.

PoolID

Data type: string

Access type: Read-only

The identifier of the resource pool from which this resource was allocated. This property is inherited from CIM_ResourceAllocationSettingData.

Reservation

Data type: uint64

Access type: Read-only

The amount of CPU resources that are reserved for use by the virtual machine. These resources are guaranteed to be available for consumption by the virtual machine. This property is inherited from CIM_ResourceAllocationSettingData.

ResourceSubType

Data type: string

Access type: Read-only

A string that describes an implementation specific subtype for this resource. For example, this may be used to distinguish different models of the same resource type. This property is inherited from CIM_ResourceAllocationSettingData.

ResourceType

Data type: uint16

Access type: Read-only

The type of resource this allocation setting represents. This property is inherited from CIM_ResourceAllocationSettingData.

VirtualQuantity

Data type: uint64

Access type: Read-only

The total number of cores in the virtual machine. This property is inherited from CIM_ResourceAllocationSettingData.

VirtualQuantityUnits

Data type: string

Access type: Read-only

Specifies the unit of measurement for the VirtualQuantity property. The value of this property must be a legal value of the Programmatic Units qualifier as defined in Annex C.1 of DSP0004 V2.5 or later. This property is inherited from CIM_ResourceAllocationSettingData.

VRAMSizeBytes

Data type: uint64

Access type: Read/write

The video memory size for the Virtual Machine.

Note

Added in Windows 10 and Windows Server 2016.

(67108864)

(134217728)

(268435456)

(536870912)

(1073741824)

Weight

Data type: uint32

Access type: Read-only

An integer that defines the weight for each virtual machine processor. After all reserves have been met, the remaining physical processor capacity of the hosting platform will be allocated to virtual machines based on their relative weights. This property is inherited from CIM_ResourceAllocationSettingData.

0

Range: 0 1000

Requirements

Requirement Value
Minimum supported client
 Windows 8 [desktop apps only]
Minimum supported server
 Windows Server 2012 [desktop apps only]
Namespace
 Root\Virtualization\V2
MOF
WindowsVirtualization.V2.mof
DLL
Vmms.exe