sdl-ios-xcode: docs/html/guidevideo.html annotate

annotate docs/html/guidevideo.html @ 2860:6ce28e5287e9

Date: Sun, 07 Dec 2008 13:35:23 +0100 From: Couriersud Subject: SDL: Mouse last_x, last_y into SDL_Mouse the attached diff moves the static vars last_x and last_y into SDL_Mouse. These, as far as I understand it, should be tied to the individual mouse. The patch also makes the code check for out of window conditions of mouse->x,y when relative movements are passed to MouseSendMotion. Also attached is the latest DirectFB code (dfb20081208) supporting multiple mice and keyboards. This works quite well with sdlmame now. It however needs more testing with different directfb configurations.

author	Sam Lantinga <slouken@libsdl.org>
date	Mon, 08 Dec 2008 00:52:12 +0000
parents	355632dca928
children

rev	line source
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1 <HTML
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	2 ><HEAD
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	3 ><TITLE
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	4 >Graphics and Video</TITLE
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	5 ><META
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	6 NAME="GENERATOR"
803 355632dca928 Updated SDL HTML documentation Sam Lantinga <slouken@libsdl.org> parents: 55 diff changeset	7 CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	8 "><LINK
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	9 REL="HOME"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	10 TITLE="SDL Library Documentation"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	11 HREF="index.html"><LINK
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	12 REL="UP"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	13 TITLE="SDL Guide"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	14 HREF="guide.html"><LINK
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	15 REL="PREVIOUS"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	16 TITLE="Initializing SDL"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	17 HREF="guidebasicsinit.html"><LINK
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	18 REL="NEXT"
55 55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	19 TITLE="Using OpenGL With SDL"
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	20 HREF="guidevideoopengl.html"></HEAD
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	21 ><BODY
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	22 CLASS="CHAPTER"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	23 BGCOLOR="#FFF8DC"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	24 TEXT="#000000"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	25 LINK="#0000ee"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	26 VLINK="#551a8b"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	27 ALINK="#ff0000"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	28 ><DIV
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	29 CLASS="NAVHEADER"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	30 ><TABLE
803 355632dca928 Updated SDL HTML documentation Sam Lantinga <slouken@libsdl.org> parents: 55 diff changeset	31 SUMMARY="Header navigation table"
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	32 WIDTH="100%"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	33 BORDER="0"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	34 CELLPADDING="0"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	35 CELLSPACING="0"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	36 ><TR
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	37 ><TH
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	38 COLSPAN="3"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	39 ALIGN="center"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	40 >SDL Library Documentation</TH
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	41 ></TR
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	42 ><TR
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	43 ><TD
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	44 WIDTH="10%"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	45 ALIGN="left"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	46 VALIGN="bottom"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	47 ><A
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	48 HREF="guidebasicsinit.html"
803 355632dca928 Updated SDL HTML documentation Sam Lantinga <slouken@libsdl.org> parents: 55 diff changeset	49 ACCESSKEY="P"
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	50 >Prev</A
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	51 ></TD
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	52 ><TD
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	53 WIDTH="80%"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	54 ALIGN="center"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	55 VALIGN="bottom"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	56 ></TD
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	57 ><TD
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	58 WIDTH="10%"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	59 ALIGN="right"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	60 VALIGN="bottom"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	61 ><A
55 55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	62 HREF="guidevideoopengl.html"
803 355632dca928 Updated SDL HTML documentation Sam Lantinga <slouken@libsdl.org> parents: 55 diff changeset	63 ACCESSKEY="N"
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	64 >Next</A
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	65 ></TD
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	66 ></TR
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	67 ></TABLE
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	68 ><HR
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	69 ALIGN="LEFT"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	70 WIDTH="100%"></DIV
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	71 ><DIV
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	72 CLASS="CHAPTER"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	73 ><H1
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	74 ><A
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	75 NAME="GUIDEVIDEO"
803 355632dca928 Updated SDL HTML documentation Sam Lantinga <slouken@libsdl.org> parents: 55 diff changeset	76 ></A
355632dca928 Updated SDL HTML documentation Sam Lantinga <slouken@libsdl.org> parents: 55 diff changeset	77 >Chapter 2. Graphics and Video</H1
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	78 ><DIV
55 55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	79 CLASS="TOC"
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	80 ><DL
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	81 ><DT
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	82 ><B
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	83 >Table of Contents</B
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	84 ></DT
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	85 ><DT
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	86 ><A
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	87 HREF="guidevideo.html#GUIDEVIDEOINTRO"
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	88 >Introduction to SDL Video</A
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	89 ></DT
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	90 ><DT
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	91 ><A
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	92 HREF="guidevideoopengl.html"
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	93 >Using OpenGL With SDL</A
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	94 ></DT
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	95 ></DL
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	96 ></DIV
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	97 ><DIV
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	98 CLASS="SECT1"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	99 ><H1
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	100 CLASS="SECT1"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	101 ><A
55 55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	102 NAME="GUIDEVIDEOINTRO"
803 355632dca928 Updated SDL HTML documentation Sam Lantinga <slouken@libsdl.org> parents: 55 diff changeset	103 ></A
355632dca928 Updated SDL HTML documentation Sam Lantinga <slouken@libsdl.org> parents: 55 diff changeset	104 >Introduction to SDL Video</H1
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	105 ><P
55 55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	106 >Video is probably the most common thing that SDL is used for, and
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	107 so it has the most complete subsystem. Here are a few
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	108 examples to demonstrate the basics.</P
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	109 ><DIV
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	110 CLASS="SECT2"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	111 ><H2
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	112 CLASS="SECT2"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	113 ><A
55 55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	114 NAME="AEN68"
803 355632dca928 Updated SDL HTML documentation Sam Lantinga <slouken@libsdl.org> parents: 55 diff changeset	115 ></A
355632dca928 Updated SDL HTML documentation Sam Lantinga <slouken@libsdl.org> parents: 55 diff changeset	116 >Initializing the Video Display</H2
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	117 ><P
55 55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	118 >This is what almost all SDL programs have to do in one way or
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	119 another.</P
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	120 ><DIV
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	121 CLASS="EXAMPLE"
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	122 ><A
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	123 NAME="AEN71"
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	124 ></A
55 55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	125 ><P
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	126 ><B
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	127 >Example 2-1. Initializing the Video Display</B
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	128 ></P
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	129 ><PRE
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	130 CLASS="PROGRAMLISTING"
55 55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	131 > SDL_Surface *screen;
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	132
55 55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	133 /* Initialize the SDL library */
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	134 if( SDL_Init(SDL_INIT_VIDEO) < 0 ) {
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	135 fprintf(stderr,
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	136 "Couldn't initialize SDL: %s\n", SDL_GetError());
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	137 exit(1);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	138 }
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	139
55 55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	140 /* Clean up on exit */
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	141 atexit(SDL_Quit);
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	142
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	143 /*
55 55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	144 * Initialize the display in a 640x480 8-bit palettized mode,
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	145 * requesting a software surface
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	146 */
55 55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	147 screen = SDL_SetVideoMode(640, 480, 8, SDL_SWSURFACE);
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	148 if ( screen == NULL ) {
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	149 fprintf(stderr, "Couldn't set 640x480x8 video mode: %s\n",
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	150 SDL_GetError());
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	151 exit(1);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	152 }</PRE
55 55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	153 ></DIV
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	154 ></DIV
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	155 ><DIV
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	156 CLASS="SECT2"
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	157 ><H2
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	158 CLASS="SECT2"
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	159 ><A
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	160 NAME="AEN74"
803 355632dca928 Updated SDL HTML documentation Sam Lantinga <slouken@libsdl.org> parents: 55 diff changeset	161 ></A
355632dca928 Updated SDL HTML documentation Sam Lantinga <slouken@libsdl.org> parents: 55 diff changeset	162 >Initializing the Best Video Mode</H2
55 55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	163 ><P
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	164 >If you have a preference for a certain pixel depth but will accept any
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	165 other, use SDL_SetVideoMode with SDL_ANYFORMAT as below. You can also
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	166 use SDL_VideoModeOK() to find the native video mode that is closest to
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	167 the mode you request.</P
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	168 ><DIV
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	169 CLASS="EXAMPLE"
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	170 ><A
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	171 NAME="AEN77"
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	172 ></A
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	173 ><P
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	174 ><B
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	175 >Example 2-2. Initializing the Best Video Mode</B
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	176 ></P
55 55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	177 ><PRE
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	178 CLASS="PROGRAMLISTING"
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	179 > /* Have a preference for 8-bit, but accept any depth */
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	180 screen = SDL_SetVideoMode(640, 480, 8, SDL_SWSURFACE\|SDL_ANYFORMAT);
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	181 if ( screen == NULL ) {
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	182 fprintf(stderr, "Couldn't set 640x480x8 video mode: %s\n",
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	183 SDL_GetError());
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	184 exit(1);
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	185 }
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	186 printf("Set 640x480 at %d bits-per-pixel mode\n",
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	187 screen->format->BitsPerPixel);</PRE
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	188 ></DIV
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	189 ></DIV
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	190 ><DIV
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	191 CLASS="SECT2"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	192 ><H2
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	193 CLASS="SECT2"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	194 ><A
55 55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	195 NAME="AEN80"
803 355632dca928 Updated SDL HTML documentation Sam Lantinga <slouken@libsdl.org> parents: 55 diff changeset	196 ></A
355632dca928 Updated SDL HTML documentation Sam Lantinga <slouken@libsdl.org> parents: 55 diff changeset	197 >Loading and Displaying a BMP File</H2
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	198 ><P
55 55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	199 >The following function loads and displays a BMP file given as
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	200 argument, once SDL is initialised and a video mode has been set.</P
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	201 ><DIV
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	202 CLASS="EXAMPLE"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	203 ><A
55 55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	204 NAME="AEN83"
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	205 ></A
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	206 ><P
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	207 ><B
55 55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	208 >Example 2-3. Loading and Displaying a BMP File</B
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	209 ></P
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	210 ><PRE
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	211 CLASS="PROGRAMLISTING"
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	212 >void display_bmp(char *file_name)
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	213 {
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	214 SDL_Surface *image;
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	215
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	216 /* Load the BMP file into a surface */
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	217 image = SDL_LoadBMP(file_name);
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	218 if (image == NULL) {
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	219 fprintf(stderr, "Couldn't load %s: %s\n", file_name, SDL_GetError());
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	220 return;
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	221 }
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	222
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	223 /*
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	224 * Palettized screen modes will have a default palette (a standard
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	225 * 884 colour cube), but if the image is palettized as well we can
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	226 * use that palette for a nicer colour matching
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	227 */
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	228 if (image->format->palette && screen->format->palette) {
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	229 SDL_SetColors(screen, image->format->palette->colors, 0,
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	230 image->format->palette->ncolors);
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	231 }
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	232
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	233 /* Blit onto the screen surface */
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	234 if(SDL_BlitSurface(image, NULL, screen, NULL) < 0)
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	235 fprintf(stderr, "BlitSurface error: %s\n", SDL_GetError());
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	236
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	237 SDL_UpdateRect(screen, 0, 0, image->w, image->h);
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	238
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	239 /* Free the allocated BMP surface */
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	240 SDL_FreeSurface(image);
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	241 }</PRE
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	242 ></DIV
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	243 ></DIV
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	244 ><DIV
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	245 CLASS="SECT2"
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	246 ><H2
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	247 CLASS="SECT2"
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	248 ><A
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	249 NAME="AEN86"
803 355632dca928 Updated SDL HTML documentation Sam Lantinga <slouken@libsdl.org> parents: 55 diff changeset	250 ></A
355632dca928 Updated SDL HTML documentation Sam Lantinga <slouken@libsdl.org> parents: 55 diff changeset	251 >Drawing Directly to the Display</H2
55 55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	252 ><P
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	253 >The following two functions can be used to get and set single
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	254 pixels of a surface. They are carefully written to work with any depth
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	255 currently supported by SDL. Remember to lock the surface before
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	256 calling them, and to unlock it before calling any other SDL
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	257 functions.</P
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	258 ><P
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	259 >To convert between pixel values and their red, green, blue
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	260 components, use SDL_GetRGB() and SDL_MapRGB().</P
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	261 ><DIV
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	262 CLASS="EXAMPLE"
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	263 ><A
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	264 NAME="AEN90"
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	265 ></A
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	266 ><P
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	267 ><B
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	268 >Example 2-4. getpixel()</B
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	269 ></P
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	270 ><PRE
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	271 CLASS="PROGRAMLISTING"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	272 >/*
55 55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	273 * Return the pixel value at (x, y)
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	274 * NOTE: The surface must be locked before calling this!
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	275 */
55 55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	276 Uint32 getpixel(SDL_Surface *surface, int x, int y)
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	277 {
55 55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	278 int bpp = surface->format->BytesPerPixel;
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	279 /* Here p is the address to the pixel we want to retrieve */
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	280 Uint8 p = (Uint8 )surface->pixels + y * surface->pitch + x * bpp;
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	281
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	282 switch(bpp) {
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	283 case 1:
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	284 return *p;
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	285
55 55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	286 case 2:
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	287 return (Uint16 )p;
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	288
55 55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	289 case 3:
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	290 if(SDL_BYTEORDER == SDL_BIG_ENDIAN)
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	291 return p[0] << 16 \| p[1] << 8 \| p[2];
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	292 else
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	293 return p[0] \| p[1] << 8 \| p[2] << 16;
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	294
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	295 case 4:
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	296 return (Uint32 )p;
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	297
55 55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	298 default:
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	299 return 0; /* shouldn't happen, but avoids warnings */
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	300 }
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	301 }</PRE
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	302 ></DIV
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	303 ><DIV
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	304 CLASS="EXAMPLE"
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	305 ><A
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	306 NAME="AEN93"
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	307 ></A
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	308 ><P
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	309 ><B
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	310 >Example 2-5. putpixel()</B
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	311 ></P
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	312 ><PRE
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	313 CLASS="PROGRAMLISTING"
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	314 >/*
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	315 * Set the pixel at (x, y) to the given value
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	316 * NOTE: The surface must be locked before calling this!
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	317 */
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	318 void putpixel(SDL_Surface *surface, int x, int y, Uint32 pixel)
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	319 {
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	320 int bpp = surface->format->BytesPerPixel;
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	321 /* Here p is the address to the pixel we want to set */
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	322 Uint8 p = (Uint8 )surface->pixels + y * surface->pitch + x * bpp;
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	323
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	324 switch(bpp) {
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	325 case 1:
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	326 *p = pixel;
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	327 break;
55 55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	328
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	329 case 2:
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	330 (Uint16 )p = pixel;
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	331 break;
55 55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	332
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	333 case 3:
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	334 if(SDL_BYTEORDER == SDL_BIG_ENDIAN) {
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	335 p[0] = (pixel >> 16) & 0xff;
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	336 p[1] = (pixel >> 8) & 0xff;
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	337 p[2] = pixel & 0xff;
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	338 } else {
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	339 p[0] = pixel & 0xff;
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	340 p[1] = (pixel >> 8) & 0xff;
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	341 p[2] = (pixel >> 16) & 0xff;
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	342 }
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	343 break;
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	344
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	345 case 4:
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	346 (Uint32 )p = pixel;
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	347 break;
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	348 }
55 55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	349 }</PRE
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	350 ></DIV
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	351 ><P
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	352 >The following code uses the putpixel() function above to set a
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	353 yellow pixel in the middle of the screen.</P
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	354 ><DIV
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	355 CLASS="EXAMPLE"
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	356 ><A
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	357 NAME="AEN97"
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	358 ></A
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	359 ><P
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	360 ><B
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	361 >Example 2-6. Using putpixel()</B
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	362 ></P
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	363 ><PRE
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	364 CLASS="PROGRAMLISTING"
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	365 > /* Code to set a yellow pixel at the center of the screen */
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	366
55 55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	367 int x, y;
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	368 Uint32 yellow;
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	369
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	370 /* Map the color yellow to this display (R=0xff, G=0xFF, B=0x00)
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	371 Note: If the display is palettized, you must set the palette first.
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	372 */
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	373 yellow = SDL_MapRGB(screen->format, 0xff, 0xff, 0x00);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	374
55 55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	375 x = screen->w / 2;
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	376 y = screen->h / 2;
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	377
55 55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	378 /* Lock the screen for direct access to the pixels */
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	379 if ( SDL_MUSTLOCK(screen) ) {
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	380 if ( SDL_LockSurface(screen) < 0 ) {
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	381 fprintf(stderr, "Can't lock screen: %s\n", SDL_GetError());
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	382 return;
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	383 }
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	384 }
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	385
55 55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	386 putpixel(screen, x, y, yellow);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	387
55 55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	388 if ( SDL_MUSTLOCK(screen) ) {
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	389 SDL_UnlockSurface(screen);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	390 }
55 55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	391 /* Update just the part of the display that we've changed */
55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	392 SDL_UpdateRect(screen, x, y, 1, 1);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	393
55 55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	394 return; </PRE
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	395 ></DIV
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	396 ></DIV
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	397 ></DIV
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	398 ></DIV
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	399 ><DIV
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	400 CLASS="NAVFOOTER"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	401 ><HR
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	402 ALIGN="LEFT"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	403 WIDTH="100%"><TABLE
803 355632dca928 Updated SDL HTML documentation Sam Lantinga <slouken@libsdl.org> parents: 55 diff changeset	404 SUMMARY="Footer navigation table"
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	405 WIDTH="100%"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	406 BORDER="0"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	407 CELLPADDING="0"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	408 CELLSPACING="0"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	409 ><TR
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	410 ><TD
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	411 WIDTH="33%"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	412 ALIGN="left"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	413 VALIGN="top"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	414 ><A
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	415 HREF="guidebasicsinit.html"
803 355632dca928 Updated SDL HTML documentation Sam Lantinga <slouken@libsdl.org> parents: 55 diff changeset	416 ACCESSKEY="P"
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	417 >Prev</A
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	418 ></TD
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	419 ><TD
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	420 WIDTH="34%"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	421 ALIGN="center"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	422 VALIGN="top"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	423 ><A
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	424 HREF="index.html"
803 355632dca928 Updated SDL HTML documentation Sam Lantinga <slouken@libsdl.org> parents: 55 diff changeset	425 ACCESSKEY="H"
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	426 >Home</A
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	427 ></TD
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	428 ><TD
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	429 WIDTH="33%"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	430 ALIGN="right"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	431 VALIGN="top"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	432 ><A
55 55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	433 HREF="guidevideoopengl.html"
803 355632dca928 Updated SDL HTML documentation Sam Lantinga <slouken@libsdl.org> parents: 55 diff changeset	434 ACCESSKEY="N"
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	435 >Next</A
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	436 ></TD
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	437 ></TR
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	438 ><TR
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	439 ><TD
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	440 WIDTH="33%"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	441 ALIGN="left"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	442 VALIGN="top"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	443 >Initializing SDL</TD
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	444 ><TD
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	445 WIDTH="34%"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	446 ALIGN="center"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	447 VALIGN="top"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	448 ><A
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	449 HREF="guide.html"
803 355632dca928 Updated SDL HTML documentation Sam Lantinga <slouken@libsdl.org> parents: 55 diff changeset	450 ACCESSKEY="U"
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	451 >Up</A
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	452 ></TD
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	453 ><TD
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	454 WIDTH="33%"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	455 ALIGN="right"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	456 VALIGN="top"
55 55f1f1b3e27d Added new docs for SDL 1.2.1 Sam Lantinga <slouken@lokigames.com> parents: 0 diff changeset	457 >Using OpenGL With SDL</TD
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	458 ></TR
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	459 ></TABLE
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	460 ></DIV
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	461 ></BODY
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	462 ></HTML
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	463 >

Mercurial > sdl-ios-xcode

annotate docs/html/guidevideo.html @ 2860:6ce28e5287e9