Wiki Page Content

Revision 19 as of 2013-07-06 10:33:13

Clear message

SDL_GetCurrentDisplayMode

Use this function to get information about the current display mode.

Syntax

int SDL_GetCurrentDisplayMode(int              displayIndex,
                              SDL_DisplayMode* mode)

Function Parameters

displayIndex

the index of the display to query

mode

an SDL_DisplayMode structure filled in with the current display mode

Return Value

Returns 0 on success or a negative error code on failure; call SDL_GetError() for more information.

Code Examples

// Using SDL2's SDL_GetCurrentDisplayMode()

#include "SDL.h"
#include <stdio.h>

int main(int argc, char* argv[]){

  int i;

  // Declare display mode structure to be filled in.
  SDL_DisplayMode current;

  SDL_Init(SDL_INIT_VIDEO); 

  // Get current display mode of all displays.
  for(i = 0; i < SDL_GetNumVideoDisplays(); ++i){
  
    int should_be_zero = SDL_GetCurrentDisplayMode(i, &current);

    if(should_be_zero != 0)
      // In case of error...
      printf("Could not get display mode for video display #%d: %s", i, SDL_GetError());
    
    else 
      // On success, print the current display mode.
      printf("Display #%d: current display mode is %dx%dpx @ %dhz. \n", i, current.w, current.h, current.refresh_rate);

  }
 
  // Clean up and exit the program.
  SDL_Quit();     
  return 0;   
 
}

Remarks

You can add useful comments here


CategoryAPI, CategoryVideo

(Page Info.)
Feedback
Please include your contact information if you'd like to receive a reply.
Submit