Mercurial > sdl-ios-xcode

comparison include/SDL_video.h @ 1967:01e29c3e9a29

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
In general, fill in pointers to structures, rather than return them.
author Sam Lantinga <slouken@libsdl.org>
date Sat, 05 Aug 2006 22:34:23 +0000
parents 6472256c21eb
children 9f589a1f74a5
comparison
equal deleted inserted replaced
1966:6472256c21eb 1967:01e29c3e9a29
430 * \sa SDL_GetDisplayMode() 430 * \sa SDL_GetDisplayMode()
431 */ 431 */
432 extern DECLSPEC int SDLCALL SDL_GetNumDisplayModes(void); 432 extern DECLSPEC int SDLCALL SDL_GetNumDisplayModes(void);
433 433
434 /** 434 /**
435 * \fn const SDL_DisplayMode *SDL_GetDisplayMode(int index) 435 * \fn int SDL_GetDisplayMode(int index, SDL_DisplayMode *mode)
436 * 436 *
437 * \brief Retrieve information about a specific display mode. 437 * \brief Retrieve 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
442 * \li height -> largest to smallest 442 * \li height -> largest to smallest
443 * \li refresh rate -> highest to lowest 443 * \li refresh rate -> highest to lowest
444 * 444 *
445 * \sa SDL_GetNumDisplayModes() 445 * \sa SDL_GetNumDisplayModes()
446 */ 446 */
447 extern DECLSPEC const SDL_DisplayMode *SDLCALL SDL_GetDisplayMode(int index); 447 extern DECLSPEC int SDLCALL SDL_GetDisplayMode(int index,
448 448 SDL_DisplayMode * mode);
449 /** 449
450 * \fn const SDL_DisplayMode *SDL_GetDesktopDisplayMode(void) 450 /**
451 * \fn int SDL_GetDesktopDisplayMode(SDL_DisplayMode *mode)
451 * 452 *
452 * \brief Retrieve information about the desktop display mode for the current display. 453 * \brief Retrieve information about the desktop display mode for the current display.
453 */ 454 */
454 extern DECLSPEC const SDL_DisplayMode *SDLCALL 455 extern DECLSPEC int SDLCALL SDL_GetDesktopDisplayMode(SDL_DisplayMode * mode);
455 SDL_GetDesktopDisplayMode(void); 456
456 457 /**
457 /** 458 * \fn int SDL_GetCurrentDisplayMode(SDL_DisplayMode *mode)
458 * \fn const SDL_DisplayMode *SDL_GetCurrentDisplayMode(void)
459 * 459 *
460 * \brief Retrieve information about the current display mode. 460 * \brief Retrieve information about the current display mode.
461 */ 461 */
462 extern DECLSPEC const SDL_DisplayMode *SDLCALL 462 extern DECLSPEC int SDLCALL SDL_GetCurrentDisplayMode(SDL_DisplayMode * mode);
463 SDL_GetCurrentDisplayMode(void);
464 463
465 /** 464 /**
466 * \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)
467 * 466 *
468 * \brief Get the closest match to the requested display mode. 467 * \brief Get the closest match to the requested display mode.
497 */ 496 */
498 extern DECLSPEC int SDLCALL SDL_SetFullscreenDisplayMode(const SDL_DisplayMode 497 extern DECLSPEC int SDLCALL SDL_SetFullscreenDisplayMode(const SDL_DisplayMode
499 * mode); 498 * mode);
500 499
501 /** 500 /**
502 * \fn const SDL_DisplayMode *SDL_GetFullscreenDisplayMode(void) 501 * \fn int SDL_GetFullscreenDisplayMode(SDL_DisplayMode *mode)
503 * 502 *
504 * \brief Query the display mode used when a fullscreen window is visible 503 * \brief Query the display mode used when a fullscreen window is visible
505 * on the currently selected display. 504 * on the currently selected display.
506 */ 505 */
507 extern DECLSPEC const SDL_DisplayMode *SDLCALL 506 extern DECLSPEC int SDLCALL SDL_GetFullscreenDisplayMode(SDL_DisplayMode *
508 SDL_GetFullscreenDisplayMode(void); 507 mode);
509 508
510 /** 509 /**
511 * \fn int SDL_SetDisplayPalette(const SDL_Color *colors, int firstcolor, int ncolors) 510 * \fn int SDL_SetDisplayPalette(const SDL_Color *colors, int firstcolor, int ncolors)
512 * 511 *
513 * \brief Set the palette entries for indexed display modes. 512 * \brief Set the palette entries for indexed display modes.