From: magnet Date: Wed, 28 Oct 2009 23:07:42 +0000 (+0100) Subject: Cleaned pod from SDL.pm X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=7b31a03707283667cce1821215d07553b9950704;p=sdlgit%2FSDL_perl.git Cleaned pod from SDL.pm updated methods names both in doc and .xs file. no more camels ! --- diff --git a/lib/SDL.pm b/lib/SDL.pm index 094dd12..e44ddb1 100644 --- a/lib/SDL.pm +++ b/lib/SDL.pm @@ -150,10 +150,10 @@ Use the SDLPerl executable made in the bundle and call your scripts =head1 Functions exported by SDL.pm -=head2 Init(flags) +=head2 init(flags) As with the C language API, SDL_perl initializes the SDL environment through -the C subroutine. This routine takes a mode flag constructed through +the C subroutine. This routine takes a mode flag constructed through the bitwise OR product of the following constants: =over 4 @@ -183,611 +183,110 @@ INIT_TIMER C returns 0 on success, or -1 on error. -=head2 GetError() +=head2 init_subsystem(flags) -The last error message set by the SDL library can be retrieved using the subroutine -C, which returns a scalar containing the text of the message if any. - -=head2 Delay(ms) - -This subroutine allows an application to delay further operations for atleast a -number of milliseconds provided as the argument. The actual delay may be longer -than the specified depending on the underlying OS. - -=head2 GetTicks() - -An application may retrieve the number of milliseconds expired since the initilization -of the application through this subroutine. This value resets rougly ever 49 days. - -=head2 AddTimer(interval,callback,param) - -C will register a SDL_NewTimerCallback function to be executed after -C milliseconds, with parameter C. SDL_NewTimerCallback objects -can be constructed with the C subroutine. C -will return a valid callback for executing a perl subroutine or closure. -This subroutine returns a SDL_TimerID for the newly registered callback, or NULL -on error. - -=head2 NewTimer(interval,subroutine) - -The C takes an interval in milliseconds and a reference to a subroutine -to call at that interval. The subroutine will be invoked in a void context -and accepts no parameters. The callback used is that returned by C. -C returns the SDL_TimerID for the new timer or NULL on error. - -=head2 RemoveTimer(id) - -This subroutine taks a SDL_TimerID and removes it from the list of active callbacks. -RemoveTimer returns false on failure. - -=head2 SetTimer - -This subroutine is depreciated, please use C or C instead. +After SDL has been initialized with SDL::init you may initialize uninitialized subsystems with SDL::init_subsystem. +The flags parameter is the same as that used in SDL::init. -=head2 CDNumDrives() +SDL::init_subsystem returns 0 on success, or -1 on error. -C returns the number of available CD-ROM drives in the system. +=head2 quit_subsystem(flags) -=head2 CDName(drive) +SDL::quit_subsystem allows you to shut down a subsystem that has been previously initialized by SDL::init or SDL::init_subsystem. +The flags tells SDL::quit_subSystem which subsystems to shut down, it uses the same values that are passed to SDL::init. -The subroutine C returns the system specific human readable device name -for the given CD-ROM drive. +SDL::quit_subsystem doesn't returns any value. -=head2 CDOpen(drive) +=head2 quit -This subroutine opens a CD-ROM drive for access, returning NULL if the drive is busy -or otherwise unavailable. On success this subroutine returns a handle to the CD-ROM -drive. +Shuts down all SDL subsystems, unloads the dynamically linked library and frees the allocated resources. This should always be called before you exit. -=head2 CDTrackListing(cd) +SDL::quit doesn't returns any value. -C returns a human readable description of a CD-ROM. For each -track one line will be produced with the following format: +=head2 was_init(flags) - Track index: %d, id %d, %2d.%2d +SDL::was_init allows you to see which SDL subsytems have been initialized. +flags is a bitwise OR'd combination of the subsystems you wish to check (see SDL::init for a list of subsystem flags). +If 'flags' is 0 or SDL_INIT_EVERYTHING, it returns a mask of all initialized subsystems (this does not include SDL_INIT_EVENTTHREAD or SDL_INIT_NOPARACHUTE). -This is provided to ease the creation of human readable descriptions and debugging. -=head2 CDTrackId(track) +=head2 get_error() -C returns the id field of the given SDL_CDtrack structure. - -=head2 CDTrackType(track) - -C returns the type field of the given SDL_CDtrack structure. - -=head2 CDTrackLength(track) +The last error message set by the SDL library can be retrieved using the subroutine +C, which returns a scalar containing the text of the message if any. -C returns the length field of the given SDL_CDtrack structure. +=head2 set_error(error) *need to be coded -=head2 CDTrackOffset(track) +SDL::get_error sets the SDL error to a printf style formatted string. +it doesn't returns any values. -C returns the offset field of the given SDL_CDtrack structure. +=head2 error(code) * need to be coded -=head2 CDStatus(cd) +Sets the SDL error message to one of several predefined strings specified by code. -The function C returns the current status of the given SDL_CDrom. -C's return values are: +code can be : =over 4 -=item * -CD_TRAYEMPTY + SDL_errorcode The corresponding error string -=item * -CD_PLAYING + SDL_ENOMEM Out of memory + SDL_EFREAD Error reading from datastream + SDL_EFWRITE Error writing to datastream + SDL_EFSEEK Error seeking in datastream + SDL_UNSUPPORTED Unknown SDL error + SDL_LASTERROR Unknown SDL error + any other value Unknown SDL error -=item * -CD_STOPPED -=item * -CD_PAUSED - -=item * -CD_ERROR + Note 1: SDL_LASTERROR marks the highest numbered predefined error. + Note 2: SDL also defines SDL_OutOfMemory() and SDL_Unsupported() for internal use + which are equivalent to SDL_Error(SDL_ENOMEM) and SDL_Error(SDL_UNSUPPORTED) respectively. =back -=head2 CDPlayTracks(cd,track,tracks,frame,frames) - -To start playing from an arbitrary portion of a CD, one can provide -C with a CD, a starting track, the number of tracks, -a starting frame, and the number of frames to be played. - -=head2 CDPlay(cd,track,length) - -C plays the next C tracks starting from C - -=head2 CDPause(cd) - -This function will pause CD playback until resume is called. - -=head2 CDResume(cd) - -This function will resume CD playback if paused. - -=head2 CDStop(cd) - -C will stop CD playback if playing. - -=head2 CDEject(cd) - -This function will eject the CD. - -=head2 CDClose(cd) - -This function will release an opened CD. - -=head2 CDNumTracks - -This function return the number of tracks on a CD, -it take a SDL_CD as first parameter. - -=head2 CDCurTrack - -This function return the number of the current track on a CD, -it take a SDL_CD as first parameter. - -=head2 CDCurFrame - -this function return the frame offset within the current track on a CD. -it take a SDL_CD as first parameter. - -=head2 CDTrack - -CDtrack stores data on each track on a CD, its fields should be pretty self explainatory. -CDtrack take a SDL::CD as input and return a SDL_CDTrack. - -=head2 PumpEvents - -Pumps the event loop, gathering events from the input devices. - -PumpEvents gathers all the pending input information from devices and places -it on the event queue. -Without calls to PumpEvents no events would ever be placed on the queue. -Often the need for calls to PumpEvents is hidden from the user -since L and WaitEvent implicitly call PumpEvents. -However, if you are not polling or waiting for events (e.g. you are filtering them), -then you must call PumpEvents to force an event queue update. -PumpEvents doesn't return any value and doesn't take any parameters. - -Note: You can only call this function in the thread that set the video mode. - -=head2 NewEvent - -Create a new event.It return a SDL::Event. - -=head2 FreeEvent - -FreeEvent delete the SDL::Event given as first parameter. -it doesn't return anything. - -=head2 PollEvent - -Polls for currently pending events. -If event is not undef, the next event is removed from the queue and returned as a L< SDL::Event>. -As this function implicitly calls L, you can only call this function in the thread that set the video mode. -it take a SDL::Event as first parameter. - -=head2 WaitEvent - -Waits indefinitely for the next available event, returning undef if there was an error while waiting for events, -a L< SDL::Event> otherwise. -If event is not NULL, the next event is removed. -As this function implicitly calls L, you can only call this function in the thread that set the video mode. -WaitEvent take a SDL::Event as first parameter. - -=head2 EventState - -This function allows you to set the state of processing certain event types. - -it take an event type as first argument, and a state as second. - -If state is set to SDL_IGNORE, that event type will be automatically -dropped from the event queue and will not be filtered. -If state is set to SDL_ENABLE, that event type will be processed -normally. -If state is set to SDL_QUERY, SDL_EventState will return the current -processing state of the specified event type. - -A list of event types can be found in the L. - -it returns a state(?). - -=head2 IGNORE - -=head2 ENABLE - -=head2 QUERY - -=head2 ACTIVEEVENT - -=head2 KEYDOWN - -=head2 KEYUP - -=head2 MOUSEMOTION - -=head2 MOUSEBUTTONDOWN - -=head2 MOUSEBUTTONUP - -=head2 QUIT - -=head2 SYSWMEVENT - -=head2 EventType - -EventType return the type of the SDL::Event given as first parameter. - -=head2 ActiveEventGain - -ActiveEventGain return the active gain from the SDL::Event given as first parameter. -see L for more informations about the active state. - -=head2 ActiveEventState - -ActiveEventState return the active state from the SDL::Event given as first parameter. -see L for more informations about the active state. - -=head2 APPMOUSEFOCUS - -=head2 APPINPUTFOCUS - -=head2 APPACTIVE - -=head2 KeyEventState - -KeyEventState return the active key state from the SDL::Event given as first parameter. -see L for me more informations about the active key. - -=head2 SDLK_BACKSPACE - -=head2 SDLK_TAB - -=head2 SDLK_CLEAR - -=head2 SDLK_RETURN - -=head2 SDLK_PAUSE - -=head2 SDLK_ESCAPE - -=head2 SDLK_SPACE - -=head2 SDLK_EXCLAIM - -=head2 SDLK_QUOTEDBL - -=head2 SDLK_HASH - -=head2 SDLK_DOLLAR - -=head2 SDLK_AMPERSAND - -=head2 SDLK_QUOTE - -=head2 SDLK_LEFTPAREN - -=head2 SDLK_RIGHTPAREN - -=head2 SDLK_ASTERISK - -=head2 SDLK_PLUS - -=head2 SDLK_COMMA - -=head2 SDLK_MINUS - -=head2 SDLK_PERIOD - -=head2 SDLK_SLASH - -=head2 SDLK_0 - -=head2 SDLK_1 - -=head2 SDLK_2 - -=head2 SDLK_3 - -=head2 SDLK_4 - -=head2 SDLK_5 - -=head2 SDLK_6 - -=head2 SDLK_7 - -=head2 SDLK_8 - -=head2 SDLK_9 - -=head2 SDLK_COLON - -=head2 SDLK_SEMICOLON - -=head2 SDLK_LESS - -=head2 SDLK_EQUALS +SDL::Error doesn't returns any value. -=head2 SDLK_GREATER -=head2 SDLK_QUESTION +=head2 clear_error() * need to be coded -=head2 SDLK_AT +SDL::clear_error deletes all information about the last internal SDL error. Useful if the error has been handled by the program. +it doesn't returns any value. -=head2 SDLK_LEFTBRACKET +=head2 loadobject() -=head2 SDLK_BACKSLASH +Need to be coded. -=head2 SDLK_RIGHTBRACKET +=head2 loadfunction() -=head2 SDLK_CARET +Need to be coded. -=head2 SDLK_UNDERSCORE +=head2 unload_object() -=head2 SDLK_BACKQUOTE +Need to be coded. -=head2 SDLK_a +=head2 VERSION() -=head2 SDLK_b +Need to be coded. -=head2 SDLK_c +=head2 version() -=head2 SDLK_d +Need to be coded. -=head2 SDLK_e +=head2 linked_version -=head2 SDLK_f +Need to be coded. -=head2 SDLK_g +=head2 get_error() -=head2 SDLK_h - -=head2 SDLK_i - -=head2 SDLK_j - -=head2 SDLK_k - -=head2 SDLK_l - -=head2 SDLK_m - -=head2 SDLK_n - -=head2 SDLK_o - -=head2 SDLK_p - -=head2 SDLK_q - -=head2 SDLK_r - -=head2 SDLK_s - -=head2 SDLK_t - -=head2 SDLK_u - -=head2 SDLK_v - -=head2 SDLK_w - -=head2 SDLK_x - -=head2 SDLK_y - -=head2 SDLK_z - -=head2 SDLK_DELETE - -=head2 SDLK_KP0 - -=head2 SDLK_KP1 - -=head2 SDLK_KP2 - -=head2 SDLK_KP3 - -=head2 SDLK_KP4 - -=head2 SDLK_KP5 - -=head2 SDLK_KP6 - -=head2 SDLK_KP7 - -=head2 SDLK_KP8 - -=head2 SDLK_KP9 - -=head2 SDLK_KP_PERIOD - -=head2 SDLK_KP_DIVIDE - -=head2 SDLK_KP_MULTIPLY - -=head2 SDLK_KP_MINUS - -=head2 SDLK_KP_PLUS - -=head2 SDLK_KP_ENTER - -=head2 SDLK_KP_EQUALS - -=head2 SDLK_UP - -=head2 SDLK_DOWN - -=head2 SDLK_RIGHT - -=head2 SDLK_LEFT - -=head2 SDLK_INSERT - -=head2 SDLK_HOME - -=head2 SDLK_END - -=head2 SDLK_PAGEUP - -=head2 SDLK_PAGEDOWN - -=head2 SDLK_F1 - -=head2 SDLK_F2 - -=head2 SDLK_F3 - -=head2 SDLK_F4 - -=head2 SDLK_F5 - -=head2 SDLK_F6 - -=head2 SDLK_F7 - -=head2 SDLK_F8 - -=head2 SDLK_F9 - -=head2 SDLK_F10 - -=head2 SDLK_F11 - -=head2 SDLK_F12 - -=head2 SDLK_F13 - -=head2 SDLK_F14 - -=head2 SDLK_F15 - -=head2 SDLK_NUMLOCK - -=head2 SDLK_CAPSLOCK - -=head2 SDLK_SCROLLOCK - -=head2 SDLK_RSHIFT - -=head2 SDLK_LSHIFT - -=head2 SDLK_RCTRL - -=head2 SDLK_LCTRL - -=head2 SDLK_RALT - -=head2 SDLK_LALT - -=head2 SDLK_RMETA - -=head2 SDLK_LMETA - -=head2 SDLK_LSUPER - -=head2 SDLK_RSUPER - -=head2 SDLK_MODE - -=head2 SDLK_HELP - -=head2 SDLK_PRINT - -=head2 SDLK_SYSREQ - -=head2 SDLK_BREAK - -=head2 SDLK_MENU - -=head2 SDLK_POWER - -=head2 SDLK_EURO - -=head2 KMOD_NONE - -=head2 KMOD_NUM - -=head2 KMOD_CAPS - -=head2 KMOD_LCTRL - -=head2 KMOD_RCTRL - -=head2 KMOD_RSHIFT - -=head2 KMOD_LSHIFT - -=head2 KMOD_RALT - -=head2 KMOD_LALT - -=head2 KMOD_CTRL - -=head2 KMOD_SHIFT - -=head2 KMOD_ALT - -=head2 KeyEventSym - -KeyEventSym return the key pressed/released information from the SDL::Event given as first parameter. -see L for more informations about the keyboard events. - -=head2 KeyEventMod - -KeyEventMod return the mod keys pressed information from the SDL::Event given as first parameter. -see L for more informations about the keyboard events. - -=head2 KeyEventUnicode - -KeyEventMod return the unicode translated keys pressed/released information from the SDL::Event given as first parameter. -see L for more informations about the keyboard events. - -=head2 KeyEventScanCode - -=head2 MouseMotionState - -=head2 MouseMotionX - -=head2 MouseMotionY - -=head2 MouseMotionXrel - -=head2 MouseMotionYrel - -=head2 MouseButtonState - -=head2 MouseButton - -=head2 MouseButtonX - -=head2 MouseButtonY - -=head2 SysWMEventMsg - -=head2 EnableUnicode - -=head2 EnableKeyRepeat - -=head2 GetKeyName - -=head2 PRESSED - -=head2 RELEASED - -=head2 CreateRGBSurface - -=head2 CreateRGBSurfaceFrom +The last error message set by the SDL library can be retrieved using the subroutine +C, which returns a scalar containing the text of the message if any. -=head2 IMG_Load +=head2 delay(ms) -=head2 FreeSurface +This subroutine allows an application to delay further operations for atleast a +number of milliseconds provided as the argument. The actual delay may be longer +than the specified depending on the underlying OS. -=head2 SurfacePalette -=head2 SurfaceBitsPerPixel -=head2 SurfaceBy diff --git a/src/SDL.xs b/src/SDL.xs index 50e286a..bf9f64d 100644 --- a/src/SDL.xs +++ b/src/SDL.xs @@ -243,14 +243,14 @@ MODULE = SDL_perl PACKAGE = SDL PROTOTYPES : DISABLE char * -GetError () +geterror () CODE: RETVAL = SDL_GetError(); OUTPUT: RETVAL int -Init ( flags ) +init ( flags ) Uint32 flags CODE: INIT_NS_APPLICATION @@ -264,7 +264,7 @@ Init ( flags ) RETVAL int -InitSubSystem ( flags ) +init_subsystem ( flags ) Uint32 flags CODE: RETVAL = SDL_InitSubSystem(flags); @@ -272,19 +272,19 @@ InitSubSystem ( flags ) RETVAL void -QuitSubSystem ( flags ) +quit_subsystem ( flags ) Uint32 flags CODE: SDL_QuitSubSystem(flags); void -Quit () +quit () CODE: QUIT_NS_APPLICATION SDL_Quit(); int -WasInit ( flags ) +was_init ( flags ) Uint32 flags CODE: RETVAL = SDL_WasInit(flags); @@ -292,7 +292,7 @@ WasInit ( flags ) RETVAL void -Delay ( ms ) +delay ( ms ) int ms CODE: SDL_Delay(ms);