[sdl_omap.git] / docs / html / sdlfreesurface.html

<HTML
><HEAD
><TITLE
>SDL_FreeSurface</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_CreateRGBSurfaceFrom"
HREF="sdlcreatergbsurfacefrom.html"><LINK
REL="NEXT"
TITLE="SDL_LockSurface"
HREF="sdllocksurface.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="sdlcreatergbsurfacefrom.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="sdllocksurface.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="SDLFREESURFACE"
></A
>SDL_FreeSurface</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN1893"
></A
><H2
>Name</H2
>SDL_FreeSurface&nbsp;--&nbsp;Frees (deletes) a SDL_Surface</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN1896"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><A
NAME="AEN1897"
></A
><P
></P
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include "SDL.h"</PRE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>void <B
CLASS="FSFUNC"
>SDL_FreeSurface</B
></CODE
>(SDL_Surface *surface);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN1903"
></A
><H2
>Description</H2
><P
>Frees the resources used by a previously created <SPAN
CLASS="STRUCTNAME"
>SDL_Surface</SPAN
>. If the surface was created using 
<A
HREF="sdlcreatergbsurfacefrom.html"
>SDL_CreateRGBSurfaceFrom</A
> then the pixel data is not freed.</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN1908"
></A
><H2
>See Also</H2
><P
><A
HREF="sdlcreatergbsurface.html"
><TT
CLASS="FUNCTION"
>SDL_CreateRGBSurface</TT
></A
>
<A
HREF="sdlcreatergbsurfacefrom.html"
><TT
CLASS="FUNCTION"
>SDL_CreateRGBSurfaceFrom</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="sdlcreatergbsurfacefrom.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="sdllocksurface.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>SDL_CreateRGBSurfaceFrom</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_LockSurface</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>
Commit	Line	Data
e14743d1	1	<HTML
	2	><HEAD
	3	><TITLE
	4	>SDL_FreeSurface</TITLE
	5	><META
	6	NAME="GENERATOR"
	7	CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
	8	"><LINK
	9	REL="HOME"
	10	TITLE="SDL Library Documentation"
	11	HREF="index.html"><LINK
	12	REL="UP"
	13	TITLE="Video"
	14	HREF="video.html"><LINK
	15	REL="PREVIOUS"
	16	TITLE="SDL_CreateRGBSurfaceFrom"
	17	HREF="sdlcreatergbsurfacefrom.html"><LINK
	18	REL="NEXT"
	19	TITLE="SDL_LockSurface"
	20	HREF="sdllocksurface.html"></HEAD
	21	><BODY
	22	CLASS="REFENTRY"
	23	BGCOLOR="#FFF8DC"
	24	TEXT="#000000"
	25	LINK="#0000ee"
	26	VLINK="#551a8b"
	27	ALINK="#ff0000"
	28	><DIV
	29	CLASS="NAVHEADER"
	30	><TABLE
	31	SUMMARY="Header navigation table"
	32	WIDTH="100%"
	33	BORDER="0"
	34	CELLPADDING="0"
	35	CELLSPACING="0"
	36	><TR
	37	><TH
	38	COLSPAN="3"
	39	ALIGN="center"
	40	>SDL Library Documentation</TH
	41	></TR
	42	><TR
	43	><TD
	44	WIDTH="10%"
	45	ALIGN="left"
	46	VALIGN="bottom"
	47	><A
	48	HREF="sdlcreatergbsurfacefrom.html"
	49	ACCESSKEY="P"
	50	>Prev</A
	51	></TD
	52	><TD
	53	WIDTH="80%"
	54	ALIGN="center"
	55	VALIGN="bottom"
	56	></TD
	57	><TD
	58	WIDTH="10%"
	59	ALIGN="right"
	60	VALIGN="bottom"
	61	><A
	62	HREF="sdllocksurface.html"
	63	ACCESSKEY="N"
	64	>Next</A
65	></TD
66	></TR
67	></TABLE
68	><HR
69	ALIGN="LEFT"
70	WIDTH="100%"></DIV
71	><H1
72	><A
73	NAME="SDLFREESURFACE"
74	></A
75	>SDL_FreeSurface</H1
76	><DIV
77	CLASS="REFNAMEDIV"
78	><A
79	NAME="AEN1893"
80	></A
81	><H2
82	>Name</H2
83	>SDL_FreeSurface -- Frees (deletes) a SDL_Surface</DIV
84	><DIV
85	CLASS="REFSYNOPSISDIV"
86	><A
87	NAME="AEN1896"
88	></A
89	><H2
90	>Synopsis</H2
91	><DIV
92	CLASS="FUNCSYNOPSIS"
93	><A
94	NAME="AEN1897"
95	></A
96	><P
97	></P
98	><PRE
99	CLASS="FUNCSYNOPSISINFO"
100	>#include "SDL.h"</PRE
101	><P
102	><CODE
103	><CODE
104	CLASS="FUNCDEF"
105	>void <B
106	CLASS="FSFUNC"
107	>SDL_FreeSurface</B
108	></CODE
109	>(SDL_Surface *surface);</CODE
110	></P
111	><P
112	></P
113	></DIV
114	></DIV
115	><DIV
116	CLASS="REFSECT1"
117	><A
118	NAME="AEN1903"
119	></A
120	><H2
121	>Description</H2
122	><P
123	>Frees the resources used by a previously created <SPAN
124	CLASS="STRUCTNAME"
125	>SDL_Surface</SPAN
126	>. If the surface was created using
127	<A
128	HREF="sdlcreatergbsurfacefrom.html"
129	>SDL_CreateRGBSurfaceFrom</A
130	> then the pixel data is not freed.</P
131	></DIV
132	><DIV
133	CLASS="REFSECT1"
134	><A
135	NAME="AEN1908"
136	></A
137	><H2
138	>See Also</H2
139	><P
140	><A
141	HREF="sdlcreatergbsurface.html"
142	><TT
143	CLASS="FUNCTION"
144	>SDL_CreateRGBSurface</TT
145	></A
146	>
147	<A
148	HREF="sdlcreatergbsurfacefrom.html"
149	><TT
150	CLASS="FUNCTION"
151	>SDL_CreateRGBSurfaceFrom</TT
152	></A
153	></P
154	></DIV
155	><DIV
156	CLASS="NAVFOOTER"
157	><HR
158	ALIGN="LEFT"
159	WIDTH="100%"><TABLE
160	SUMMARY="Footer navigation table"
161	WIDTH="100%"
162	BORDER="0"
163	CELLPADDING="0"
164	CELLSPACING="0"
165	><TR
166	><TD
167	WIDTH="33%"
168	ALIGN="left"
169	VALIGN="top"
170	><A
171	HREF="sdlcreatergbsurfacefrom.html"
172	ACCESSKEY="P"
173	>Prev</A
174	></TD
175	><TD
176	WIDTH="34%"
177	ALIGN="center"
178	VALIGN="top"
179	><A
180	HREF="index.html"
181	ACCESSKEY="H"
182	>Home</A
183	></TD
184	><TD
185	WIDTH="33%"
186	ALIGN="right"
187	VALIGN="top"
188	><A
189	HREF="sdllocksurface.html"
190	ACCESSKEY="N"
191	>Next</A
192	></TD
193	></TR
194	><TR
195	><TD
196	WIDTH="33%"
197	ALIGN="left"
198	VALIGN="top"
199	>SDL_CreateRGBSurfaceFrom</TD
200	><TD
201	WIDTH="34%"
202	ALIGN="center"
203	VALIGN="top"
204	><A
205	HREF="video.html"
206	ACCESSKEY="U"
207	>Up</A
208	></TD
209	><TD
210	WIDTH="33%"
211	ALIGN="right"
212	VALIGN="top"
213	>SDL_LockSurface</TD
214	></TR
215	></TABLE
216	></DIV
217	></BODY
218	></HTML
219	>