SRMConnectorMode

Resolution and refresh rate configuration for a connector. More...

Detailed Description

Resolution and refresh rate configuration for a connector.

An SRMConnectorMode represents the resolution and refresh rate settings for a connector.
Each SRMConnector can have multiple modes, which can be listed using srmConnectorGetModes() and selected using srmConnectorSetMode();

Functions
void	srmConnectorModeSetUserData (SRMConnectorMode *connectorMode, void *userData)
	Set user data for the connector mode.
void *	srmConnectorModeGetUserData (SRMConnectorMode *connectorMode)
	Get user data for the connector mode.
SRMConnector *	srmConnectorModeGetConnector (SRMConnectorMode *connectorMode)
	Get the connector associated with the connector mode.
UInt32	srmConnectorModeGetWidth (SRMConnectorMode *connectorMode)
	Get the width of the connector mode.
UInt32	srmConnectorModeGetHeight (SRMConnectorMode *connectorMode)
	Get the height of the connector mode.
UInt32	srmConnectorModeGetRefreshRate (SRMConnectorMode *connectorMode)
	Get the refresh rate of the connector mode.
UInt8	srmConnectorModeIsPreferred (SRMConnectorMode *connectorMode)
	Check if the connector mode is the preferred mode by the connector.

Typedef Documentation

SRMConnectorMode

typedef struct SRMConnectorModeStruct SRMConnectorMode

Function Documentation

srmConnectorModeSetUserData()

void srmConnectorModeSetUserData	(	SRMConnectorMode *	connectorMode,
		void *	userData
	)

Set user data for the connector mode.

This function sets the user data for the given SRMConnectorMode.

Parameters

connectorMode	Pointer to the SRMConnectorMode for which to set user data.
userData	Pointer to the user data to associate with the connector mode.

srmConnectorModeGetUserData()

void * srmConnectorModeGetUserData

(

SRMConnectorMode *

connectorMode

)

Get user data for the connector mode.

This function retrieves the user data associated with the given SRMConnectorMode.

Parameters

connectorMode

Pointer to the SRMConnectorMode from which to retrieve user data.

Returns

Pointer to the user data associated with the connector mode.

srmConnectorModeGetConnector()

SRMConnector * srmConnectorModeGetConnector

(

SRMConnectorMode *

connectorMode

)

Get the connector associated with the connector mode.

This function returns the SRMConnector to which the given SRMConnectorMode belongs.

Parameters

connectorMode

Pointer to the SRMConnectorMode for which to retrieve the associated connector.

Returns

Pointer to the SRMConnector associated with the connector mode.

srmConnectorModeGetWidth()

UInt32 srmConnectorModeGetWidth

(

SRMConnectorMode *

connectorMode

)

Get the width of the connector mode.

This function returns the width in pixels of the resolution associated with the given SRMConnectorMode.

Parameters

connectorMode

Pointer to the SRMConnectorMode for which to retrieve the width.

Returns

The width of the connector mode.

srmConnectorModeGetHeight()

UInt32 srmConnectorModeGetHeight

(

SRMConnectorMode *

connectorMode

)

Get the height of the connector mode.

This function returns the height in pixels of the resolution associated with the given SRMConnectorMode.

Parameters

connectorMode

Pointer to the SRMConnectorMode for which to retrieve the height.

Returns

The height of the connector mode.

srmConnectorModeGetRefreshRate()

UInt32 srmConnectorModeGetRefreshRate

(

SRMConnectorMode *

connectorMode

)

Get the refresh rate of the connector mode.

This function returns the refresh rate in Hertz (Hz) associated with the given SRMConnectorMode.

Parameters

connectorMode

Pointer to the SRMConnectorMode for which to retrieve the refresh rate.

Returns

The refresh rate of the connector mode.

srmConnectorModeIsPreferred()

UInt8 srmConnectorModeIsPreferred

(

SRMConnectorMode *

connectorMode

)

Check if the connector mode is the preferred mode by the connector.

This function checks if the given SRMConnectorMode is the preferred mode for the associated SRMConnector.

Parameters

connectorMode

Pointer to the SRMConnectorMode to check if it is the preferred mode.

Returns

1 if the connector mode is preferred, 0 otherwise.