Mercurial > sdl-ios-xcode

comparison include/SDL_video.h @ 5249:762e40fb8e28

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Be explicit about what display you're querying. The default display is 0.
author Sam Lantinga <slouken@libsdl.org>
date Thu, 10 Feb 2011 12:14:37 -0800
parents 3a8a452b49f0
children 58265e606e4e
comparison
equal deleted inserted replaced
5248:3a8a452b49f0 5249:762e40fb8e28
234 234
235 /** 235 /**
236 * \brief Returns the number of available video displays. 236 * \brief Returns the number of available video displays.
237 * 237 *
238 * \sa SDL_GetDisplayBounds() 238 * \sa SDL_GetDisplayBounds()
239 * \sa SDL_SelectVideoDisplay()
240 */ 239 */
241 extern DECLSPEC int SDLCALL SDL_GetNumVideoDisplays(void); 240 extern DECLSPEC int SDLCALL SDL_GetNumVideoDisplays(void);
242 241
243 /** 242 /**
244 * \brief Get the desktop area represented by a display, with the primary 243 * \brief Get the desktop area represented by a display, with the primary
246 * 245 *
247 * \return 0 on success, or -1 if the index is out of range. 246 * \return 0 on success, or -1 if the index is out of range.
248 * 247 *
249 * \sa SDL_GetNumVideoDisplays() 248 * \sa SDL_GetNumVideoDisplays()
250 */ 249 */
251 extern DECLSPEC int SDLCALL SDL_GetDisplayBounds(int index, SDL_Rect * rect); 250 extern DECLSPEC int SDLCALL SDL_GetDisplayBounds(int displayIndex, SDL_Rect * rect);
252 251
253 /** 252 /**
254 * \brief Set the index of the currently selected display. 253 * \brief Returns the number of available display modes.
255 *
256 * \return 0 on success, or -1 if the index is out of range.
257 *
258 * \sa SDL_GetNumVideoDisplays()
259 * \sa SDL_GetCurrentVideoDisplay()
260 */
261 extern DECLSPEC int SDLCALL SDL_SelectVideoDisplay(int index);
262
263 /**
264 * \brief Get the index of the currently selected display.
265 *
266 * \return The index of the currently selected display.
267 *
268 * \sa SDL_GetNumVideoDisplays()
269 * \sa SDL_SelectVideoDisplay()
270 */
271 extern DECLSPEC int SDLCALL SDL_GetCurrentVideoDisplay(void);
272
273 /**
274 * \brief Returns the number of available display modes for the current display.
275 * 254 *
276 * \sa SDL_GetDisplayMode() 255 * \sa SDL_GetDisplayMode()
277 */ 256 */
278 extern DECLSPEC int SDLCALL SDL_GetNumDisplayModes(void); 257 extern DECLSPEC int SDLCALL SDL_GetNumDisplayModes(int displayIndex);
279 258
280 /** 259 /**
281 * \brief Fill in information about a specific display mode. 260 * \brief Fill in information about a specific display mode.
282 * 261 *
283 * \note The display modes are sorted in this priority: 262 * \note The display modes are sorted in this priority:
286 * \li height -> largest to smallest 265 * \li height -> largest to smallest
287 * \li refresh rate -> highest to lowest 266 * \li refresh rate -> highest to lowest
288 * 267 *
289 * \sa SDL_GetNumDisplayModes() 268 * \sa SDL_GetNumDisplayModes()
290 */ 269 */
291 extern DECLSPEC int SDLCALL SDL_GetDisplayMode(int index, 270 extern DECLSPEC int SDLCALL SDL_GetDisplayMode(int displayIndex, int modeIndex,
292 SDL_DisplayMode * mode); 271 SDL_DisplayMode * mode);
293 272
294 /** 273 /**
295 * \brief Fill in information about the desktop display mode for the current 274 * \brief Fill in information about the desktop display mode.
296 * display. 275 */
297 */ 276 extern DECLSPEC int SDLCALL SDL_GetDesktopDisplayMode(int displayIndex, SDL_DisplayMode * mode);
298 extern DECLSPEC int SDLCALL SDL_GetDesktopDisplayMode(SDL_DisplayMode * mode);
299 277
300 /** 278 /**
301 * \brief Fill in information about the current display mode. 279 * \brief Fill in information about the current display mode.
302 */ 280 */
303 extern DECLSPEC int SDLCALL SDL_GetCurrentDisplayMode(SDL_DisplayMode * mode); 281 extern DECLSPEC int SDLCALL SDL_GetCurrentDisplayMode(int displayIndex, SDL_DisplayMode * mode);
304 282
305 283
306 /** 284 /**
307 * \brief Get the closest match to the requested display mode. 285 * \brief Get the closest match to the requested display mode.
308 * 286 *
321 * small, then NULL is returned. 299 * small, then NULL is returned.
322 * 300 *
323 * \sa SDL_GetNumDisplayModes() 301 * \sa SDL_GetNumDisplayModes()
324 * \sa SDL_GetDisplayMode() 302 * \sa SDL_GetDisplayMode()
325 */ 303 */
326 extern DECLSPEC SDL_DisplayMode *SDLCALL SDL_GetClosestDisplayMode(const 304 extern DECLSPEC SDL_DisplayMode * SDLCALL SDL_GetClosestDisplayMode(int displayIndex, const SDL_DisplayMode * mode, SDL_DisplayMode * closest);
327 SDL_DisplayMode 305
328 * mode, 306 /**
329 SDL_DisplayMode 307 * \brief Set the display mode used when a fullscreen window is visible.
330 * closest); 308 *
331 309 * By default the window's dimensions and the desktop format and refresh rate
332 /** 310 * are used.
333 * \brief Set the display mode used when a fullscreen window is visible
334 * on the currently selected display. By default the window's
335 * dimensions and the desktop format and refresh rate are used.
336 * 311 *
337 * \param mode The mode to use, or NULL for the default mode. 312 * \param mode The mode to use, or NULL for the default mode.
338 * 313 *
339 * \return 0 on success, or -1 if setting the display mode failed. 314 * \return 0 on success, or -1 if setting the display mode failed.
340 * 315 *
345 const SDL_DisplayMode 320 const SDL_DisplayMode
346 * mode); 321 * mode);
347 322
348 /** 323 /**
349 * \brief Fill in information about the display mode used when a fullscreen 324 * \brief Fill in information about the display mode used when a fullscreen
350 * window is visible on the currently selected display. 325 * window is visible.
351 * 326 *
352 * \sa SDL_SetWindowDisplayMode() 327 * \sa SDL_SetWindowDisplayMode()
353 * \sa SDL_SetWindowFullscreen() 328 * \sa SDL_SetWindowFullscreen()
354 */ 329 */
355 extern DECLSPEC int SDLCALL SDL_GetWindowDisplayMode(SDL_Window * window, 330 extern DECLSPEC int SDLCALL SDL_GetWindowDisplayMode(SDL_Window * window,