Mercurial > sdl-ios-xcode

comparison docs/man3/SDL_SetVideoMode.3 @ 181:e5bc29de3f0a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Updated from the SDL Documentation Project
author Sam Lantinga <slouken@libsdl.org>
date Fri, 14 Sep 2001 02:41:09 +0000
parents 55f1f1b3e27d
children 546f7c1eb755
comparison
equal deleted inserted replaced
180:578815880307 181:e5bc29de3f0a
1 .TH "SDL_SetVideoMode" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" 1 .TH "SDL_SetVideoMode" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference"
2 .SH "NAME" 2 .SH "NAME"
3 SDL_SetVideoMode\- Set up a video mode with the specified width, height and bits-per-pixel\&. 3 SDL_SetVideoMode\- Set up a video mode with the specified width, height and bits-per-pixel\&.
4 .SH "SYNOPSIS" 4 .SH "SYNOPSIS"
5 .PP 5 .PP
6 \fB#include "SDL\&.h" 6 \fB#include "SDL\&.h"
19 .TP 20 19 .TP 20
20 \fBSDL_HWSURFACE\fP 20 \fBSDL_HWSURFACE\fP
21 Create the video surface in video memory 21 Create the video surface in video memory
22 .TP 20 22 .TP 20
23 \fBSDL_ASYNCBLIT\fP 23 \fBSDL_ASYNCBLIT\fP
24 Enables the use of asynchronous to the display surface\&. This will usually slow down blitting on single CPU machines, but may provide a speed increase on SMP systems\&. 24 Enables the use of asynchronous updates of the display surface\&. This will usually slow down blitting on single CPU machines, but may provide a speed increase on SMP systems\&.
25 .TP 20 25 .TP 20
26 \fBSDL_ANYFORMAT\fP 26 \fBSDL_ANYFORMAT\fP
27 Normally, if a video surface of the requested depth (\fBbpp\fR) is not available, SDL will emulate one with a shadow surface\&. Passing \fBSDL_ANYFORMAT\fP prevents this and causes SDL to use the video surface, regardless of its depth\&. 27 Normally, if a video surface of the requested bits-per-pixel (\fBbpp\fR) is not available, SDL will emulate one with a shadow surface\&. Passing \fBSDL_ANYFORMAT\fP prevents this and causes SDL to use the video surface, regardless of its pixel depth\&.
28 .TP 20 28 .TP 20
29 \fBSDL_HWPALETTE\fP 29 \fBSDL_HWPALETTE\fP
30 Give SDL exclusive palette access\&. Without this flag you may not always get the the colors you request with \fI\fBSDL_SetColors\fP\fR\&. 30 Give SDL exclusive palette access\&. Without this flag you may not always get the the colors you request with \fI\fBSDL_SetColors\fP\fR or \fI\fBSDL_SetPalette\fP\fR\&.
31 .TP 20 31 .TP 20
32 \fBSDL_DOUBLEBUF\fP 32 \fBSDL_DOUBLEBUF\fP
33 Enable double buffering; only valid with SDL_HWSURFACE\&. Calling \fI\fBSDL_Flip\fP\fR will flip the buffers and update the screen\&. If double buffering could not be enabled then \fBSDL_Flip\fP will just perform a \fI\fBSDL_UpdateRect\fP\fR on the entire screen\&. 33 Enable hardware double buffering; only valid with SDL_HWSURFACE\&. Calling \fI\fBSDL_Flip\fP\fR will flip the buffers and update the screen\&. All drawing will take place on the surface that is not displayed at the moment\&. If double buffering could not be enabled then \fBSDL_Flip\fP will just perform a \fI\fBSDL_UpdateRect\fP\fR on the entire screen\&.
34 .TP 20 34 .TP 20
35 \fBSDL_FULLSCREEN\fP 35 \fBSDL_FULLSCREEN\fP
36 SDL will attempt to use a fullscreen mode 36 SDL will attempt to use a fullscreen mode\&. If a hardware resolution change is not possible (for whatever reason), the next higher resolution will be used and the display window centered on a black background\&.
37 .TP 20 37 .TP 20
38 \fBSDL_OPENGL\fP 38 \fBSDL_OPENGL\fP
39 Create an OpenGL rendering context\&. You should have previously set OpenGL video attributes with \fI\fBSDL_GL_SetAttribute\fP\fR\&. 39 Create an OpenGL rendering context\&. You should have previously set OpenGL video attributes with \fI\fBSDL_GL_SetAttribute\fP\fR\&.
40 .TP 20 40 .TP 20
41 \fBSDL_OPENGLBLIT\fP 41 \fBSDL_OPENGLBLIT\fP
42 Create an OpenGL rendering context, like above, but allow normal blitting operations\&. 42 Create an OpenGL rendering context, like above, but allow normal blitting operations\&. The screen (2D) surface may have an alpha channel, and \fI\fBSDL_UpdateRects\fP\fR must be used for updating changes to the screen surface\&.
43 .TP 20 43 .TP 20
44 \fBSDL_RESIZABLE\fP 44 \fBSDL_RESIZABLE\fP
45 Create a resizable window\&. When the window is resized by the user a \fI\fBSDL_VIDEORESIZE\fP\fR event is generated and \fBSDL_SetVideoMode\fP can be called again with the new size\&. 45 Create a resizable window\&. When the window is resized by the user a \fI\fBSDL_VIDEORESIZE\fP\fR event is generated and \fBSDL_SetVideoMode\fP can be called again with the new size\&.
46 .TP 20 46 .TP 20
47 \fBSDL_NOFRAME\fP 47 \fBSDL_NOFRAME\fP
50 .RS 50 .RS
51 \fBNote: 51 \fBNote:
52 .PP 52 .PP
53 Whatever \fBflags\fR \fBSDL_SetVideoMode\fP could satisfy are set in the \fBflags\fR member of the returned surface\&. 53 Whatever \fBflags\fR \fBSDL_SetVideoMode\fP could satisfy are set in the \fBflags\fR member of the returned surface\&.
54 .RE 54 .RE
55 .PP
56 .RS
57 \fBNote:
58 .PP
59 The \fBbpp\fR parameter is the number of bits per pixel, so a \fBbpp\fR of 24 uses the packed representation of 3 bytes/pixel\&. For the more common 4 bytes/pixel mode, use a \fBbpp\fR of 32\&. Somewhat oddly, both 15 and 16 will request a 2 bytes/pixel mode, but different pixel formats\&.
60 .RE
55 .SH "RETURN VALUE" 61 .SH "RETURN VALUE"
56 .PP 62 .PP
57 The framebuffer surface, or \fBNULL\fR if it fails\&. 63 The framebuffer surface, or \fBNULL\fR if it fails\&. The surface returned is freed by SDL_Quit() and should nt be freed by the caller\&.
58 .SH "SEE ALSO" 64 .SH "SEE ALSO"
59 .PP 65 .PP
60 \fI\fBSDL_LockSurface\fP\fR, \fI\fBSDL_SetColors\fP\fR, \fI\fBSDL_Flip\fP\fR, \fI\fBSDL_Surface\fR\fR 66 \fI\fBSDL_LockSurface\fP\fR, \fI\fBSDL_SetColors\fP\fR, \fI\fBSDL_Flip\fP\fR, \fI\fBSDL_Surface\fR\fR
61 ...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:42 67 ...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01