@@ -50,6 +50,10 @@ class Rubygame::Surface private :_draw_line + # *IMPORTANT*: this method only exists if SDL_gfx is available! + # Your code should check "surface.respond_to?(:draw_line)" to see if + # you can use this method, or be prepared to rescue from NameError. + # # Draw a line segment between two points on the Surface. # See also #draw_line_a # @@ -65,6 +69,10 @@ class Rubygame::Surface end + # *IMPORTANT*: this method only exists if SDL_gfx is available! + # Your code should check "surface.respond_to?(:draw_line_a)" to see if + # you can use this method, or be prepared to rescue from NameError. + # # Like #draw_line, but the line will be anti-aliased. # def draw_line_a( point1, point2, color ) @@ -90,6 +98,10 @@ class Rubygame::Surface private :_draw_box + # *IMPORTANT*: this method only exists if SDL_gfx is available! + # Your code should check "surface.respond_to?(:draw_box)" to see if + # you can use this method, or be prepared to rescue from NameError. + # # Draw a non-solid box (rectangle) on the Surface, given the # coordinates of its top-left corner and bottom-right corner. See # also #draw_box_s @@ -106,6 +118,11 @@ class Rubygame::Surface end + # *IMPORTANT*: this method only exists if SDL_gfx is available! + # Your code should check "surface.respond_to?(:draw_box_s)" to see + # if you can use this method, or be prepared to rescue from + # NameError. + # # Like #draw_box, but the shape is solid, instead of an outline. # (You may find using #fill to be more convenient and perhaps faster # than this method.) @@ -135,6 +152,11 @@ class Rubygame::Surface private :_draw_circle + # *IMPORTANT*: this method only exists if SDL_gfx is available! + # Your code should check "surface.respond_to?(:draw_circle)" to see + # if you can use this method, or be prepared to rescue from + # NameError. + # # Draw a non-solid circle on the Surface, given the coordinates of its # center and its radius. See also #draw_circle_a and #draw_circle_s # @@ -150,6 +172,10 @@ class Rubygame::Surface end + # *IMPORTANT*: this method only exists if SDL_gfx is available! + # Your code should check "surface.respond_to?(:draw_circle_a)" to see if + # you can use this method, or be prepared to rescue from NameError. + # # Like #draw_circle, but the outline is anti-aliased. # def draw_circle_a( center, radius, color ) @@ -158,6 +184,11 @@ class Rubygame::Surface end + # *IMPORTANT*: this method only exists if SDL_gfx is available! + # Your code should check "surface.respond_to?(:draw_circle_s)" to + # see if you can use this method, or be prepared to rescue from + # NameError. + # # Like #draw_circle, but the shape is solid, instead of an outline. # def draw_circle_s( center, radius, color ) @@ -185,6 +216,11 @@ class Rubygame::Surface private :_draw_ellipse + # *IMPORTANT*: this method only exists if SDL_gfx is available! + # Your code should check "surface.respond_to?(:draw_ellipse)" to see + # if you can use this method, or be prepared to rescue from + # NameError. + # # Draw a non-solid ellipse (oval) on the Surface, given the # coordinates of its center and its horizontal and vertical radii. # See also #draw_ellipse_a and #draw_ellipse_s @@ -201,6 +237,10 @@ class Rubygame::Surface end + # *IMPORTANT*: this method only exists if SDL_gfx is available! + # Your code should check "surface.respond_to?(:draw_ellipse_a)" to see if + # you can use this method, or be prepared to rescue from NameError. + # # Like #draw_ellipse, but the ellipse border is anti-aliased. # def draw_ellipse_a( center, radii, color ) @@ -209,6 +249,11 @@ class Rubygame::Surface end + # *IMPORTANT*: this method only exists if SDL_gfx is available! + # Your code should check "surface.respond_to?(:draw_ellipse_s)" to + # see if you can use this method, or be prepared to rescue from + # NameError. + # # Like #draw_ellipse, but the shape is solid, instead of an outline. # def draw_ellipse_s( center, radii, color ) @@ -235,6 +280,10 @@ class Rubygame::Surface private :_draw_arc + # *IMPORTANT*: this method only exists if SDL_gfx is available! + # Your code should check "surface.respond_to?(:draw_arc)" to see if + # you can use this method, or be prepared to rescue from NameError. + # # Draw a non-solid arc (part of a circle), given the coordinates of # its center, radius, and starting/ending angles. # See also #draw_arc_s @@ -254,6 +303,11 @@ class Rubygame::Surface end + # *IMPORTANT*: this method only exists if SDL_gfx is available! + # Your code should check "surface.respond_to?(:draw_arc_s)" to see + # if you can use this method, or be prepared to rescue from + # NameError. + # # Like #draw_arc, but the shape is solid, instead of an outline. # def draw_arc_s( center, radius, angles, color ) @@ -288,6 +342,11 @@ class Rubygame::Surface private :_draw_polygon + # *IMPORTANT*: this method only exists if SDL_gfx is available! + # Your code should check "surface.respond_to?(:draw_polygon)" to see + # if you can use this method, or be prepared to rescue from + # NameError. + # # Draw a non-solid polygon, given the coordinates of its vertices, in the # order that they are connected. This is essentially a series of connected # dots. See also #draw_polygon_a and #draw_polygon_s. @@ -305,6 +364,11 @@ class Rubygame::Surface end + # *IMPORTANT*: this method only exists if SDL_gfx is available! + # Your code should check "surface.respond_to?(:draw_polygon_a)" to + # see if you can use this method, or be prepared to rescue from + # NameError. + # # Like #draw_polygon, but the lines are anti-aliased. # def draw_polygon_a( points, color ) @@ -313,6 +377,11 @@ class Rubygame::Surface end + # *IMPORTANT*: this method only exists if SDL_gfx is available! + # Your code should check "surface.respond_to?(:draw_polygon_s)" to + # see if you can use this method, or be prepared to rescue from + # NameError. + # # Like #draw_polygon, but the shape is solid, instead of an outline. # def draw_polygon_s( points, color ) @@ -322,6 +391,10 @@ class Rubygame::Surface + # *IMPORTANT*: this method only exists if SDL_gfx is available! + # Your code should check "surface.respond_to?(:rotozoom)" to see if + # you can use this method, or be prepared to rescue from NameError. + # # Return a rotated and/or zoomed version of the given surface. Note # that rotating a Surface anything other than a multiple of 90 # degrees will cause the new surface to be larger than the original @@ -364,6 +437,11 @@ class Rubygame::Surface end + # *IMPORTANT*: this method only exists if SDL_gfx is available! + # Your code should check "surface.respond_to?(:rotozoom_size)" to + # see if you can use this method, or be prepared to rescue from + # NameError. + # # Return the dimensions of the surface that would be returned if # #rotozoom were called on a Surface of the given size, with # the same angle and zoom factors. @@ -395,6 +473,10 @@ class Rubygame::Surface + # *IMPORTANT*: this method only exists if SDL_gfx is available! + # Your code should check "surface.respond_to?(:zoom)" to see if you + # can use this method, or be prepared to rescue from NameError. + # # Return a zoomed version of the Surface. # # This method takes these arguments: @@ -426,6 +508,10 @@ class Rubygame::Surface + # *IMPORTANT*: this method only exists if SDL_gfx is available! + # Your code should check "surface.respond_to?(:zoom_size)" to see if + # you can use this method, or be prepared to rescue from NameError. + # # Return the dimensions of the surface that would be returned if # #zoom were called on a Surface of the given size, with the same # zoom factors. @@ -453,6 +539,10 @@ class Rubygame::Surface + # *IMPORTANT*: this method only exists if SDL_gfx is available! + # Your code should check "surface.respond_to?(:zoom_to)" to see if + # you can use this method, or be prepared to rescue from NameError. + # # Return a version of the Surface zoomed to a new size. # # This method takes these arguments: @@ -478,6 +568,10 @@ class Rubygame::Surface + # *IMPORTANT*: this method only exists if SDL_gfx is available! + # Your code should check "surface.respond_to?(:flip)" to see if you + # can use this method, or be prepared to rescue from NameError. + # # Flips the source surface horizontally (if +horz+ is true), vertically # (if +vert+ is true), or both (if both are true). # lib/rubygame/gfx.rb @@ -46,14 +46,16 @@ class Rubygame::Surface end + # *IMPORTANT*: this method only exists if SDL_image is available! + # Your code should check "defined?(Rubygame::Surface.load) != nil" + # to see if you can use this method, or be prepared to rescue from + # NameError. + # # Load an image file from the disk to a Surface. If the image has an alpha # channel (e.g. PNG with transparency), the Surface will as well. If the # image cannot be loaded (for example if the image format is unsupported), # will raise SDLError. # - # This method is only usable if Rubygame was compiled with the SDL_image - # library; you can check Rubygame::VERSIONS[:sdl_image] to see if it was. - # # This method takes this argument: # filename:: a string containing the relative or absolute path to the # image file. The file must have the proper file extension, @@ -92,16 +94,18 @@ class Rubygame::Surface end + # *IMPORTANT*: this method only exists if SDL_image is available! + # Your code should check + # "defined?(Rubygame::Surface.load_from_string) != nil" to see if + # you can use this method, or be prepared to rescue from + # NameError. + # # Load an image file from memory (in the form of the given data) # to a Surface. If the image has an alpha channel (e.g. PNG with # transparency), the Surface will as well. If the image cannot be # loaded (for example if the image format is unsupported), will # raise SDLError. # - # This method is only usable if Rubygame was compiled with the - # SDL_image library; you can check Rubygame::VERSIONS[:sdl_image] - # to see if it was. - # # This method takes these arguments: # data:: a string containing the data for the image, such as # IO::read would return. lib/rubygame/image.rb @@ -19,19 +19,20 @@ -# **IMPORTANT**: Music is only available if Rubygame was compiled -# with SDL_mixer support! +# *IMPORTANT*: this class only exists if SDL_mixer is available! +# Your code should check "defined?(Rubygame::Music) != nil" to see if +# you can use this class, or be prepared to rescue from NameError. # # Music holds a song, streamed from an audio file (see #load for # supported formats). There are two important differences between # the Music and Sound classes: # -# 1. Only one Music can be playing. If you try to play -# a second song, the first one will be stopped. +# 1. Only one Music can be playing. If you try to play +# a second song, the first one will be stopped. # -# 2. Music doesn't load the entire audio file, so it can begin -# quickly and doesn't use much memory. This is good, because -# music files are usually much longer than sound effects! +# 2. Music doesn't load the entire audio file, so it can begin +# quickly and doesn't use much memory. This is good, because +# music files are usually much longer than sound effects! # # Music can #play, #pause/#unpause, #stop, #rewind, #jump_to another # time, adjust #volume, and #fade_out (fade in by passing an option lib/rubygame/music.rb @@ -19,8 +19,9 @@ -# **IMPORTANT**: Sound is only available if Rubygame was compiled -# with SDL_mixer support! +# *IMPORTANT*: this class only exists if SDL_mixer is available! +# Your code should check "defined?(Rubygame::Sound) != nil" to see if +# you can use this class, or be prepared to rescue from NameError. # # Sound holds a sound effect, loaded from an audio file (see #load for # supported formats). lib/rubygame/sound.rb @@ -24,17 +24,16 @@ require "ruby-sdl-ffi/ttf" Rubygame::VERSIONS[:sdl_ttf] = SDL::TTF.Linked_Version().to_ary +# *IMPORTANT*: this class only exists if SDL_ttf is available! +# Your code should check "defined?(Rubygame::TTF) != nil" to see if +# you can use this class, or be prepared to rescue from NameError. +# # TTF provides an interface to SDL_ttf, allowing TrueType Font files to be # loaded and used to render text to Surfaces. # # The TTF class *must* be initialized with the #setup method before any # TTF objects can be created or used. # -# This class is only usable if Rubygame was compiled with the SDL_ttf -# library. You may test if this feature is available with the #usable? -# method. If you need more flexibility, you can check the library version -# that Rubygame was compiled against with the #version method. -# class Rubygame::TTF lib/rubygame/ttf.rb 0817bca3817a9dd6e904b7c31380bb3380b00994 John Croisant jacius@gmail.com http://github.com/jacius/rubygame/commit/10da27886a32394ff49edc1cddbc4538e8294168 10da27886a32394ff49edc1cddbc4538e8294168 2009-10-24T12:11:50-07:00 2009-10-24T12:00:58-07:00 Updated docs for optional modules. Libraries are no longer compiled in, and code should check for module existence with "defined?(Rubygame::Image) != nil", etc. or rescue from NameError. c6b5083369d2c9af860752b199690a6bda5ae683 John Croisant jacius@gmail.com