|
Size: 1159
Comment: update content - 2/28 5421 (2/10 5244)
|
Size: 1159
Comment: update content - w/ Sam
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 5: | Line 5: |
| Use this function to fill in information about a specific display mode. | Use this function to get information about a specific display mode. |
| Line 18: | Line 18: |
| ||'''modeIndex'''||^the index of the requested display mode^|| ||'''mode'''||an [[SDL_DisplayMode]] structure filled in with the mode '''index'''|| |
||'''modeIndex'''||the index of the display mode to query|| ||'''mode'''||an [[SDL_DisplayMode]] structure filled in with the mode at '''modeIndex'''|| |
SDL_GetDisplayMode
Use this function to get information about a specific display mode.
Contents
Syntax
int SDL_GetDisplayMode(int displayIndex,
int modeIndex,
SDL_DisplayMode* mode)
Function Parameters
displayIndex |
the index of the display to query |
modeIndex |
the index of the display mode to query |
mode |
an SDL_DisplayMode structure filled in with the mode at modeIndex |
Return Value
Returns 0 on success or a negative error code on failure; call SDL_GetError() for more information.
Code Examples
You can add your code example here
Remarks
The display modes are sorted in this priority:
bits per pixel -> more colors to fewer colors
width -> largest to smallest
height -> largest to smallest
refresh rate -> highest to lowest
