Mercurial > sdl-ios-xcode
view docs/html/sdlcolor.html @ 3341:710139a1692d
Fixed bug #826
Ken Bull 2009-10-04 09:51:30 PDT
2009/10/4 E. Wing <ewmailing@gmail.com>:
> Hi Kenneth,
> I noticed that SDL_SetColorKey and SDL_GetColorKey start with
> /*
> instead of
> /**
> in SDL_Surface.h in SDL 1.3.
>
> I haven't scrutinized the headers and I don't know if you had an
> automated process to add these, but I thought I would let you know in
> case there might be others that have the same problem.
>
> Thanks,
> Eric
>
The attached patch corrects this and other documentation errors in
SDL_surface.h
author | Sam Lantinga <slouken@libsdl.org> |
---|---|
date | Sun, 04 Oct 2009 19:14:30 +0000 |
parents | 355632dca928 |
children |
line wrap: on
line source
<HTML ><HEAD ><TITLE >SDL_Color</TITLE ><META NAME="GENERATOR" CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ "><LINK REL="HOME" TITLE="SDL Library Documentation" HREF="index.html"><LINK REL="UP" TITLE="Video" HREF="video.html"><LINK REL="PREVIOUS" TITLE="SDL_Rect" HREF="sdlrect.html"><LINK REL="NEXT" TITLE="SDL_Palette" HREF="sdlpalette.html"></HEAD ><BODY CLASS="REFENTRY" BGCOLOR="#FFF8DC" TEXT="#000000" LINK="#0000ee" VLINK="#551a8b" ALINK="#ff0000" ><DIV CLASS="NAVHEADER" ><TABLE SUMMARY="Header navigation table" WIDTH="100%" BORDER="0" CELLPADDING="0" CELLSPACING="0" ><TR ><TH COLSPAN="3" ALIGN="center" >SDL Library Documentation</TH ></TR ><TR ><TD WIDTH="10%" ALIGN="left" VALIGN="bottom" ><A HREF="sdlrect.html" ACCESSKEY="P" >Prev</A ></TD ><TD WIDTH="80%" ALIGN="center" VALIGN="bottom" ></TD ><TD WIDTH="10%" ALIGN="right" VALIGN="bottom" ><A HREF="sdlpalette.html" ACCESSKEY="N" >Next</A ></TD ></TR ></TABLE ><HR ALIGN="LEFT" WIDTH="100%"></DIV ><H1 ><A NAME="SDLCOLOR" ></A >SDL_Color</H1 ><DIV CLASS="REFNAMEDIV" ><A NAME="AEN3082" ></A ><H2 >Name</H2 >SDL_Color -- Format independent color description</DIV ><DIV CLASS="REFSECT1" ><A NAME="AEN3085" ></A ><H2 >Structure Definition</H2 ><PRE CLASS="PROGRAMLISTING" >typedef struct{ Uint8 r; Uint8 g; Uint8 b; Uint8 unused; } SDL_Color;</PRE ></DIV ><DIV CLASS="REFSECT1" ><A NAME="AEN3088" ></A ><H2 >Structure Data</H2 ><DIV CLASS="INFORMALTABLE" ><A NAME="AEN3090" ></A ><P ></P ><TABLE BORDER="0" CLASS="CALSTABLE" ><TBODY ><TR ><TD ALIGN="LEFT" VALIGN="TOP" ><TT CLASS="STRUCTFIELD" ><I >r</I ></TT ></TD ><TD ALIGN="LEFT" VALIGN="TOP" >Red intensity</TD ></TR ><TR ><TD ALIGN="LEFT" VALIGN="TOP" ><TT CLASS="STRUCTFIELD" ><I >g</I ></TT ></TD ><TD ALIGN="LEFT" VALIGN="TOP" >Green intensity</TD ></TR ><TR ><TD ALIGN="LEFT" VALIGN="TOP" ><TT CLASS="STRUCTFIELD" ><I >b</I ></TT ></TD ><TD ALIGN="LEFT" VALIGN="TOP" >Blue intensity</TD ></TR ><TR ><TD ALIGN="LEFT" VALIGN="TOP" ><TT CLASS="STRUCTFIELD" ><I >unused</I ></TT ></TD ><TD ALIGN="LEFT" VALIGN="TOP" >Unused</TD ></TR ></TBODY ></TABLE ><P ></P ></DIV ></DIV ><DIV CLASS="REFSECT1" ><A NAME="AEN3109" ></A ><H2 >Description</H2 ><P ><SPAN CLASS="STRUCTNAME" >SDL_Color</SPAN > describes a color in a format independent way. You can convert a <SPAN CLASS="STRUCTNAME" >SDL_Color</SPAN > to a pixel value for a certain pixel format using <A HREF="sdlmaprgb.html" ><TT CLASS="FUNCTION" >SDL_MapRGB</TT ></A >.</P ></DIV ><DIV CLASS="REFSECT1" ><A NAME="AEN3116" ></A ><H2 >See Also</H2 ><P ><A HREF="sdlpixelformat.html" ><SPAN CLASS="STRUCTNAME" >SDL_PixelFormat</SPAN ></A >, <A HREF="sdlsetcolors.html" ><TT CLASS="FUNCTION" >SDL_SetColors</TT ></A >, <A HREF="sdlpalette.html" ><TT CLASS="FUNCTION" >SDL_Palette</TT ></A ></P ></DIV ><DIV CLASS="NAVFOOTER" ><HR ALIGN="LEFT" WIDTH="100%"><TABLE SUMMARY="Footer navigation table" WIDTH="100%" BORDER="0" CELLPADDING="0" CELLSPACING="0" ><TR ><TD WIDTH="33%" ALIGN="left" VALIGN="top" ><A HREF="sdlrect.html" ACCESSKEY="P" >Prev</A ></TD ><TD WIDTH="34%" ALIGN="center" VALIGN="top" ><A HREF="index.html" ACCESSKEY="H" >Home</A ></TD ><TD WIDTH="33%" ALIGN="right" VALIGN="top" ><A HREF="sdlpalette.html" ACCESSKEY="N" >Next</A ></TD ></TR ><TR ><TD WIDTH="33%" ALIGN="left" VALIGN="top" >SDL_Rect</TD ><TD WIDTH="34%" ALIGN="center" VALIGN="top" ><A HREF="video.html" ACCESSKEY="U" >Up</A ></TD ><TD WIDTH="33%" ALIGN="right" VALIGN="top" >SDL_Palette</TD ></TR ></TABLE ></DIV ></BODY ></HTML >