From: Tobias Leich Date: Wed, 24 Mar 2010 18:50:51 +0000 (+0100) Subject: added GL attributes X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=sdlgit%2FSDL-Site.git;a=commitdiff_plain;h=9b105a174c47bf270f320086452ef5d26c53fe35 added GL attributes --- diff --git a/pages/SDL-Video.html-inc b/pages/SDL-Video.html-inc index 9158204..32ebba2 100644 --- a/pages/SDL-Video.html-inc +++ b/pages/SDL-Video.html-inc @@ -182,6 +182,26 @@ SDL_GRAB_FULLSCREEN Used interally +

Export tag ':gl'

+
 SDL_GL_RED_SIZE
+ SDL_GL_GREEN_SIZE
+ SDL_GL_BLUE_SIZE
+ SDL_GL_ALPHA_SIZE
+ SDL_GL_BUFFER_SIZE
+ SDL_GL_DOUBLEBUFFER
+ SDL_GL_DEPTH_SIZE
+ SDL_GL_STENCIL_SIZE
+ SDL_GL_ACCUM_RED_SIZE
+ SDL_GL_ACCUM_GREEN_SIZE
+ SDL_GL_ACCUM_BLUE_SIZE
+ SDL_GL_ACCUM_ALPHA_SIZE
+ SDL_GL_STEREO
+ SDL_GL_MULTISAMPLEBUFFERS
+ SDL_GL_MULTISAMPLESAMPLES
+ SDL_GL_ACCELERATED_VISUAL
+ SDL_GL_SWAP_CONTROL
+
+

Core Functions

Top

diff --git a/pages/SDL.html-inc b/pages/SDL.html-inc index 15eab1c..99b926e 100644 --- a/pages/SDL.html-inc +++ b/pages/SDL.html-inc @@ -15,13 +15,8 @@
  • quit
  • was_init(flags)
  • get_error()
    • -
  • set_error_real(error, @values)
    • -
  • error(code) * need to be coded
    • -
  • clear_error()
    • -
  • load_object()
    • -
  • load_function()
    • -
  • unload_object()
    • -
  • VERSION()
    • +
  • set_error_real(error, @values)
    • +
  • clear_error()
  • version()
  • linked_version
  • get_error()
    • @@ -77,6 +72,8 @@ the bitwise OR product of the SDL_INIT_* constants.

     SDL::SDL_INIT_AUDIO;
    +

    or by choosing the export tags below:

    +

    Export tag: ':init'

    * SDL_INIT_AUDIO
    @@ -123,10 +120,6 @@ The flags tells SDL::quit_subSystem which subsystems to shut down, it uses the s 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).

    - - - -

    get_error()

    @@ -134,94 +127,51 @@ If 'flags' is 0 or SDL_INIT_EVERYTHING, it returns a mask of all initialized sub SDL::get_error, which returns a scalar containing the text of the message if any.

    -

    set_error_real(error, @values)

    +

    set_error_real(error, @values)

    -

    SDL::get_error sets the SDL error to a printf style formatted string. +

    SDL::set_error_real sets the SDL error to a printf style formatted string. it doesn't returns any values.

    -

    error(code) * need to be coded

    -
    -

    Sets the SDL error message to one of several predefined strings specified by code.

    -

    code can be :

    -
    -
    SDL_errorcode
    -
    -

    The corresponding error string

    -
    -
    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

    -
    -
    -

    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.

    -

    SDL::Error doesn't returns any value.

    - - - - - -
    -

    clear_error()

    +

    clear_error()

    -

    SDL::clear_error deletes all information about the last internal SDL error. Useful if the error has been handled by the program. +

    SDL::clear_error deletes all information about the last SDL error. Useful if the error has been handled by the program. it doesn't returns any value.

    -

    load_object()

    -
    -

    Need to be coded.

    +

    version()

    +
    +
     my $version = SDL::version();
 
-
    -

    load_function()

    -
    -

    Need to be coded.

    + +

    Returns an SDL::Version object of the of the SDL library at compile time.

    +

    Example:

    +
     use SDL;
+ use SDL::Version;
+
+ my $v = SDL::version();
+ printf("got version: %d.%d.%d\n", $v->major, $v->minor, $v->patch);
 
-
    -

    unload_object()

    -
    -

    Need to be coded.

    -
    -

    VERSION()

    -
    -

    Need to be coded.

    -
    -

    version()

    -
    -

    Need to be coded.

    + +

    linked_version

    -

    Need to be coded.

    +
     my $linked_version = SDL::linked_version();
+
+
    +

    Returns an SDL::Version object of the currently loaded SDL library.

    +

    Example:

    +
     use SDL;
+ use SDL::Version;
+
+ my $v = SDL::linked_version();
+ printf("got version: %d.%d.%d\n", $v->major, $v->minor, $v->patch);
+
+

    get_error()

    @@ -232,22 +182,18 @@ it doesn't returns any value.

    delay(ms)

    +
     SDL::delay(1000);
+
+

    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.

    - - - -

    AUTHORS

    Top

    -

    magnet, kthakore

    - - - - +

    magnet, kthakore +

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

    Documentation (latest development branch)

    Core
    thumbSDL- Simple DirectMedia Layer for Perl
    thumbSDL::Time- a SDL perl extension for managing timers.
    Audio
    thumbSDL::Audio- SDL Bindings for Audio
    Structure
    thumbSDL::AudioCVT- Audio Conversion Structure
    thumbSDL::AudioSpec- SDL Bindings for structure SDL::AudioSpec
    CDROM
    thumbSDL::CDROM- SDL Bindings for the CDROM device
    Structure
    thumbSDL::CD- SDL Bindings for structure SDL_CD
    thumbSDL::CDTrack- SDL Bindings for structure SDL_CDTrack
    Events
    thumbSDL::Events- Bindings to the Events Category in SDL API
    Structure
    thumbSDL::Event- General event structure
    Joystick
    thumbSDL::Joystick- SDL Bindings for the Joystick device
    Mouse
    thumbSDL::Mouse- SDL Bindings for the Mouse device
    Structure
    thumbSDL::Cursor- Mouse cursor structure
    Structure
    thumbSDL::Version- SDL Bindings for structure SDL_Version
    Video
    thumbSDL::Video- Bindings to the video category in SDL API
    Structure
    thumbSDL::Color- Format independent color description
    thumbSDL::Overlay- YUV Video overlay
    thumbSDL::Palette- Color palette for 8-bit pixel formats
    thumbSDL::PixelFormat- Stores surface format information
    thumbSDL::Rect- Defines a rectangular area
    thumbSDL::Surface- Graphic surface structure.
    thumbSDL::VideoInfo- Video Target Information

    Cookbook
    thumbSDL::Cookbook
    thumbSDL::Cookbook::PDL

    Extension
    thumbSDL::App- a SDL perl extension

    GFX
    thumbSDL::GFX::Framerate- framerate calculating functions
    thumbSDL::GFX::Primitives- basic drawing functions
    Structure
    thumbSDL::GFX::FPSManager- data structure used by SDL::GFX::Framerate

    Image
    thumbSDL::Image- Bindings for the SDL_Image library

    Mixer
    thumbSDL::Mixer- Sound and music functions
    thumbSDL::Mixer::Channels- SDL::Mixer channel functions and bindings
    thumbSDL::Mixer::Effects- sound effect functions
    thumbSDL::Mixer::Groups- Audio channel group functions
    thumbSDL::Mixer::Music- functions for music
    thumbSDL::Mixer::Samples- functions for loading sound samples
    Structure
    thumbSDL::Mixer::MixChunk- SDL Bindings for structure SDL_MixChunk
    thumbSDL::Mixer::MixMusic- SDL Bindings for structure SDL_MixMusic

    Pango
    thumbSDL::Pango- Text rendering engine
    Structure
    thumbSDL::Pango::Context- Context object for SDL::Pango
    TODO
    Core
    MultiThread
    thumbSDL::MultiThread- Bindings to the MultiThread category in SDL API
    Structure
    thumbSDL::RWOps- SDL Bindings to SDL_RWOPs
    GFX
    thumbSDL::GFX::BlitFunc- blitting functions
    thumbSDL::GFX::ImageFilter- image filtering functions
    thumbSDL::GFX::Rotozoom- rotation and zooming functions for surfaces

    TTF
    thumbSDL::TTF- True Type Font functions (libfreetype)
    Structure
    thumbSDL::TTF::Font- Font object type for SDL_ttf

    Tutorials
    thumbSDL::Tutorial- introduction to Perl SDL
    thumbSDL::Tutorial::Animation
    thumbSDL::Tutorial::Images
    thumbSDL::Tutorial::LunarLander- a small tutorial on Perl SDL
    thumbSDL::Tutorial::Pong- Get started pong
    thumbSDL::Tutorial::Tetris- Let's Make Tetris

    UNCATEGORIZED
    thumbSDL::Credits
    thumbSDL::Font- a SDL perl extension
    thumbSDL::Game::Palette- a perl extension
    thumbSDL::MPEG- a SDL perl extension
    thumbSDL::Music- a perl extension
    thumbSDL::OpenGL- a perl extension
    thumbSDL::SFont- a perl extension
    thumbSDL::SMPEG- a SDL perl extension
    thumbSDL::Sound- a perl extension
    thumbSDL::TTFont- a SDL perl extension
    thumbSDL::Tool::Font- a perl extension
    thumbSDL::Tool::Graphic
    +

    Documentation (latest development branch)

    Core
    thumbSDL- Simple DirectMedia Layer for Perl
    thumbSDL::Time- a SDL perl extension for managing timers.
    Audio
    thumbSDL::Audio- SDL Bindings for Audio
    Structure
    thumbSDL::AudioCVT- Audio Conversion Structure
    thumbSDL::AudioSpec- SDL Bindings for structure SDL::AudioSpec
    CDROM
    thumbSDL::CDROM- SDL Bindings for the CDROM device
    Structure
    thumbSDL::CD- SDL Bindings for structure SDL_CD
    thumbSDL::CDTrack- SDL Bindings for structure SDL_CDTrack
    Events
    thumbSDL::Events- Bindings to the Events Category in SDL API
    Structure
    thumbSDL::Event- General event structure
    Joystick
    thumbSDL::Joystick- SDL Bindings for the Joystick device
    Mouse
    thumbSDL::Mouse- SDL Bindings for the Mouse device
    Structure
    thumbSDL::Cursor- Mouse cursor structure
    Structure
    thumbSDL::Version- SDL Bindings for structure SDL_Version
    Video
    thumbSDL::Video- Bindings to the video category in SDL API
    Structure
    thumbSDL::Color- Format independent color description
    thumbSDL::Overlay- YUV Video overlay
    thumbSDL::Palette- Color palette for 8-bit pixel formats
    thumbSDL::PixelFormat- Stores surface format information
    thumbSDL::Rect- Defines a rectangular area
    thumbSDL::Surface- Graphic surface structure.
    thumbSDL::VideoInfo- Video Target Information

    Cookbook
    thumbSDL::Cookbook
    thumbSDL::Cookbook::PDL

    Extension
    thumbSDL::App- a SDL perl extension

    GFX
    thumbSDL::GFX::Framerate- framerate calculating functions
    thumbSDL::GFX::Primitives- basic drawing functions
    Structure
    thumbSDL::GFX::FPSManager- data structure used by SDL::GFX::Framerate

    Image
    thumbSDL::Image- Bindings for the SDL_Image library

    Mixer
    thumbSDL::Mixer- Sound and music functions
    thumbSDL::Mixer::Channels- SDL::Mixer channel functions and bindings
    thumbSDL::Mixer::Effects- sound effect functions
    thumbSDL::Mixer::Groups- Audio channel group functions
    thumbSDL::Mixer::Music- functions for music
    thumbSDL::Mixer::Samples- functions for loading sound samples
    Structure
    thumbSDL::Mixer::MixChunk- SDL Bindings for structure SDL_MixChunk
    thumbSDL::Mixer::MixMusic- SDL Bindings for structure SDL_MixMusic

    Pango
    thumbSDL::Pango- Text rendering engine
    Structure
    thumbSDL::Pango::Context- Context object for SDL::Pango
    TODO
    Core
    MultiThread
    thumbSDL::MultiThread- Bindings to the MultiThread category in SDL API
    Structure
    thumbSDL::RWOps- SDL Bindings to SDL_RWOPs
    GFX
    thumbSDL::GFX::BlitFunc- blitting functions
    thumbSDL::GFX::ImageFilter- image filtering functions
    thumbSDL::GFX::Rotozoom- rotation and zooming functions for surfaces

    TTF
    thumbSDL::TTF- True Type Font functions (libfreetype)
    Structure
    thumbSDL::TTF::Font- Font object type for SDL_ttf

    Tutorials
    thumbSDL::Tutorial- introduction to Perl SDL
    thumbSDL::Tutorial::Animation
    thumbSDL::Tutorial::Images
    thumbSDL::Tutorial::LunarLander- a small tutorial on Perl SDL
    thumbSDL::Tutorial::Pong- Get started pong
    thumbSDL::Tutorial::Tetris- Let's Make Tetris

    UNCATEGORIZED
    thumbSDL::Credits
    thumbSDL::Font- a SDL perl extension
    thumbSDL::Game::Palette- a perl extension
    thumbSDL::MPEG- a SDL perl extension
    thumbSDL::Music- a perl extension
    thumbSDL::OpenGL- a perl extension
    thumbSDL::SFont- a perl extension
    thumbSDL::SMPEG- a SDL perl extension
    thumbSDL::Sound- a perl extension
    thumbSDL::TTFont- a SDL perl extension
    thumbSDL::Tool::Font- a perl extension
    thumbSDL::Tool::Graphic