Mercurial > sdl-ios-xcode

comparison include/SDL_video.h @ 4883:511948f4919e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Fixed documentation
author Sam Lantinga <slouken@libsdl.org>
date Tue, 14 Sep 2010 21:57:29 -0700
parents 64a1db785f2c
children 0a77d2fc95ad
comparison
equal deleted inserted replaced
4882:e725a6a60c32 4883:511948f4919e
566 * \sa SDL_DestroyWindow() 566 * \sa SDL_DestroyWindow()
567 */ 567 */
568 extern DECLSPEC SDL_Window * SDLCALL SDL_CreateWindowFrom(const void *data); 568 extern DECLSPEC SDL_Window * SDLCALL SDL_CreateWindowFrom(const void *data);
569 569
570 /** 570 /**
571 * \brief Get the numeric ID of the window, for logging purposes. 571 * \brief Get the numeric ID of a window, for logging purposes.
572 */ 572 */
573 extern DECLSPEC Uint32 SDLCALL SDL_GetWindowID(SDL_Window * window); 573 extern DECLSPEC Uint32 SDLCALL SDL_GetWindowID(SDL_Window * window);
574 574
575 /** 575 /**
576 * \brief Get a window from a stored ID, or NULL if it doesn't exist. 576 * \brief Get a window from a stored ID, or NULL if it doesn't exist.
581 * \brief Get the window flags. 581 * \brief Get the window flags.
582 */ 582 */
583 extern DECLSPEC Uint32 SDLCALL SDL_GetWindowFlags(SDL_Window * window); 583 extern DECLSPEC Uint32 SDLCALL SDL_GetWindowFlags(SDL_Window * window);
584 584
585 /** 585 /**
586 * \brief Set the title of the window, in UTF-8 format. 586 * \brief Set the title of a window, in UTF-8 format.
587 * 587 *
588 * \sa SDL_GetWindowTitle() 588 * \sa SDL_GetWindowTitle()
589 */ 589 */
590 extern DECLSPEC void SDLCALL SDL_SetWindowTitle(SDL_Window * window, 590 extern DECLSPEC void SDLCALL SDL_SetWindowTitle(SDL_Window * window,
591 const char *title); 591 const char *title);
592 592
593 /** 593 /**
594 * \brief Get the title of the window, in UTF-8 format. 594 * \brief Get the title of a window, in UTF-8 format.
595 * 595 *
596 * \sa SDL_SetWindowTitle() 596 * \sa SDL_SetWindowTitle()
597 */ 597 */
598 extern DECLSPEC const char *SDLCALL SDL_GetWindowTitle(SDL_Window * window); 598 extern DECLSPEC const char *SDLCALL SDL_GetWindowTitle(SDL_Window * window);
599 599
600 /** 600 /**
601 * \brief Set the icon of the window. 601 * \brief Set the icon of a window.
602 * 602 *
603 * \param icon The icon for the window. 603 * \param icon The icon for a window.
604 */ 604 */
605 extern DECLSPEC void SDLCALL SDL_SetWindowIcon(SDL_Window * window, 605 extern DECLSPEC void SDLCALL SDL_SetWindowIcon(SDL_Window * window,
606 SDL_Surface * icon); 606 SDL_Surface * icon);
607 607
608 /** 608 /**
612 */ 612 */
613 extern DECLSPEC void SDLCALL SDL_SetWindowData(SDL_Window * window, 613 extern DECLSPEC void SDLCALL SDL_SetWindowData(SDL_Window * window,
614 void *userdata); 614 void *userdata);
615 615
616 /** 616 /**
617 * \brief Retrieve the data pointer associated with the window. 617 * \brief Retrieve the data pointer associated with a window.
618 * 618 *
619 * \sa SDL_SetWindowData() 619 * \sa SDL_SetWindowData()
620 */ 620 */
621 extern DECLSPEC void *SDLCALL SDL_GetWindowData(SDL_Window * window); 621 extern DECLSPEC void *SDLCALL SDL_GetWindowData(SDL_Window * window);
622 622
623 /** 623 /**
624 * \brief Set the position of the window. 624 * \brief Set the position of a window.
625 * 625 *
626 * \param window The window to reposition. 626 * \param window The window to reposition.
627 * \param x The x coordinate of the window, ::SDL_WINDOWPOS_CENTERED, or 627 * \param x The x coordinate of the window, ::SDL_WINDOWPOS_CENTERED, or
628 ::SDL_WINDOWPOS_UNDEFINED. 628 ::SDL_WINDOWPOS_UNDEFINED.
629 * \param y The y coordinate of the window, ::SDL_WINDOWPOS_CENTERED, or 629 * \param y The y coordinate of the window, ::SDL_WINDOWPOS_CENTERED, or
635 */ 635 */
636 extern DECLSPEC void SDLCALL SDL_SetWindowPosition(SDL_Window * window, 636 extern DECLSPEC void SDLCALL SDL_SetWindowPosition(SDL_Window * window,
637 int x, int y); 637 int x, int y);
638 638
639 /** 639 /**
640 * \brief Get the position of the window. 640 * \brief Get the position of a window.
641 * 641 *
642 * \sa SDL_SetWindowPosition() 642 * \sa SDL_SetWindowPosition()
643 */ 643 */
644 extern DECLSPEC void SDLCALL SDL_GetWindowPosition(SDL_Window * window, 644 extern DECLSPEC void SDLCALL SDL_GetWindowPosition(SDL_Window * window,
645 int *x, int *y); 645 int *x, int *y);
646 646
647 /** 647 /**
648 * \brief Set the size of the window's client area. 648 * \brief Set the size of a window's client area.
649 * 649 *
650 * \note You can't change the size of a fullscreen window, it automatically 650 * \note You can't change the size of a fullscreen window, it automatically
651 * matches the size of the display mode. 651 * matches the size of the display mode.
652 * 652 *
653 * \sa SDL_GetWindowSize() 653 * \sa SDL_GetWindowSize()
654 */ 654 */
655 extern DECLSPEC void SDLCALL SDL_SetWindowSize(SDL_Window * window, int w, 655 extern DECLSPEC void SDLCALL SDL_SetWindowSize(SDL_Window * window, int w,
656 int h); 656 int h);
657 657
658 /** 658 /**
659 * \brief Get the size of the window's client area. 659 * \brief Get the size of a window's client area.
660 * 660 *
661 * \sa SDL_SetWindowSize() 661 * \sa SDL_SetWindowSize()
662 */ 662 */
663 extern DECLSPEC void SDLCALL SDL_GetWindowSize(SDL_Window * window, int *w, 663 extern DECLSPEC void SDLCALL SDL_GetWindowSize(SDL_Window * window, int *w,
664 int *h); 664 int *h);
665 665
666 /** 666 /**
667 * \brief Show the window. 667 * \brief Show a window.
668 * 668 *
669 * \sa SDL_HideWindow() 669 * \sa SDL_HideWindow()
670 */ 670 */
671 extern DECLSPEC void SDLCALL SDL_ShowWindow(SDL_Window * window); 671 extern DECLSPEC void SDLCALL SDL_ShowWindow(SDL_Window * window);
672 672
673 /** 673 /**
674 * \brief Hide the window. 674 * \brief Hide a window.
675 * 675 *
676 * \sa SDL_ShowWindow() 676 * \sa SDL_ShowWindow()
677 */ 677 */
678 extern DECLSPEC void SDLCALL SDL_HideWindow(SDL_Window * window); 678 extern DECLSPEC void SDLCALL SDL_HideWindow(SDL_Window * window);
679 679
680 /** 680 /**
681 * \brief Raise the window above other windows and set the input focus. 681 * \brief Raise a window above other windows and set the input focus.
682 */ 682 */
683 extern DECLSPEC void SDLCALL SDL_RaiseWindow(SDL_Window * window); 683 extern DECLSPEC void SDLCALL SDL_RaiseWindow(SDL_Window * window);
684 684
685 /** 685 /**
686 * \brief Make the window as large as possible. 686 * \brief Make a window as large as possible.
687 * 687 *
688 * \sa SDL_RestoreWindow() 688 * \sa SDL_RestoreWindow()
689 */ 689 */
690 extern DECLSPEC void SDLCALL SDL_MaximizeWindow(SDL_Window * window); 690 extern DECLSPEC void SDLCALL SDL_MaximizeWindow(SDL_Window * window);
691 691
692 /** 692 /**
693 * \brief Minimize the window to an iconic representation. 693 * \brief Minimize a window to an iconic representation.
694 * 694 *
695 * \sa SDL_RestoreWindow() 695 * \sa SDL_RestoreWindow()
696 */ 696 */
697 extern DECLSPEC void SDLCALL SDL_MinimizeWindow(SDL_Window * window); 697 extern DECLSPEC void SDLCALL SDL_MinimizeWindow(SDL_Window * window);
698 698
703 * \sa SDL_MinimizeWindow() 703 * \sa SDL_MinimizeWindow()
704 */ 704 */
705 extern DECLSPEC void SDLCALL SDL_RestoreWindow(SDL_Window * window); 705 extern DECLSPEC void SDLCALL SDL_RestoreWindow(SDL_Window * window);
706 706
707 /** 707 /**
708 * \brief Set the window's fullscreen state. 708 * \brief Set a window's fullscreen state.
709 * 709 *
710 * \return 0 on success, or -1 if setting the display mode failed. 710 * \return 0 on success, or -1 if setting the display mode failed.
711 * 711 *
712 * \sa SDL_SetWindowDisplayMode() 712 * \sa SDL_SetWindowDisplayMode()
713 * \sa SDL_GetWindowDisplayMode() 713 * \sa SDL_GetWindowDisplayMode()
714 */ 714 */
715 extern DECLSPEC int SDLCALL SDL_SetWindowFullscreen(SDL_Window * window, 715 extern DECLSPEC int SDLCALL SDL_SetWindowFullscreen(SDL_Window * window,
716 int fullscreen); 716 int fullscreen);
717 717
718 /** 718 /**
719 * \brief Set the window's input grab mode. 719 * \brief Set a window's input grab mode.
720 * 720 *
721 * \param mode This is 1 to grab input, and 0 to release input. 721 * \param mode This is 1 to grab input, and 0 to release input.
722 * 722 *
723 * \sa SDL_GetWindowGrab() 723 * \sa SDL_GetWindowGrab()
724 */ 724 */
725 extern DECLSPEC void SDLCALL SDL_SetWindowGrab(SDL_Window * window, 725 extern DECLSPEC void SDLCALL SDL_SetWindowGrab(SDL_Window * window,
726 int mode); 726 int mode);
727 727
728 /** 728 /**
729 * \brief Get the window's input grab mode. 729 * \brief Get a window's input grab mode.
730 * 730 *
731 * \return This returns 1 if input is grabbed, and 0 otherwise. 731 * \return This returns 1 if input is grabbed, and 0 otherwise.
732 * 732 *
733 * \sa SDL_SetWindowGrab() 733 * \sa SDL_SetWindowGrab()
734 */ 734 */
1428 * \sa SDL_GL_SetSwapInterval() 1428 * \sa SDL_GL_SetSwapInterval()
1429 */ 1429 */
1430 extern DECLSPEC int SDLCALL SDL_GL_GetSwapInterval(void); 1430 extern DECLSPEC int SDLCALL SDL_GL_GetSwapInterval(void);
1431 1431
1432 /** 1432 /**
1433 * \brief Swap the OpenGL buffers for the window, if double-buffering is 1433 * \brief Swap the OpenGL buffers for a window, if double-buffering is
1434 * supported. 1434 * supported.
1435 */ 1435 */
1436 extern DECLSPEC void SDLCALL SDL_GL_SwapWindow(SDL_Window * window); 1436 extern DECLSPEC void SDLCALL SDL_GL_SwapWindow(SDL_Window * window);
1437 1437
1438 /** 1438 /**