SRM
v0.10.0-1
Simple Rendering Manager
|
Resolution and refresh rate configuration for a connector. More...
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. More... | |
void * | srmConnectorModeGetUserData (SRMConnectorMode *connectorMode) |
Get user data for the connector mode. More... | |
SRMConnector * | srmConnectorModeGetConnector (SRMConnectorMode *connectorMode) |
Get the connector associated with the connector mode. More... | |
UInt32 | srmConnectorModeGetWidth (SRMConnectorMode *connectorMode) |
Get the width of the connector mode. More... | |
UInt32 | srmConnectorModeGetHeight (SRMConnectorMode *connectorMode) |
Get the height of the connector mode. More... | |
UInt32 | srmConnectorModeGetRefreshRate (SRMConnectorMode *connectorMode) |
Get the refresh rate of the connector mode. More... | |
UInt8 | srmConnectorModeIsPreferred (SRMConnectorMode *connectorMode) |
Check if the connector mode is the preferred mode by the connector. More... | |
typedef struct SRMConnectorModeStruct SRMConnectorMode |
void srmConnectorModeSetUserData | ( | SRMConnectorMode * | connectorMode, |
void * | userData | ||
) |
Set user data for the connector mode.
This function sets the user data for the given SRMConnectorMode.
connectorMode | Pointer to the SRMConnectorMode for which to set user data. |
userData | Pointer to the user data to associate with the connector mode. |
void* srmConnectorModeGetUserData | ( | SRMConnectorMode * | connectorMode | ) |
Get user data for the connector mode.
This function retrieves the user data associated with the given SRMConnectorMode.
connectorMode | Pointer to the SRMConnectorMode from which to retrieve user data. |
SRMConnector* srmConnectorModeGetConnector | ( | SRMConnectorMode * | connectorMode | ) |
Get the connector associated with the connector mode.
This function returns the SRMConnector to which the given SRMConnectorMode belongs.
connectorMode | Pointer to the SRMConnectorMode for which to retrieve the associated connector. |
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.
connectorMode | Pointer to the SRMConnectorMode for which to retrieve the width. |
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.
connectorMode | Pointer to the SRMConnectorMode for which to retrieve the height. |
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.
connectorMode | Pointer to the SRMConnectorMode for which to retrieve the refresh rate. |
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.
connectorMode | Pointer to the SRMConnectorMode to check if it is the preferred mode. |