comparison include/SDL_video.h @ 4971:158bb5752974

Updated headers to match wiki documentation
author Sam Lantinga <slouken@libsdl.org>
date Wed, 12 Jan 2011 09:47:33 -0800
parents aa8888658021
children dc0dfdd58f27
comparison
equal deleted inserted replaced
4970:b9eed029844a 4971:158bb5752974
883 883
884 /** 884 /**
885 * \brief Set an additional color value used in render copy operations. 885 * \brief Set an additional color value used in render copy operations.
886 * 886 *
887 * \param texture The texture to update. 887 * \param texture The texture to update.
888 * \param r The red source color value multiplied into copy operations. 888 * \param r The red color value multiplied into copy operations.
889 * \param g The green source color value multiplied into copy operations. 889 * \param g The green color value multiplied into copy operations.
890 * \param b The blue source color value multiplied into copy operations. 890 * \param b The blue color value multiplied into copy operations.
891 * 891 *
892 * \return 0 on success, or -1 if the texture is not valid or color modulation 892 * \return 0 on success, or -1 if the texture is not valid or color modulation
893 * is not supported. 893 * is not supported.
894 * 894 *
895 * \sa SDL_GetTextureColorMod() 895 * \sa SDL_GetTextureColorMod()
900 900
901 /** 901 /**
902 * \brief Get the additional color value used in render copy operations. 902 * \brief Get the additional color value used in render copy operations.
903 * 903 *
904 * \param texture The texture to query. 904 * \param texture The texture to query.
905 * \param r A pointer filled in with the source red color value. 905 * \param r A pointer filled in with the current red color value.
906 * \param g A pointer filled in with the source green color value. 906 * \param g A pointer filled in with the current green color value.
907 * \param b A pointer filled in with the source blue color value. 907 * \param b A pointer filled in with the current blue color value.
908 * 908 *
909 * \return 0 on success, or -1 if the texture is not valid. 909 * \return 0 on success, or -1 if the texture is not valid.
910 * 910 *
911 * \sa SDL_SetTextureColorMod() 911 * \sa SDL_SetTextureColorMod()
912 */ 912 */
916 916
917 /** 917 /**
918 * \brief Set an additional alpha value used in render copy operations. 918 * \brief Set an additional alpha value used in render copy operations.
919 * 919 *
920 * \param texture The texture to update. 920 * \param texture The texture to update.
921 * \param alpha The source alpha value multiplied into copy operations. 921 * \param alpha The alpha value multiplied into copy operations.
922 * 922 *
923 * \return 0 on success, or -1 if the texture is not valid or alpha modulation 923 * \return 0 on success, or -1 if the texture is not valid or alpha modulation
924 * is not supported. 924 * is not supported.
925 * 925 *
926 * \sa SDL_GetTextureAlphaMod() 926 * \sa SDL_GetTextureAlphaMod()
930 930
931 /** 931 /**
932 * \brief Get the additional alpha value used in render copy operations. 932 * \brief Get the additional alpha value used in render copy operations.
933 * 933 *
934 * \param texture The texture to query. 934 * \param texture The texture to query.
935 * \param alpha A pointer filled in with the source alpha value. 935 * \param alpha A pointer filled in with the current alpha value.
936 * 936 *
937 * \return 0 on success, or -1 if the texture is not valid. 937 * \return 0 on success, or -1 if the texture is not valid.
938 * 938 *
939 * \sa SDL_SetTextureAlphaMod() 939 * \sa SDL_SetTextureAlphaMod()
940 */ 940 */