X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=pages%2FSDL-Image.html-inc;h=6190dcd5b6ce4e9d8803e18790849de1d990269e;hb=d5943b684b1240307fbf0a103abbf18dd93998f4;hp=c3a3166b5ac824e53ff3591d14a4925fc2fd0fae;hpb=92e293d6d5adcc910443bf2ef174928e266c625d;p=sdlgit%2FSDL-Site.git diff --git a/pages/SDL-Image.html-inc b/pages/SDL-Image.html-inc index c3a3166..6190dcd 100644 --- a/pages/SDL-Image.html-inc +++ b/pages/SDL-Image.html-inc @@ -53,7 +53,8 @@
  • get_error
    • -
  • SEE ALSO +
  • SEE ALSO
    • +
  • AUTHORS
    • @@ -147,9 +148,9 @@ HAM6, HAM8, and 24bit types are not supported.

    $file Image file name to load a surface from.

    -

    Load file for use as an image in a new SDL::Surface. This actually calls IMG_LoadTyped_RW the binded function to SDL::Image::load_typed_rw, with the file extension used as the type string. This can load all supported image files, including TGA as long as the filename ends with ".tga". It is best to call this outside of event loops, and rather keep the loaded images around until you are really done with them, as disk speed and image conversion to a surface is not that speedy. +

    Load file for use as an image in a new SDL::Surface. This actually calls IMG_LoadTyped_RW the binded function to SDL::Image::load_typed_rw, with the file extension used as the type string. This can load all supported image files, including TGA as long as the filename ends with ".tga". It is best to call this outside of event loops, and rather keep the loaded images around until you are really done with them, as disk speed and image conversion to a surface is not that speedy. Note: If the image format loader requires initialization, it will attempt to do that the first time it is needed if you have not already called SDL::Image::init to load support for your image format. -Note: If the image format supports a transparent pixel, SDL::Image will set the colorkey for the surface. You can enable RLE acceleration on the surface afterwards by calling: +Note: If the image format supports a transparent pixel, SDL::Image will set the colorkey for the surface. You can enable RLE acceleration on the surface afterwards by calling: SDL::Video::set_color_key

      my $image = SDL::Image::load( $some_png_file );
   SDL::Video::set_color_key($image, SDL_RLEACCEL, $image->format->colorkey);
@@ -159,7 +160,7 @@ Note: If the image format supports a transparent pixel, SDL:
 
 
    Return
    
 
    
-
    An image as a SDL::Surface. NULL is returned on errors, such as no support built for the image, or a file reading error. Use SDL::get_error to get cause of error.
    
+
    An image as a SDL::Surface. NULL is returned on errors, such as no support built for the image, or a file reading error. Use SDL::get_error to get cause of error.
    
 
 
    
 
    load_typed_rw
    
@@ -170,7 +171,7 @@ Note: If the image format supports a transparent pixel, SDL:
 
    
 	
    src
    
 	
    
-		
    The source SDL::RWops as a pointer. The image is loaded from this. 
    
+		
    The source SDL::RWops as a pointer. The image is loaded from this. 
    
 	
    
 	
    freesrc
    
 	
    
@@ -202,7 +203,7 @@ Note: If the image format supports a transparent pixel, SDL:
 
    
 
    Load src for use as a surface. This can load all supported image formats. This method does not guarantee that the format specified by type is the format of the loaded image, except in the case when TGA format is specified (or any other non-magicable format in the future). Using SDL_RWops is not covered here, but they enable you to load from almost any source.
 Note: If the image format loader requires initialization, it will attempt to do that the first time it is needed if you have not already called SDL::Image::init to load support for your image format.
-Note: If the image format supports a transparent pixel, SDL::Image will set the colorkey for the surface. You can enable RLE acceleration on the surface afterwards by calling:
+Note: If the image format supports a transparent pixel, SDL::Image will set the colorkey for the surface. You can enable RLE acceleration on the surface afterwards by calling:
 SDL::Video::set_color_key
    
 
 
@@ -222,7 +223,7 @@ Note: If the image format supports a transparent pixel, SDL:
 
 
    Return 
    
 
    
-
    The image as a new SDL::Surface. NULL is returned on errors. 
    
+
    The image as a new SDL::Surface. NULL is returned on errors. 
    
 
 
    
 
    is_[TYPE]
    
@@ -243,7 +244,7 @@ Note: If the image format supports a transparent pixel, SDL:
 	
    is_XPM
    
 	
    is_XV
    
 
-
    These functions take a SDL::RWOps as a parameter.
    
+
    These functions take a SDL::RWOps as a parameter.
    
 
 
 
    Return
    
@@ -281,12 +282,12 @@ Note: If the image format supports a transparent pixel, SDL:
 	
    load_XPM_rw
    
 	
    load_XV_rw
    
 
-
    These functions take a SDL::RWop as a parameter
    
+
    These functions take a SDL::RWop as a parameter
    
 
 
 
    Return
    
 
    
-
    The image as a new SDL::Surface. NULL is returned on errors, like if the [TYPE] is not supported, or a read error.
    
+
    The image as a new SDL::Surface. NULL is returned on errors, like if the [TYPE] is not supported, or a read error.
    
 
 
    
 
    Example
    
@@ -314,7 +315,7 @@ Note: If the image format supports a transparent pixel, SDL:
 
 
    Return
    
 
    
-
    The image as a new SDL::Surface. NULL is returned on errors, like if XPM is not supported, or a read error. 
    
+
    The image as a new SDL::Surface. NULL is returned on errors, like if XPM is not supported, or a read error. 
    
 
 
    
 
    Example
    
@@ -377,7 +378,7 @@ Note: If the image format supports a transparent pixel, SDL:
 
 
    Return
    
 
    
-
    Returns a SDL::Version object
    
+
    Returns a SDL::Version object
    
 
 
    
 
    Example
    
@@ -449,7 +450,12 @@ Note: this function does not always set the error string, so do not depend on SD
 
 
    SEE ALSO
    Top
    
 
    
-
    SDL, SDL::Surface, SDL::Video, SDL::RWOps
    
+
    SDL, SDL::Surface, SDL::Video, SDL::RWOps
    
+
+
    
+
    AUTHORS
    Top
    
+
    
+
    See AUTHORS in SDL.
    
 
 
    
 
\ No newline at end of file