Mercurial > sdl-ios-xcode

comparison include/SDL_video.h @ 1968:9f589a1f74a5

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Updated header documentation
author Sam Lantinga <slouken@libsdl.org>
date Sat, 05 Aug 2006 22:41:33 +0000
parents 01e29c3e9a29
children 5d3724f64f2b
comparison
equal deleted inserted replaced
1967:01e29c3e9a29 1968:9f589a1f74a5
432 extern DECLSPEC int SDLCALL SDL_GetNumDisplayModes(void); 432 extern DECLSPEC int SDLCALL SDL_GetNumDisplayModes(void);
433 433
434 /** 434 /**
435 * \fn int SDL_GetDisplayMode(int index, SDL_DisplayMode *mode) 435 * \fn int SDL_GetDisplayMode(int index, SDL_DisplayMode *mode)
436 * 436 *
437 * \brief Retrieve information about a specific display mode. 437 * \brief Fill in information about a specific display mode.
438 * 438 *
439 * \note The display modes are sorted in this priority: 439 * \note The display modes are sorted in this priority:
440 * \li bits per pixel -> more colors to fewer colors 440 * \li bits per pixel -> more colors to fewer colors
441 * \li width -> largest to smallest 441 * \li width -> largest to smallest
442 * \li height -> largest to smallest 442 * \li height -> largest to smallest
448 SDL_DisplayMode * mode); 448 SDL_DisplayMode * mode);
449 449
450 /** 450 /**
451 * \fn int SDL_GetDesktopDisplayMode(SDL_DisplayMode *mode) 451 * \fn int SDL_GetDesktopDisplayMode(SDL_DisplayMode *mode)
452 * 452 *
453 * \brief Retrieve information about the desktop display mode for the current display. 453 * \brief Fill in information about the desktop display mode for the current display.
454 */ 454 */
455 extern DECLSPEC int SDLCALL SDL_GetDesktopDisplayMode(SDL_DisplayMode * mode); 455 extern DECLSPEC int SDLCALL SDL_GetDesktopDisplayMode(SDL_DisplayMode * mode);
456 456
457 /** 457 /**
458 * \fn int SDL_GetCurrentDisplayMode(SDL_DisplayMode *mode) 458 * \fn int SDL_GetCurrentDisplayMode(SDL_DisplayMode *mode)
459 * 459 *
460 * \brief Retrieve information about the current display mode. 460 * \brief Fill in information about the current display mode.
461 */ 461 */
462 extern DECLSPEC int SDLCALL SDL_GetCurrentDisplayMode(SDL_DisplayMode * mode); 462 extern DECLSPEC int SDLCALL SDL_GetCurrentDisplayMode(SDL_DisplayMode * mode);
463 463
464 /** 464 /**
465 * \fn SDL_DisplayMode *SDL_GetClosestDisplayMode(const SDL_DisplayMode *mode, SDL_DisplayMode *closest) 465 * \fn SDL_DisplayMode *SDL_GetClosestDisplayMode(const SDL_DisplayMode *mode, SDL_DisplayMode *closest)
498 * mode); 498 * mode);
499 499
500 /** 500 /**
501 * \fn int SDL_GetFullscreenDisplayMode(SDL_DisplayMode *mode) 501 * \fn int SDL_GetFullscreenDisplayMode(SDL_DisplayMode *mode)
502 * 502 *
503 * \brief Query the display mode used when a fullscreen window is visible 503 * \brief Fill in information about the display mode used when a fullscreen
504 * on the currently selected display. 504 * window is visible on the currently selected display.
505 */ 505 */
506 extern DECLSPEC int SDLCALL SDL_GetFullscreenDisplayMode(SDL_DisplayMode * 506 extern DECLSPEC int SDLCALL SDL_GetFullscreenDisplayMode(SDL_DisplayMode *
507 mode); 507 mode);
508 508
509 /** 509 /**