DeviceCreationParameters.AdapterOrdinal Property (Microsoft.DirectX.Direct3D)

  • Article

Retrieves an ordinal number that denotes the display adapter.

Definition

Visual Basic Public ReadOnly Property AdapterOrdinal As Integer
C# public int AdapterOrdinal { get; }
C++ public:
property int AdapterOrdinal {
        int get();
}
JScript public function get AdapterOrdinal() : int

Property Value

System.Int32
An Int32Leave Site value that indicates an ordinal number that denotes the display adapter.

This property is read-only. 

Remarks

Use this ordinal as the adapter parameter for any of the Manager methods.

Note that different instances of Microsoft Direct3D objects can use different ordinals. For example, adapters can enter or leave a system when users add or remove monitors from a multiple-monitor system, or when they hot-swap a laptop. Consequently, this ordinal should be used only in a Direct3D instance known to be valid, such as the Direct3D object that created this Device.