stingray.DisplayAdapter namespace reference

Description

You can use the functions in the DisplayAdapter interface to access the GPUs and outputs (screens) that are connected to the system.

Note: The DisplayAdapter interface is only available on Windows and Mac OS X.

Note also that this interface deprecates stingray.Application.enum_display_modes().

Other related reference items

	stingray.Application.enum_display_modes()
	Utilities

Functions

mode ( adapter_index, output_index, mode_index ) : integer, integer Returns the resolution (i.e. the width and height in pixels) of a particular mode for one output of a display adapter.

Parameters

adapter_index :	integer	Specifies the index of the display adapter whose values you want to retrieve.
output_index :	integer	Specifies the index of the output within the display adapter.
mode_index :	integer	Specifies the index of the mode within the output.

Returns

integer	The width in pixels of the specified mode.
integer	The height in pixels of the specified mode.

name ( adapter_index ) : string Returns a readable name for the adapter.

Parameters

adapter_index :

integer

Specifies the index of the display adapter whose name you want to retrieve.

Returns

string

The readable name for the adapter.

num_adapters ( ) : integer Returns the number of available display adapters (GPUs) in the system.

Parameters

This function does not accept any parameters.

Returns

integer

The number of available display adapters (GPUs) in the system.

num_modes ( adapter_index, output_index ) : integer Returns the number of display modes that are supported by a specific output of a display adapter.

Parameters

adapter_index :	integer	Specifies the index of the display adapter whose modes you want to access.
output_index :	integer	Specifies the index of the output within the display adapter.

Returns

integer

The number of supported display modes for the specific output.

num_outputs ( adapter_index ) : integer Returns the number of available outputs (screens) for the adapter.

Parameters

adapter_index :

integer

Specifies the index of the display adapter whose outputs you want to access.

Returns

integer

The number of available outputs (screens) for the adapter.