Mercurial > sdl-ios-xcode
diff docs/html/sdlfillrect.html @ 0:74212992fb08
Initial revision
author | Sam Lantinga <slouken@lokigames.com> |
---|---|
date | Thu, 26 Apr 2001 16:45:43 +0000 |
parents | |
children | 55f1f1b3e27d |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/html/sdlfillrect.html Thu Apr 26 16:45:43 2001 +0000 @@ -0,0 +1,270 @@ +<HTML +><HEAD +><TITLE +>SDL_FillRect</TITLE +><META +NAME="GENERATOR" +CONTENT="Modular DocBook HTML Stylesheet Version 1.61 +"><LINK +REL="HOME" +TITLE="SDL Library Documentation" +HREF="index.html"><LINK +REL="UP" +TITLE="Video" +HREF="video.html"><LINK +REL="PREVIOUS" +TITLE="SDL_BlitSurface" +HREF="sdlblitsurface.html"><LINK +REL="NEXT" +TITLE="SDL_DisplayFormat" +HREF="sdldisplayformat.html"></HEAD +><BODY +CLASS="REFENTRY" +BGCOLOR="#FFF8DC" +TEXT="#000000" +LINK="#0000ee" +VLINK="#551a8b" +ALINK="#ff0000" +><DIV +CLASS="NAVHEADER" +><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="sdlblitsurface.html" +>Prev</A +></TD +><TD +WIDTH="80%" +ALIGN="center" +VALIGN="bottom" +></TD +><TD +WIDTH="10%" +ALIGN="right" +VALIGN="bottom" +><A +HREF="sdldisplayformat.html" +>Next</A +></TD +></TR +></TABLE +><HR +ALIGN="LEFT" +WIDTH="100%"></DIV +><H1 +><A +NAME="SDLFILLRECT" +>SDL_FillRect</A +></H1 +><DIV +CLASS="REFNAMEDIV" +><A +NAME="AEN1858" +></A +><H2 +>Name</H2 +>SDL_FillRect -- This function performs a fast fill of the given rectangle with some color</DIV +><DIV +CLASS="REFSYNOPSISDIV" +><A +NAME="AEN1861" +></A +><H2 +>Synopsis</H2 +><DIV +CLASS="FUNCSYNOPSIS" +><A +NAME="AEN1862" +></A +><P +></P +><PRE +CLASS="FUNCSYNOPSISINFO" +>#include "SDL.h"</PRE +><P +><CODE +><CODE +CLASS="FUNCDEF" +>int <B +CLASS="FSFUNC" +>SDL_FillRect</B +></CODE +>(SDL_Surface *dst, SDL_Rect *dstrect, Uint32 color);</CODE +></P +><P +></P +></DIV +></DIV +><DIV +CLASS="REFSECT1" +><A +NAME="AEN1868" +></A +><H2 +>Description</H2 +><P +>This function performs a fast fill of the given rectangle with +<TT +CLASS="PARAMETER" +><I +>color</I +></TT +>. If <TT +CLASS="PARAMETER" +><I +>dstrect</I +></TT +> +is <TT +CLASS="LITERAL" +>NULL</TT +>, the whole surface will be filled with +<TT +CLASS="PARAMETER" +><I +>color</I +></TT +>.</P +><P +>The color should be a pixel of the format used by the surface, and +can be generated by the +<A +HREF="sdlmaprgb.html" +>SDL_MapRGB</A +> +function.</P +><P +>If there is a clip rectangle set on the destination (set via +<A +HREF="sdlsetcliprect.html" +>SDL_SetClipRect</A +>) then this +function will clip based on the intersection of the clip rectangle and +the <TT +CLASS="PARAMETER" +><I +>dstrect</I +></TT +> rectangle.</P +></DIV +><DIV +CLASS="REFSECT1" +><A +NAME="AEN1880" +></A +><H2 +>Return Value</H2 +><P +>This function returns <SPAN +CLASS="RETURNVALUE" +>0</SPAN +> on success, or +<SPAN +CLASS="RETURNVALUE" +>-1</SPAN +> on error.</P +></DIV +><DIV +CLASS="REFSECT1" +><A +NAME="AEN1885" +></A +><H2 +>See Also</H2 +><P +><A +HREF="sdlmaprgb.html" +><TT +CLASS="FUNCTION" +>SDL_MapRGB</TT +></A +>, +<A +HREF="sdlblitsurface.html" +><TT +CLASS="FUNCTION" +>SDL_BlitSurface</TT +></A +>, +<A +HREF="sdlrect.html" +><SPAN +CLASS="STRUCTNAME" +>SDL_Rect</SPAN +></A +></P +></DIV +><DIV +CLASS="NAVFOOTER" +><HR +ALIGN="LEFT" +WIDTH="100%"><TABLE +WIDTH="100%" +BORDER="0" +CELLPADDING="0" +CELLSPACING="0" +><TR +><TD +WIDTH="33%" +ALIGN="left" +VALIGN="top" +><A +HREF="sdlblitsurface.html" +>Prev</A +></TD +><TD +WIDTH="34%" +ALIGN="center" +VALIGN="top" +><A +HREF="index.html" +>Home</A +></TD +><TD +WIDTH="33%" +ALIGN="right" +VALIGN="top" +><A +HREF="sdldisplayformat.html" +>Next</A +></TD +></TR +><TR +><TD +WIDTH="33%" +ALIGN="left" +VALIGN="top" +>SDL_BlitSurface</TD +><TD +WIDTH="34%" +ALIGN="center" +VALIGN="top" +><A +HREF="video.html" +>Up</A +></TD +><TD +WIDTH="33%" +ALIGN="right" +VALIGN="top" +>SDL_DisplayFormat</TD +></TR +></TABLE +></DIV +></BODY +></HTML +> \ No newline at end of file