From: Tobias Leich Date: Mon, 16 Nov 2009 23:20:28 +0000 (+0100) Subject: docs X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=ecabf8b7bf499c14ce1b43db8c390191ef8486cd;p=sdlgit%2FSDL-Site.git docs --- diff --git a/pages/SDL-Surface.html-inc b/pages/SDL-Surface.html-inc index 5d6b428..e7692ef 100644 --- a/pages/SDL-Surface.html-inc +++ b/pages/SDL-Surface.html-inc @@ -64,8 +64,10 @@

The constructor creates a new surface with the specified parameter values. 

    my $surface = SDL::Surface->new_from( $old_surface, ... );
 
+
+
+
-

THIS WILL SEGFAULT!!! Read: http://sdlperl.ath.cx/projects/SDLPerl/ticket/53

Construtor Parameters

diff --git a/pages/SDL.html-inc b/pages/SDL.html-inc index 530e24c..87fbc70 100644 --- a/pages/SDL.html-inc +++ b/pages/SDL.html-inc @@ -32,10 +32,11 @@
  • version()
  • linked_version
  • get_error()
    • -
  • delay(ms) -
    • +
  • delay(ms)
    • +
  • STUFF TO BE DONE for the documentation +
    • @@ -298,8 +299,25 @@ than the specified depending on the underlying OS.

    + +

    STUFF TO BE DONE for the documentation

    Top

    +
    +
    +
+
+	SDL:: to improve
+	SDL::Video add examples, need general improvement.
+	Event.pod need to be checked against Events.pod
+	SDL::Events need to be completed
+	SDL::Cdrom need some examples. 
+	SDL::MultiThread to be created( once implemented  ). 
+	SDL::Time to be completed.
+	SDL::RW to be created.
+	SDL::Mouse need to be created.
+	SDL::Joystick need to be created.
+	SDL::Audio need to be created.
 
-
+
    \ No newline at end of file diff --git a/pages/Time.html-inc b/pages/Time.html-inc new file mode 100644 index 0000000..b1daa14 --- /dev/null +++ b/pages/Time.html-inc @@ -0,0 +1,124 @@ +
    + +

    Index

    + +
    + + +

    NAME

    Top

    +
    +

    SDL::Time - a SDL perl extension for managing timers.

    + + + + + +
    +

    SYNOPSIS

    Top

    +
    + + + + + + + + + + + +
    +

    METHODS

    Top

    +
    + + + + + +
    +

    get_ticks()

    +
    +

    Returns the number of milliseconds since SDL library initialization. This value wraps around if the program runs for more than 49.7 days

    + + + + + +
    +

    delay(ms)

    +
    +

    This function waits a specified number of milliseconds before returning. It waits at least the specified time, but possible longer due to OS scheduling. The delay granularity is at least 10 ms. Some platforms have shorter clock ticks but this is the most common. +SDL::delay doesn't returns anything.

    + +
    +

    add_timer(interval,callback,param)

    +
    +

    Adds a callback function to be run after the specified number of milliseconds has elapsed. +The callback function is passed the current timer interval and the user supplied parameter from the SDL::add_timer call and returns the next timer interval. +If the returned value from the callback is the same as the one passed in, the timer continues at the same rate. +If the returned value from the callback is 0, the timer is cancelled.

    +

    Another way to cancel a currently-running timer is by calling SDL::remove_timer with the timer's ID (which was returned from SDL::add_timer).

    +

    The timer callback function may run in a different thread than your main program, and so shouldn't call any functions from within itself. +However, you may always call SDL::push_event.

    +

    SDL::add_timer returns the identifier value of the generated timer or undef on error.

    +

    Note : If you use this function, you need to pass SDL_INIT_TIMER to SDL::init.

    + +
    +

    Parameters

    +
    +
    	interval [in]   The desired interval of the timer, in milliseconds. 
+			The granularity of the timer is platform-dependent, but you should count on it being at least 10 ms as this is the most common number.
+			This means that if you request a 16 ms timer, your callback will run approximately 20 ms later on an unloaded system. 
+			If you wanted to set a flag signaling a frame update at 30 frames per second (every 33 ms), you might set a timer for 30 ms (see example below). 
+
+	callback [in]   The SDL timer callback function which is called when the specified interval elapses. 
+
+	param [in]	The user parameter which is passed to the callback function 
+
+
+
+
+
    + +
    +

    remove_timer( id )

    +
    +

    Removes a timer callback previously added with SDL::add_timer. +It returns 0 on succés or -1 on error.

    + +
    +

    set_timer( interval,callback )

    +
    +

    Set a callback to run after the specified number of milliseconds has elapsed. +The callback function is passed the current timer interval and returns the next timer interval. +If the returned value is the same as the one passed in, the periodic alarm continues, otherwise a new alarm is scheduled.

    +

    To cancel a currently running timer, call SDL::set_timer(0, NULL);

    +

    The timer callback function may run in a different thread than your main constant, and so shouldn't call any functions from within itself.

    +

    The maximum resolution of this timer is 10 ms, which means that if you request a 16 ms timer, your callback will run approximately 20 ms later on an unloaded system. If you wanted to set a flag signaling a frame update at 30 frames per second (every 33 ms), you might set a timer for 30 ms (see example below).

    +

    If you use this function, you need to pass SDL_INIT_TIMER to SDL::init(). +Note: This function is kept for compatibility but has been superseded by the new timer functions SDL::add_timer and SDL::remove_timer which support multiple timers.

    + + + + + +
    +
    \ No newline at end of file diff --git a/pages/documentation.html-inc b/pages/documentation.html-inc index 26532a2..2f59243 100644 --- a/pages/documentation.html-inc +++ b/pages/documentation.html-inc @@ -1,2 +1,2 @@
    -

    Documentation (latest development branch)

    SDL
    SDL::App
    SDL::Cdrom
    SDL::Color
    SDL::Cookbook
    SDL::Cookbook::PDL
    SDL::Cursor
    SDL::Event
    SDL::Events
    SDL::Font
    SDL::Game::Palette
    SDL::MPEG
    SDL::Mixer
    SDL::MultiThread
    SDL::Music
    SDL::OpenGL
    SDL::Overlay
    SDL::Palette
    SDL::PixelFormat
    SDL::Rect
    SDL::SFont
    SDL::SMPEG
    SDL::Sound
    SDL::Surface
    SDL::TTFont
    SDL::Timer
    SDL::Tool::Font
    SDL::Tool::Graphic
    SDL::Tutorial
    SDL::Tutorial::Animation
    SDL::Tutorial::Images
    SDL::Tutorial::LunarLander
    SDL::Tutorial::Pong
    SDL::Tutorial::Tetris
    SDL::Video
    SDL::VideoInfo
    +

    Documentation (latest development branch)

    SDL
    SDL::App
    SDL::Cdrom
    SDL::Color
    SDL::Cookbook
    SDL::Cookbook::PDL
    SDL::Cursor
    SDL::Event
    SDL::Events
    SDL::Font
    SDL::Game::Palette
    SDL::MPEG
    SDL::Mixer
    SDL::MultiThread
    SDL::Music
    SDL::OpenGL
    SDL::Overlay
    SDL::Palette
    SDL::PixelFormat
    SDL::Rect
    SDL::SFont
    SDL::SMPEG
    SDL::Sound
    SDL::Surface
    SDL::TTFont
    SDL::Timer
    SDL::Tool::Font
    SDL::Tool::Graphic
    SDL::Tutorial
    SDL::Tutorial::Animation
    SDL::Tutorial::Images
    SDL::Tutorial::LunarLander
    SDL::Tutorial::Pong
    SDL::Tutorial::Tetris
    SDL::Video
    SDL::VideoInfo
    Time