Changeset 32911 in project


Ignore:
Timestamp:
11/15/15 22:34:25 (5 years ago)
Author:
John Croisant
Message:

Summary: sdl2: More work on docs.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • wiki/eggref/4/sdl2

    r32910 r32911  
    802802
    803803<procedure>(map-rgb pixel-format r g b) → fixnum</procedure>
    804 
    805 See [[https://wiki.libsdl.org/SDL_MapRGB|SDL_MapRGB]].
    806 
    807 
    808804<procedure>(map-rgba pixel-format r g b a) → fixnum</procedure>
    809805
    810 See [[https://wiki.libsdl.org/SDL_MapRGBA|SDL_MapRGBA]].
     806See [[https://wiki.libsdl.org/SDL_MapRGB|SDL_MapRGB]]
     807and [[https://wiki.libsdl.org/SDL_MapRGBA|SDL_MapRGBA]].
    811808
    812809
    813810<procedure>(get-rgb pixel pixel-format) → [r g b]</procedure>
    814 
    815 See [[https://wiki.libsdl.org/SDL_GetRGB|SDL_GetRGB]].
    816 
    817 This procedure returns multiple values.
    818 
    819 
    820811<procedure>(get-rgba pixel pixel-format) → [r g b a]</procedure>
    821812
    822 See [[https://wiki.libsdl.org/SDL_GetRGBA|SDL_GetRGBA]].
    823 
    824 This procedure returns multiple values.
    825 
     813See [[https://wiki.libsdl.org/SDL_GetRGB|SDL_GetRGB]]
     814and [[https://wiki.libsdl.org/SDL_GetRGBA|SDL_GetRGBA]].
     815
     816These procedures return multiple values.
    826817
    827818
     
    994985==== Surface
    995986
    996 <procedure>(create-rgb-surface flags width height depth rmask gmask bmask amask) → sdl2:surface</procedure>
     987<procedure>(create-rgb-surface* flags width height depth rmask gmask bmask amask) → sdl2:surface</procedure>
    997988
    998989See [[https://wiki.libsdl.org/SDL_CreateRGBSurface|SDL_CreateRGBSurface]].
     
    1004995
    1005996
    1006 <procedure>(create-rgb-surface-from pixels width height depth pitch rmask gmask bmask amask) → sdl2:surface</procedure>
     997<procedure>(create-rgb-surface-from* pixels width height depth pitch rmask gmask bmask amask) → sdl2:surface</procedure>
     998
     999Returns a new '''unmanaged''' sdl2:surface with the given properties,
     1000using existing pixel data (a pointer, e.g. from {{surface-pixels-raw}}).
     1001You must call {{free-surface!}} when you are done with it.
    10071002
    10081003See [[https://wiki.libsdl.org/SDL_CreateRGBSurfaceFrom|SDL_CreateRGBSurfaceFrom]].
    1009 
    1010 Returns a new '''unmanaged''' sdl2:surface with the given properties,
    1011 using existing pixel data (a pointer). You must call {{free-surface!}}
    1012 when you are done with it.
    10131004
    10141005
     
    10801071
    10811072<procedure>(lock-surface! surface) → fixnum</procedure>
    1082 
    1083 See [[https://wiki.libsdl.org/SDL_LockSurface|SDL_LockSurface]].
    1084 
    1085 Returns zero if successful.
    1086 
    1087 
    10881073<procedure>(unlock-surface! surface)</procedure>
    10891074
    1090 See [[https://wiki.libsdl.org/SDL_UnlockSurface|SDL_UnlockSurface]].
     1075See [[https://wiki.libsdl.org/SDL_LockSurface|SDL_LockSurface]]
     1076and [[https://wiki.libsdl.org/SDL_UnlockSurface|SDL_UnlockSurface]].
     1077
     1078{{lock-surface!}} returns zero if successful.
    10911079
    10921080
     
    11951183
    11961184<procedure>(surface-blend-mode surface) → symbol</procedure>
     1185<procedure>(surface-blend-mode-raw surface) → fixnum</procedure>
    11971186<setter>(set! (surface-blend-mode surface) mode) → fixnum</setter>
    11981187<setter>(surface-blend-mode-set! surface mode) → fixnum</setter>
     
    12011190and [[https://wiki.libsdl.org/SDL_SetSurfaceBlendMode|SDL_SetSurfaceBlendMode]].
    12021191
    1203 {{surface-blend-mode}} returns a [[https://gitlab.com/chicken-sdl2/chicken-sdl2/blob/master/docs/enums.md#blend-mode|blend mode symbol]]:
    1204 
    1205 * {{'none}}
    1206 * {{'blend}}
    1207 * {{'add}}
    1208 * {{'mod}}
    1209 
    1210 The setters accept either a symbol or integer.
    1211 The setters return zero if successful.
     1192* {{surface-blend-mode}} returns a [[https://gitlab.com/chicken-sdl2/chicken-sdl2/blob/master/docs/enums.md#blend-mode|blend mode symbol]]:
     1193** {{'none}}
     1194** {{'blend}}
     1195** {{'add}}
     1196** {{'mod}}
     1197* {{surface-blend-mode-raw}} returns an integer.
     1198* The setters accept either a symbol or integer.
     1199  The setters return zero if successful.
    12121200
    12131201
     
    14491437
    14501438
    1451 <procedure>(window-grab window) → boolean</procedure>
    1452 <setter>(set! (window-grab window) grab?)</setter>
     1439<procedure>(window-grab? window) → boolean</procedure>
     1440<setter>(set! (window-grab? window) grab?)</setter>
    14531441<setter>(window-grab-set! window grab?)</setter>
    14541442
     
    20262014    <td>[[#sdl2controller-axis-event|sdl2:controller-axis-event]]</td>
    20272015    <td>[[https://wiki.libsdl.org/SDL_ControllerAxisEvent|SDL_ControllerAxisEvent]]</td>
    2028     <td>controller-axis-motion</td>
     2016    <td>{{'controller-axis-motion}}</td>
    20292017  </tr>
    20302018  <tr>
    20312019    <td>[[#sdl2controller-button-event|sdl2:controller-button-event]]</td>
    20322020    <td>[[https://wiki.libsdl.org/SDL_ControllerButtonEvent|SDL_ControllerButtonEvent]]</td>
    2033     <td>controller-button-down<br>
    2034         controller-button-up</td>
     2021    <td>{{'controller-button-down}}<br>
     2022        {{'controller-button-up}}</td>
    20352023  </tr>
    20362024  <tr>
    20372025    <td>[[#sdl2controller-device-event|sdl2:controller-device-event]]</td>
    20382026    <td>[[https://wiki.libsdl.org/SDL_ControllerDeviceEvent|SDL_ControllerDeviceEvent]]</td>
    2039     <td>controller-device-added<br>
    2040         controller-device-removed<br>
    2041         controller-device-remapped</td>
     2027    <td>{{'controller-device-added}}<br>
     2028        {{'controller-device-removed}}<br>
     2029        {{'controller-device-remapped}}</td>
    20422030  </tr>
    20432031  <tr>
    20442032    <td>[[#sdl2dollar-gesture-event|sdl2:dollar-gesture-event]]</td>
    20452033    <td>[[https://wiki.libsdl.org/SDL_DollarGestureEvent|SDL_DollarGestureEvent]]</td>
    2046     <td>dollar-gesture<br>
    2047         dollar-record</td>
     2034    <td>{{'dollar-gesture}}<br>
     2035        {{'dollar-record}}</td>
    20482036  </tr>
    20492037  <tr>
    20502038    <td>[[#sdl2drop-event|sdl2:drop-event]]</td>
    20512039    <td>[[https://wiki.libsdl.org/SDL_DropEvent|SDL_DropEvent]]</td>
    2052     <td>drop-file</td>
     2040    <td>{{'drop-file}}</td>
    20532041  </tr>
    20542042  <tr>
    20552043    <td>[[#sdl2joy-axis-event|sdl2:joy-axis-event]]</td>
    20562044    <td>[[https://wiki.libsdl.org/SDL_JoyAxisEvent|SDL_JoyAxisEvent]]</td>
    2057     <td>joy-axis-motion</td>
     2045    <td>{{'joy-axis-motion}}</td>
    20582046  </tr>
    20592047  <tr>
    20602048    <td>[[#sdl2joy-ball-event|sdl2:joy-ball-event]]</td>
    20612049    <td>[[https://wiki.libsdl.org/SDL_JoyBallEvent|SDL_JoyBallEvent]]</td>
    2062     <td>joy-ball-motion</td>
     2050    <td>{{'joy-ball-motion}}</td>
    20632051  </tr>
    20642052  <tr>
    20652053    <td>[[#sdl2joy-button-event|sdl2:joy-button-event]]</td>
    20662054    <td>[[https://wiki.libsdl.org/SDL_JoyButtonEvent|SDL_JoyButtonEvent]]</td>
    2067     <td>joy-button-down<br>
    2068         joy-button-up</td>
     2055    <td>{{'joy-button-down}}<br>
     2056        {{'joy-button-up}}</td>
    20692057  </tr>
    20702058  <tr>
    20712059    <td>[[#sdl2joy-device-event|sdl2:joy-device-event]]</td>
    20722060    <td>[[https://wiki.libsdl.org/SDL_JoyDeviceEvent|SDL_JoyDeviceEvent]]</td>
    2073     <td>joy-device-added<br>
    2074         joy-device-removed</td>
     2061    <td>{{'joy-device-added}}<br>
     2062        {{'joy-device-removed}}</td>
    20752063  </tr>
    20762064  <tr>
    20772065    <td>[[#sdl2joy-hat-event|sdl2:joy-hat-event]]</td>
    20782066    <td>[[https://wiki.libsdl.org/SDL_JoyHatEvent|SDL_JoyHatEvent]]</td>
    2079     <td>joy-hat-motion</td>
     2067    <td>{{'joy-hat-motion}}</td>
    20802068  </tr>
    20812069  <tr>
    20822070    <td>[[#sdl2keyboard-event|sdl2:keyboard-event]]</td>
    20832071    <td>[[https://wiki.libsdl.org/SDL_KeyboardEvent|SDL_KeyboardEvent]]</td>
    2084     <td>key-down<br>
    2085         key-up</td>
     2072    <td>{{'key-down}}<br>
     2073        {{'key-up}}</td>
    20862074  </tr>
    20872075  <tr>
    20882076    <td>[[#sdl2mouse-button-event|sdl2:mouse-button-event]]</td>
    20892077    <td>[[https://wiki.libsdl.org/SDL_MouseButtonEvent|SDL_MouseButtonEvent]]</td>
    2090     <td>mouse-button-down<br>
    2091         mouse-button-up</td>
     2078    <td>{{'mouse-button-down}}<br>
     2079        {{'mouse-button-up}}</td>
    20922080  </tr>
    20932081  <tr>
    20942082    <td>[[#sdl2mouse-motion-event|sdl2:mouse-motion-event]]</td>
    20952083    <td>[[https://wiki.libsdl.org/SDL_MouseMotionEvent|SDL_MouseMotionEvent]]</td>
    2096     <td>mouse-motion</td>
     2084    <td>{{'mouse-motion}}</td>
    20972085  </tr>
    20982086  <tr>
    20992087    <td>[[#sdl2mouse-wheel-event|sdl2:mouse-wheel-event]]</td>
    21002088    <td>[[https://wiki.libsdl.org/SDL_MouseWheelEvent|SDL_MouseWheelEvent]]</td>
    2101     <td>mouse-wheel</td>
     2089    <td>{{'mouse-wheel}}</td>
    21022090  </tr>
    21032091  <tr>
    21042092    <td>[[#sdl2multi-gesture-event|sdl2:multi-gesture-event]]</td>
    21052093    <td>[[https://wiki.libsdl.org/SDL_MultiGestureEvent|SDL_MultiGestureEvent]]</td>
    2106     <td>multi-gesture</td>
     2094    <td>{{'multi-gesture}}</td>
    21072095  </tr>
    21082096  <tr>
    21092097    <td>[[#sdl2quit-event|sdl2:quit-event]]</td>
    21102098    <td>[[https://wiki.libsdl.org/SDL_QuitEvent|SDL_QuitEvent]]</td>
    2111     <td>quit</td>
     2099    <td>{{'quit}}</td>
    21122100  </tr>
    21132101  <tr>
    21142102    <td>[[#sdl2sys-wm-event|sdl2:sys-wm-event]]</td>
    21152103    <td>[[https://wiki.libsdl.org/SDL_SysWMEvent|SDL_SysWMEvent]]</td>
    2116     <td>sys-wm</td>
     2104    <td>{{'sys-wm}}</td>
    21172105  </tr>
    21182106  <tr>
    21192107    <td>[[#sdl2text-editing-event|sdl2:text-editing-event]]</td>
    21202108    <td>[[https://wiki.libsdl.org/SDL_TextEditingEvent|SDL_TextEditingEvent]]</td>
    2121     <td>text-editing</td>
     2109    <td>{{'text-editing}}</td>
    21222110  </tr>
    21232111  <tr>
    21242112    <td>[[#sdl2text-input-event|sdl2:text-input-event]]</td>
    21252113    <td>[[https://wiki.libsdl.org/SDL_TextInputEvent|SDL_TextInputEvent]]</td>
    2126     <td>text-input</td>
     2114    <td>{{'text-input}}</td>
    21272115  </tr>
    21282116  <tr>
    21292117    <td>[[#sdl2touch-finger-event|sdl2:touch-finger-event]]</td>
    21302118    <td>[[https://wiki.libsdl.org/SDL_TouchFingerEvent|SDL_TouchFingerEvent]]</td>
    2131     <td>finger-down<br>
    2132         finger-up<br>
    2133         finger-motion</td>
     2119    <td>{{'finger-down}}<br>
     2120        {{'finger-up}}<br>
     2121        {{'finger-motion}}</td>
    21342122  </tr>
    21352123  <tr>
    21362124    <td>[[#sdl2user-event|sdl2:user-event]]</td>
    21372125    <td>[[https://wiki.libsdl.org/SDL_UserEvent|SDL_UserEvent]]</td>
    2138     <td>Call {{register-events!}} to register your own custom event type symbols</td>
     2126    <td>(Call {{register-events!}} to register your own user event type symbols.)</td>
    21392127  </tr>
    21402128  <tr>
    21412129    <td>[[#sdl2window-event|sdl2:window-event]]</td>
    21422130    <td>[[https://wiki.libsdl.org/SDL_WindowEvent|SDL_WindowEvent]]</td>
    2143     <td>window</td>
     2131    <td>{{'window}}</td>
    21442132  </tr>
    21452133</table>
     
    22012189[[https://wiki.libsdl.org/SDL_ControllerAxisEvent|SDL_ControllerAxisEvent]].
    22022190
     2191This event variant occurs when an axis on a controller moves.
     2192There may be more than one controller, and each controller may have more than one axis.
     2193You can distinguish them using the {{which}} and {{axis}} fields.
     2194
     2195sdl2:controller-axis-event has the following event type symbols:
     2196
     2197; {{'controller-axis-motion}} : An axis on a controller moved.
     2198
    22032199
    22042200<procedure>(controller-axis-event? obj) → boolean</procedure>
     
    22352231[[https://wiki.libsdl.org/SDL_ControllerButtonEvent|SDL_ControllerButtonEvent]].
    22362232
     2233This event variant occurs when a button on a controller is pressed or released.
     2234There may be more than one controller, and each controller may have more than one button.
     2235You can distinguish them using the {{which}} and {{button}} fields.
     2236
     2237sdl2:controller-button-event has the following event type symbols:
     2238
     2239; {{'controller-button-down}} : A button on a controller was pressed.
     2240; {{'controller-button-up}} : A button on a controller was released.
    22372241
    22382242<procedure>(controller-button-event? obj) → boolean</procedure>
     
    22702274[[https://wiki.libsdl.org/SDL_ControllerDeviceEvent|SDL_ControllerDeviceEvent]].
    22712275
     2276This event variant occurs when a controller is added, removed, or remapped.
     2277There may be more than one controller.
     2278You can distinguish them using the {{which}}.
     2279
     2280sdl2:controller-device-event has the following event type symbols:
     2281
     2282; {{'controller-device-added}} : A controller device was added.
     2283; {{'controller-device-removed}} : A controller device was removed.
     2284; {{'controller-device-remapped}} : A controller device was remapped.
    22722285
    22732286<procedure>(controller-device-event? obj) → boolean</procedure>
     
    22892302[[https://wiki.libsdl.org/SDL_DollarGestureEvent|SDL_DollarGestureEvent]].
    22902303
     2304This event variant occurs when a [[http://depts.washington.edu/aimgroup/proj/dollar/index.html|"$1 unistroke" gesture]] is performed or recorded.
     2305
     2306sdl2:dollar-gesture-event has the following event type symbols:
     2307
     2308; {{'dollar-gesture}} : A dollar gesture was performed.
     2309; {{'dollar-record}} : A dollar gesture was recorded.
     2310
    22912311
    22922312<procedure>(dollar-gesture-event? obj) → boolean</procedure>
     
    23432363[[https://wiki.libsdl.org/SDL_DropEvent|SDL_DropEvent]].
    23442364
     2365This event variant occurs when the user requests that the program open a file,
     2366e.g. by dragging and dropping a file icon onto the program.
     2367
     2368sdl2:drop-event has the following event type symbols:
     2369
     2370; {{'drop-file}} : The user requested that a file be opened.
     2371
    23452372
    23462373<procedure>(drop-event? obj) → boolean</procedure>
     
    23532380<setter>(drop-event-file-set! event val)</setter>
    23542381
    2355 Get or set the event's "file" field, as a string indicating the path to a file that was dropped onto the application.
     2382Get or set the event's "file" field, as a string indicating the path to a file that the user requested to be opened.
    23562383
    23572384
     
    23612388sdl2:joy-axis-event is a variant of sdl2:event that wraps a pointer to an
    23622389[[https://wiki.libsdl.org/SDL_JoyAxisEvent|SDL_JoyAxisEvent]].
     2390
     2391This event variant occurs when an axis on a joystick moves.
     2392There may be more than one joystick, and each joystick may have more than one axis.
     2393You can distinguish them using the {{which}} and {{axis}} fields.
     2394
     2395sdl2:joy-axis-event has the following event type symbols:
     2396
     2397; {{'joy-axis-motion}} : An axis on a joystick moved.
    23632398
    23642399
     
    23962431[[https://wiki.libsdl.org/SDL_JoyBallEvent|SDL_JoyBallEvent]].
    23972432
     2433This event variant occurs when a trackball on a joystick moves.
     2434There may be more than one joystick, and each joystick may have more than one trackball.
     2435You can distinguish them using the {{which}} and {{ball}} fields.
     2436
     2437sdl2:joy-ball-event has the following event type symbols:
     2438
     2439; {{'joy-ball-motion}} : A trackball on a joystick moved.
     2440
    23982441
    23992442<procedure>(joy-ball-event? obj) → boolean</procedure>
     
    24362479[[https://wiki.libsdl.org/SDL_JoyButtonEvent|SDL_JoyButtonEvent]].
    24372480
     2481This event variant occurs when a button on a joystick is pressed or released.
     2482There may be more than one joystick, and each joystick may have more than one button.
     2483You can distinguish them using the {{which}} and {{button}} fields.
     2484
     2485sdl2:joy-button-event has the following event type symbols:
     2486
     2487; {{'joy-button-down}} : A button on a joystick was pressed.
     2488; {{'joy-button-up}} : A button on a joystick was released.
     2489
    24382490
    24392491<procedure>(joy-button-event? obj) → boolean</procedure>
     
    24712523[[https://wiki.libsdl.org/SDL_JoyDeviceEvent|SDL_JoyDeviceEvent]].
    24722524
     2525This event variant occurs when a joystick device is added or removed.
     2526There may be more than one joystick.
     2527You can distinguish them using the {{which}} field.
     2528
     2529sdl2:joy-device-event has the following event type symbols:
     2530
     2531; {{'joy-device-added}} : A joystick device was added.
     2532; {{'joy-device-removed}} : A joystick device was removed.
     2533
    24732534
    24742535<procedure>(joy-device-event? obj) → boolean</procedure>
     
    24892550sdl2:joy-hat-event is a variant of sdl2:event that wraps a pointer to an
    24902551[[https://wiki.libsdl.org/SDL_JoyHatEvent|SDL_JoyHatEvent]].
     2552
     2553This event variant occurs when an 8-directional hat switch on a joystick moves.
     2554There may be more than one joystick, and each joystick may have more than one hat switch.
     2555You can distinguish them using the {{which}} and {{hat}} fields.
     2556
     2557sdl2:joy-hat-event has the following event type symbols:
     2558
     2559; {{'joy-hat-motion}} : A hat switch on a joystick moved.
    24912560
    24922561
     
    25282597[[https://wiki.libsdl.org/SDL_KeyboardEvent|SDL_KeyboardEvent]].
    25292598
     2599This event variant occurs when a keyboard key is pressed or released.
     2600
     2601sdl2:keyboard-event has the following event type symbols:
     2602
     2603; {{'key-down}} : A keyboard key was pressed.
     2604; {{'key-up}} : A keyboard key was released.
     2605
    25302606
    25312607<procedure>(keyboard-event? obj) → boolean</procedure>
     
    26172693sdl2:mouse-button-event is a variant of sdl2:event that wraps a pointer to an
    26182694[[https://wiki.libsdl.org/SDL_MouseButtonEvent|SDL_MouseButtonEvent]].
     2695
     2696This event variant occurs when a mouse button was pressed or released.
     2697
     2698sdl2:mouse-button-event has the following event type symbols:
     2699
     2700; {{'mouse-button-down}} : A mouse button was pressed.
     2701; {{'mouse-button-up}} : A mouse button was released.
    26192702
    26202703
     
    26832766[[https://wiki.libsdl.org/SDL_MouseMotionEvent|SDL_MouseMotionEvent]].
    26842767
     2768This event variant occurs when the mouse cursor moves.
     2769
     2770sdl2:mouse-motion-event has the following event type symbols:
     2771
     2772; {{'mouse-motion}} : The mouse cursor moved.
     2773
    26852774
    26862775<procedure>(mouse-motion-event? obj) → boolean</procedure>
     
    27542843[[https://wiki.libsdl.org/SDL_MouseWheelEvent|SDL_MouseWheelEvent]].
    27552844
     2845This event variant occurs when a mouse wheel moves.
     2846
     2847sdl2:mouse-wheel-event has the following event type symbols:
     2848
     2849; {{'mouse-wheel}} : A mouse wheel moved.
     2850
    27562851
    27572852<procedure>(mouse-wheel-event? obj) → boolean</procedure>
     
    27962891[[https://wiki.libsdl.org/SDL_MultiGestureEvent|SDL_MultiGestureEvent]].
    27972892
     2893This event variant occurs when a multi-finger gesture is performed on a touch device.
     2894This is useful for recognizing common gestures that involve multiple fingers, e.g. pinching or rotating.
     2895
     2896sdl2:multi-gesture-event has the following event type symbols:
     2897
     2898; {{'multi-gesture}} : A multi-finger gesture was performed.
     2899
    27982900
    27992901<procedure>(multi-gesture-event? obj) → boolean</procedure>
     
    28502952[[https://wiki.libsdl.org/SDL_QuitEvent|SDL_QuitEvent]].
    28512953
     2954This event variant occurs when the user requests to quit the program.
     2955There are [[https://wiki.libsdl.org/SDL_EventType#SDL_QUIT|various ways this might happen]], depending on the platform.
     2956
     2957sdl2:quit-event has the following event type symbols:
     2958
     2959; {{'quit}} : The user requested to quit the program.
     2960
    28522961
    28532962<procedure>(quit-event? obj) → boolean</procedure>
     
    28612970sdl2:sys-wm-event is a variant of sdl2:event that wraps a pointer to an
    28622971[[https://wiki.libsdl.org/SDL_SysWMEvent|SDL_SysWMEvent]].
    2863 This event is for very advanced use cases. Most people can ignore it.
     2972
     2973This event variant is for very advanced use cases. Most people can ignore it.
     2974
     2975sdl2:sys-wm-event has the following event type symbols:
     2976
     2977; {{'sys-wm}} : A platform-specific event occurred.
    28642978
    28652979
     
    28832997[[https://wiki.libsdl.org/SDL_TextEditingEvent|SDL_TextEditingEvent]].
    28842998
     2999This event occurs when a user is editing (composing) text, e.g. using an Input Method Editor (IME).
     3000See the [[https://wiki.libsdl.org/Tutorials/TextInput|Text Input tutorial for SDL]].
     3001
     3002sdl2:text-editing-event has the following event type symbols:
     3003
     3004; {{'text-editing}} : The user editted some text being composed.
     3005
    28853006
    28863007<procedure>(text-editing-event? obj) → boolean</procedure>
     
    29233044[[https://wiki.libsdl.org/SDL_TextInputEvent|SDL_TextInputEvent]].
    29243045
     3046This event occurs when the users enters some text, possibly using an Input Metod Editor (IME).
     3047See the [[https://wiki.libsdl.org/Tutorials/TextInput|Text Input tutorial for SDL]].
     3048
     3049sdl2:text-input-event has the following event type symbols:
     3050
     3051; {{'text-input}} : The use inputted some text.
     3052
    29253053
    29263054<procedure>(text-input-event? obj) → boolean</procedure>
     
    29403068<setter>(text-input-event-text-set! event val)</setter>
    29413069
    2942 Get or set the event's {{text}} event, as a UTF8 string up to 32 bytes long (including the null byte), holding the text that was inputted.
     3070Get or set the event's {{text}} event, as a UTF8 string up to 32 bytes long (including the ending null byte), holding the text that was inputted.
    29433071
    29443072
     
    29483076sdl2:touch-finger-event is a variant of sdl2:event that wraps a pointer to an
    29493077[[https://wiki.libsdl.org/SDL_TouchFingerEvent|SDL_TouchFingerEvent]].
     3078
     3079This event variant occurs when the user presses, lifts, or moves a finger (or stylus, etc.) on a supported touch device,
     3080e.g. the touch screen of a mobile phone or tablet device, or certain laptop trackpads.
     3081There may be more than one finger touching at the same time;
     3082you can distinguish the fingers by the {{finger-id}} number.
     3083
     3084sdl2:touch-finger-event has the following event type symbols:
     3085
     3086; {{'finger-down}} : A finger started touching a touch device (i.e. was pressed down).
     3087; {{'finger-up}} : A finger stopped touching a touch device (i.e. was lifted up).
     3088; {{'finger-motion}} : A finger moved while touching a touch device.
    29503089
    29513090
     
    30103149[[https://wiki.libsdl.org/SDL_UserEvent|SDL_UserEvent]].
    30113150
    3012 Call {{register-events!}} to register your own custom event type
    3013 symbols.
     3151This event variant does not occur normally.
     3152Instead, you can make instances of this event variant and push them to the event queue using {{push-event!}}.
     3153The meaning of this event variant is entirely up for you to decide.
     3154For example, you can use it to create custom event types related to your gameplay.
     3155
     3156sdl2:user-event does not have any event type symbols by default.
     3157Call {{register-events!}} to register your own custom event type symbols for sdl2:user-event.
    30143158
    30153159
     
    30653209sdl2:window-event is a variant of sdl2:event that wraps a pointer to an
    30663210[[https://wiki.libsdl.org/SDL_WindowEvent|SDL_WindowEvent]].
     3211
     3212This event variant occurs when various changes occur to a window,
     3213e.g. when a window is moved, resized, minimized, closed, etc.
     3214
     3215sdl2:window-event has the following event type symbols:
     3216
     3217; {{'window}} : A window-related event occurred.
    30673218
    30683219
Note: See TracChangeset for help on using the changeset viewer.