Mercurial > sdl-ios-xcode
annotate docs/html/sdlgetcliprect.html @ 2866:e532417a6977
Fixed SDL 1.2 compatibility problem.
The API specifies that SDL_OpenAudio() will fill out the 'desired' audio spec
with the correct samples and size set by the driver. This value is important
since it may be used by applications that size audio buffers, etc.
However, we want to allow advanced applications to call SDL_OpenAudioDevice()
which gets passed a const 'desired' parameter, and have the correct data filled
into the 'obtained' parameter, possibly allowing or not allowing format changes.
So... 'obtained' becomes the audio format the user callback is expected to use,
and we add flags to allow the application to specify which format changes are
allowed.
Note: We really need to add a way to query the 'obtained' audio spec.
author | Sam Lantinga <slouken@libsdl.org> |
---|---|
date | Sat, 13 Dec 2008 06:36:47 +0000 |
parents | 355632dca928 |
children |
rev | line source |
---|---|
0 | 1 <HTML |
2 ><HEAD | |
3 ><TITLE | |
4 >SDL_GetClipRect</TITLE | |
5 ><META | |
6 NAME="GENERATOR" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
7 CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ |
0 | 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_SetClipRect" | |
17 HREF="sdlsetcliprect.html"><LINK | |
18 REL="NEXT" | |
19 TITLE="SDL_ConvertSurface" | |
20 HREF="sdlconvertsurface.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 | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
31 SUMMARY="Header navigation table" |
0 | 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="sdlsetcliprect.html" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
49 ACCESSKEY="P" |
0 | 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="sdlconvertsurface.html" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
63 ACCESSKEY="N" |
0 | 64 >Next</A |
65 ></TD | |
66 ></TR | |
67 ></TABLE | |
68 ><HR | |
69 ALIGN="LEFT" | |
70 WIDTH="100%"></DIV | |
71 ><H1 | |
72 ><A | |
73 NAME="SDLGETCLIPRECT" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
74 ></A |
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
75 >SDL_GetClipRect</H1 |
0 | 76 ><DIV |
77 CLASS="REFNAMEDIV" | |
78 ><A | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
79 NAME="AEN2230" |
0 | 80 ></A |
81 ><H2 | |
82 >Name</H2 | |
83 >SDL_GetClipRect -- Gets the clipping rectangle for a surface.</DIV | |
84 ><DIV | |
85 CLASS="REFSYNOPSISDIV" | |
86 ><A | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
87 NAME="AEN2233" |
0 | 88 ></A |
89 ><H2 | |
90 >Synopsis</H2 | |
91 ><DIV | |
92 CLASS="FUNCSYNOPSIS" | |
93 ><A | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
94 NAME="AEN2234" |
0 | 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_GetClipRect</B | |
108 ></CODE | |
109 >(SDL_Surface *surface, SDL_Rect *rect);</CODE | |
110 ></P | |
111 ><P | |
112 ></P | |
113 ></DIV | |
114 ></DIV | |
115 ><DIV | |
116 CLASS="REFSECT1" | |
117 ><A | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
118 NAME="AEN2240" |
0 | 119 ></A |
120 ><H2 | |
121 >Description</H2 | |
122 ><P | |
123 >Gets the clipping rectangle for a surface. When this surface is the | |
124 destination of a blit, only the area within the clip rectangle is | |
125 drawn into.</P | |
126 ><P | |
127 >The rectangle pointed to by <TT | |
128 CLASS="PARAMETER" | |
129 ><I | |
130 >rect</I | |
131 ></TT | |
132 > will be | |
133 filled with the clipping rectangle of the surface.</P | |
134 ></DIV | |
135 ><DIV | |
136 CLASS="REFSECT1" | |
137 ><A | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
138 NAME="AEN2245" |
0 | 139 ></A |
140 ><H2 | |
141 >See Also</H2 | |
142 ><P | |
143 ><A | |
144 HREF="sdlsetcliprect.html" | |
145 ><TT | |
146 CLASS="FUNCTION" | |
147 >SDL_SetClipRect</TT | |
148 ></A | |
149 >, | |
150 <A | |
151 HREF="sdlblitsurface.html" | |
152 ><TT | |
153 CLASS="FUNCTION" | |
154 >SDL_BlitSurface</TT | |
155 ></A | |
156 >, | |
157 <A | |
158 HREF="sdlsurface.html" | |
159 ><SPAN | |
160 CLASS="STRUCTNAME" | |
161 >SDL_Surface</SPAN | |
162 ></A | |
163 ></P | |
164 ></DIV | |
165 ><DIV | |
166 CLASS="NAVFOOTER" | |
167 ><HR | |
168 ALIGN="LEFT" | |
169 WIDTH="100%"><TABLE | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
170 SUMMARY="Footer navigation table" |
0 | 171 WIDTH="100%" |
172 BORDER="0" | |
173 CELLPADDING="0" | |
174 CELLSPACING="0" | |
175 ><TR | |
176 ><TD | |
177 WIDTH="33%" | |
178 ALIGN="left" | |
179 VALIGN="top" | |
180 ><A | |
181 HREF="sdlsetcliprect.html" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
182 ACCESSKEY="P" |
0 | 183 >Prev</A |
184 ></TD | |
185 ><TD | |
186 WIDTH="34%" | |
187 ALIGN="center" | |
188 VALIGN="top" | |
189 ><A | |
190 HREF="index.html" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
191 ACCESSKEY="H" |
0 | 192 >Home</A |
193 ></TD | |
194 ><TD | |
195 WIDTH="33%" | |
196 ALIGN="right" | |
197 VALIGN="top" | |
198 ><A | |
199 HREF="sdlconvertsurface.html" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
200 ACCESSKEY="N" |
0 | 201 >Next</A |
202 ></TD | |
203 ></TR | |
204 ><TR | |
205 ><TD | |
206 WIDTH="33%" | |
207 ALIGN="left" | |
208 VALIGN="top" | |
209 >SDL_SetClipRect</TD | |
210 ><TD | |
211 WIDTH="34%" | |
212 ALIGN="center" | |
213 VALIGN="top" | |
214 ><A | |
215 HREF="video.html" | |
803
355632dca928
Updated SDL HTML documentation
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
216 ACCESSKEY="U" |
0 | 217 >Up</A |
218 ></TD | |
219 ><TD | |
220 WIDTH="33%" | |
221 ALIGN="right" | |
222 VALIGN="top" | |
223 >SDL_ConvertSurface</TD | |
224 ></TR | |
225 ></TABLE | |
226 ></DIV | |
227 ></BODY | |
228 ></HTML | |
229 > |