1SDL(3) User Contributed Perl Documentation SDL(3)
2
6 SDL_perl - Simple DirectMedia Layer for Perl
7
9 use SDL;
10
12 SDL_perl is a package of perl modules that provides both functional and
13 object orient interfaces to the Simple DirectMedia Layer for Perl 5.
14 This package does take some liberties with the SDL API, and attempts to
15 adhere to the spirit of both the SDL and Perl. This document describes
16 the low-level functional SDL_perl API. For the object oriented pro‐
17 gramming interface please see the documentation provided on a per class
18 basis.
19 Init(flags)
21 As with the C language API, SDL_perl initializes the SDL environment
23 through the "SDL::Init" subroutine. This routine takes a mode flag
24 constructed through the bitwise OR product of the following functions:
25 * INIT_VIDEO()
27 * INIT_CDROM()
28 * INIT_EVERYTHING()
29 * INIT_NOPARACHUTE()
30 * INIT_JOYSTICK()
31 * INIT_TIMER()
32 "SDL::Init" returns 0 on success, or -1 on error.
34 GetError()
36 The last error message set by the SDL library can be retrieved using
38 the subroutine "SDL::GetError", which returns a scalar containing the
39 text of the message if any.
40 Delay(ms)
42 This subroutine allows an application to delay further operations for
44 atleast a number of milliseconds provided as the argument. The actual
45 delay may be longer than the specified depending on the underlying OS.
46 GetTicks()
48 An application may retrieve the number of milliseconds expired since
50 the initilization of the application through this subroutine. This
51 value resets rougly ever 49 days.
52 AddTimer(interval,callback,param)
54 "AddTimer" will register a SDL_NewTimerCallback function to be executed
56 after "interval" milliseconds, with parameter "param". SDL_NewTimer‐
57 Callback objects can be constructed with the "NewTimer" subroutine.
58 "SDL::PerlTimerCallback" will return a valid callback for executing a
59 perl subroutine or closure. This subroutine returns a SDL_TimerID for
60 the newly registered callback, or NULL on error.
61 NewTimer(interval,subroutine)
63 The "NewTimer" takes an interval in milliseconds and a reference to a
65 subroutine to call at that interval. The subroutine will be invoked in
66 a void context and accepts no parameters. The callback used is that
67 returned by "SDL::PerlTimerCallback". "NewTimer" returns the
68 SDL_TimerID for the new timer or NULL on error.
69 RemoveTimer(id)
71 This subroutine taks a SDL_TimerID and removes it from the list of
73 active callbacks. RemoveTimer returns false on failure.
74 SetTimer
76 This subroutine is depreciated, please use "NewTimer" or "AddTimer"
78 instead.
79 CDNumDrives()
81 "SDL::CDNumDrives" returns the number of available CD-ROM drives in the
83 system.
84 CDName(drive)
86 The subroutine "SDL::CDName" returns the system specific human readable
88 device name for the given CD-ROM drive.
89 CDOpen(drive)
91 This subroutine opens a CD-ROM drive for access, returning NULL if the
93 drive is busy or otherwise unavailable. On success this subroutine
94 returns a handle to the CD-ROM drive.
95 CDTrackListing(cd)
97 "SDL::CDTrackListing" returns a human readable description of a CD-ROM.
99 For each track one line will be produced with the following format:
100 Track index: %d, id %d, %2d.%2d
102 This is provided to ease the creation of human readable descriptions
104 and debugging.
105 CDTrackId(track)
107 "CDTrackId" returns the id field of the given SDL_CDtrack structure.
109 CDTrackType(track)
111 "CDTrackType" returns the type field of the given SDL_CDtrack struc‐
113 ture.
114 CDTrackLength(track)
116 "CDTrackLength" returns the length field of the given SDL_CDtrack
118 structure.
119 CDTrackOffset(track)
121 "CDTrackOffset" returns the offset field of the given SDL_CDtrack
123 structure.
124 CDStatus(cd)
126 The function "CDStatus" returns the current status of the given
128 SDL_CDrom. "CDStatus"'s return values are:
129 * CD_TRAYEMPTY
131 * CD_PLAYING
132 * CD_STOPPED
133 * CD_PAUSED
134 * CD_ERROR
135 CDPlayTracks(cd,track,tracks,frame,frames)
137 To start playing from an arbitrary portion of a CD, one can provide
139 "SDL::CDPlayTracks" with a CD, a starting track, the number of tracks,
140 a starting frame, and the number of frames to be played.
141 CDPlay(cd,track,length)
143 "SDL::CDPlay" plays the next "length" tracks starting from "track"
145 CDPause(cd)
147 This function will pause CD playback until resume is called.
149 CDResume(cd)
151 This function will resume CD playback if paused.
153 CDStop(cd)
155 "SDL::CDStop" will stop CD playback if playing.
157 CDEject(cd)
159 This function will eject the CD
161 CDClose(cd)
163 This function will release an opened CD.
165 CDNumTracks
167 CDCurTrack
169 CDCurFrame
171 CDTrack
173 PumpEvents
175 NewEvent
177 FreeEvent
179 PollEvent
181 WaitEvent
183 EventState
185 IGNORE
187 ENABLE
189 QUERY
191 ACTIVEEVENT
193 KEYDOWN
195 KEYUP
197 MOUSEMOTION
199 MOUSEBUTTONDOWN
201 MOUSEBUTTONUP
203 QUIT
205 SYSWMEVENT
207 EventType
209 ActiveEventGain
211 ActiveEventState
213 APPMOUSEFOCUS
215 APPINPUTFOCUS
217 APPACTIVE
219 KeyEventState
221 SDLK_BACKSPACE
223 SDLK_TAB
225 SDLK_CLEAR
227 SDLK_RETURN
229 SDLK_PAUSE
231 SDLK_ESCAPE
233 SDLK_SPACE
235 SDLK_EXCLAIM
237 SDLK_QUOTEDBL
239 SDLK_HASH
241 SDLK_DOLLAR
243 SDLK_AMPERSAND
245 SDLK_QUOTE
247 SDLK_LEFTPAREN
249 SDLK_RIGHTPAREN
251 SDLK_ASTERISK
253 SDLK_PLUS
255 SDLK_COMMA
257 SDLK_MINUS
259 SDLK_PERIOD
261 SDLK_SLASH
263 SDLK_0
265 SDLK_1
267 SDLK_2
269 SDLK_3
271 SDLK_4
273 SDLK_5
275 SDLK_6
277 SDLK_7
279 SDLK_8
281 SDLK_9
283 SDLK_COLON
285 SDLK_SEMICOLON
287 SDLK_LESS
289 SDLK_EQUALS
291 SDLK_GREATER
293 SDLK_QUESTION
295 SDLK_AT
297 SDLK_LEFTBRACKET
299 SDLK_BACKSLASH
301 SDLK_RIGHTBRACKET
303 SDLK_CARET
305 SDLK_UNDERSCORE
307 SDLK_BACKQUOTE
309 SDLK_a
311 SDLK_b
313 SDLK_c
315 SDLK_d
317 SDLK_e
319 SDLK_f
321 SDLK_g
323 SDLK_h
325 SDLK_i
327 SDLK_j
329 SDLK_k
331 SDLK_l
333 SDLK_m
335 SDLK_n
337 SDLK_o
339 SDLK_p
341 SDLK_q
343 SDLK_r
345 SDLK_s
347 SDLK_t
349 SDLK_u
351 SDLK_v
353 SDLK_w
355 SDLK_x
357 SDLK_y
359 SDLK_z
361 SDLK_DELETE
363 SDLK_KP0
365 SDLK_KP1
367 SDLK_KP2
369 SDLK_KP3
371 SDLK_KP4
373 SDLK_KP5
375 SDLK_KP6
377 SDLK_KP7
379 SDLK_KP8
381 SDLK_KP9
383 SDLK_KP_PERIOD
385 SDLK_KP_DIVIDE
387 SDLK_KP_MULTIPLY
389 SDLK_KP_MINUS
391 SDLK_KP_PLUS
393 SDLK_KP_ENTER
395 SDLK_KP_EQUALS
397 SDLK_UP
399 SDLK_DOWN
401 SDLK_RIGHT
403 SDLK_LEFT
405 SDLK_INSERT
407 SDLK_HOME
409 SDLK_END
411 SDLK_PAGEUP
413 SDLK_PAGEDOWN
415 SDLK_F1
417 SDLK_F2
419 SDLK_F3
421 SDLK_F4
423 SDLK_F5
425 SDLK_F6
427 SDLK_F7
429 SDLK_F8
431 SDLK_F9
433 SDLK_F10
435 SDLK_F11
437 SDLK_F12
439 SDLK_F13
441 SDLK_F14
443 SDLK_F15
445 SDLK_NUMLOCK
447 SDLK_CAPSLOCK
449 SDLK_SCROLLOCK
451 SDLK_RSHIFT
453 SDLK_LSHIFT
455 SDLK_RCTRL
457 SDLK_LCTRL
459 SDLK_RALT
461 SDLK_LALT
463 SDLK_RMETA
465 SDLK_LMETA
467 SDLK_LSUPER
469 SDLK_RSUPER
471 SDLK_MODE
473 SDLK_HELP
475 SDLK_PRINT
477 SDLK_SYSREQ
479 SDLK_BREAK
481 SDLK_MENU
483 SDLK_POWER
485 SDLK_EURO
487 KMOD_NONE
489 KMOD_NUM
491 KMOD_CAPS
493 KMOD_LCTRL
495 KMOD_RCTRL
497 KMOD_RSHIFT
499 KMOD_LSHIFT
501 KMOD_RALT
503 KMOD_LALT
505 KMOD_CTRL
507 KMOD_SHIFT
509 KMOD_ALT
511 KeyEventSym
513 KeyEventMod
515 KeyEventUnicode
517 KeyEventScanCode
519 MouseMotionState
521 MouseMotionX
523 MouseMotionY
525 MouseMotionXrel
527 MouseMotionYrel
529 MouseButtonState
531 MouseButton
533 MouseButtonX
535 MouseButtonY
537 SysWMEventMsg
539 EnableUnicode
541 EnableKeyRepeat
543 GetKeyName
545 PRESSED
547 RELEASED
549 CreateRGBSurface
551 CreateRGBSurfaceFrom
553 IMG_Load
555 FreeSurface
557 SurfacePalette
559 SurfaceBitsPerPixel
561 SurfaceBytesPerPixel
563 SurfaceRshift
565 SurfaceGshift
567 SurfaceBshift
569 SurfaceAshift
571 SurfaceRmask
573 SurfaceGmask
575 SurfaceBmask
577 SurfaceAmask
579 SurfaceColorKey
581 SurfaceAlpha
583 SurfaceW
585 SurfaceH
587 SurfacePitch
589 SurfacePixels
591 SurfacePixel
593 MUSTLOCK
595 SurfaceLock
597 SurfaceUnlock
599 GetVideoSurface
601 VideoInfo
603 NewRect
605 FreeRect
607 RectX
609 RectY
611 RectW
613 RectH
615 NewColor
617 ColorR
619 ColorG
621 CologB
623 FreeColor
625 NewPalette
627 PaletteNColors
629 PaletteColors
631 SWSURFACE
633 HWSURFACE
635 ANYFORMAT
637 HWPALETTE
639 DOUBLEBUF
641 FULLSCREEN
643 ASYNCBLIT
645 OPENGL
647 HWACCEL
649 VideoModeOK
651 SetVideoMode
653 UpdateRects
655 Flip
657 SetColors
659 MapRGB (surface,r,g,b)
661 "SDL::MapRGB" translates the composite red (r), green (g), blue (b)
663 colors according to the given surface to a interger color value. This
664 integer can be used in functions like "SDL::FillRect", and is not the
665 same as the format independent Color object returned by "SDL::New‐
666 Color".
667 MapRGBA (surface,r,g,b,a)
669 "SDL::MapRGBA" works as "SDL::MapRGB" but takes an additional alpha (a)
671 component for semi-transperant colors.
672 GetRGB
674 GetRGBA
676 SaveBMP
678 SetColorKey
680 SRCCOLORKEY
682 RLEACCEL
684 SRCALPHA
686 SetAlpha
688 DisplayFormat
690 BlitSurface
692 FillRect(surface,rect,color)
694 "SDL::FillRect" draws a solid rectangle of color on the given surface.
696 If the rectangle is NULL, the entire surface will be painted.
697 WMSetCaption
699 WMGetCaption
701 WMSetIcon
703 WarpMouse
705 NewCursor
707 FreeCursor
709 SetCursor
711 GetCursor
713 ShowCursor
715 NewAudioSpec
717 FreeAudioSpec
719 AUDIO_U8
721 AUDIO_S8
723 AUDIO_U16
725 AUDIO_S16
727 AUDIO_U16MSB
729 AUDIO_S16MSB
731 NewAudioCVT
733 FreeAudioCVT
735 ConvertAudioData
737 OpenAudio
739 PauseAudio
741 UnlockAudio
743 CloseAudio
745 FreeWAV
747 LoadWAV
749 MixAudio
751 MIX_MAX_VOLUME
753 MIX_DEFAULT_FREQUENCY
755 MIX_DEFAULT_FORMAT
757 MIX_DEFAULT_CHANNELS
759 MIX_NO_FADING
761 MIX_FADING_OUT
763 MIX_FADING_IN
765 MixOpenAudio
767 MixAllocateChannels
769 MixQuerySpec
771 MixLoadWAV
773 MixLoadMusic
775 MixQuickLoadWAV
777 MixFreeChunk
779 MixFreeMusic
781 MixSetPostMixCallback
783 MixSetMusicHook
785 MixSetMusicFinishedHook
787 MixGetMusicHookData
789 MixReverseChannels
791 MixGroupChannel
793 MixGroupChannels
795 MixGroupAvailable
797 MixGroupCount
799 MixGroupOldest
801 MixGroupNewer
803 MixPlayChannel
805 MixPlayChannelTimed
807 MixPlayMusic
809 MixFadeInChannel
811 MixFadeInChannelTimed
813 MixFadeInMusic
815 MixVolume
817 MixVolumeChunk
819 MixVolumeMusic
821 MixHaltChannel
823 MixHaltGroup
825 MixHaltMusic
827 MixExpireChannel
829 MixFadeOutChannel
831 MixFadeOutGroup
833 MixFadeOutMusic
835 MixFadingMusic
837 MixFadingChannel
839 MixPause
841 MixResume
843 MixPaused
845 MixPauseMusic
847 MixResumeMusic
849 MixRewindMusic
851 MixPausedMusic
853 MixPlaying
855 MixPlayingMusic
857 MixCloseAudio
859 NewFont
861 UseFont
863 PutString
865 TextWidth
867 GL_RED_SIZE
869 GL_GREEN_SIZE
871 GL_BLUE_SIZE
873 GL_ALPHA_SIZE
875 GL_ACCUM_RED_SIZE
877 GL_ACCUM_GREEN_SIZE
879 GL_ACCUM_BLUE_SIZE
881 GL_ACCUM_ALPHA_SIZE
883 GL_BUFFER_SIZE
885 GL_DEPTH_SIZE
887 GL_STENCIL_SIZE
889 GL_DOUBLEBUFFER
891 GL_SetAttribute
893 GL_GetAttribute
895 GL_SwapBuffers
897 BigEndian
899 NumJoysticks
901 JoystickName
903 JoystickOpen
905 JoystickOpened
907 JoystickIndex
909 JoystickNumAxes
911 JoystickNumBalls
913 JoystickNumHats
915 JoystickNumButtons
917 JoystickUpdate
919 JoystickGetAxis
921 JoystickGetHat
923 JoystickGetButton
925 JoystickGetBall
927 JoystickClose
929
931 David J. Goehrig
932
934 David J. Goehrig, Wayne Keenan, Guillaume Cottenceau
935
937 perl(1) SDL::App(3) SDL::Surface(3) SDL::Event(3) SDL::Rect(3)
938 SDL::Palette(3) SDL::Mixer(3) SDL::Cdrom(3)
939perl v5.8.8 2006-08-28 SDL(3)