/* rbSFML - Copyright (c) 2010 Henrik Valter Vogelius Hansson - groogy@groogy.se * This software is provided 'as-is', without any express or * implied warranty. In no event will the authors be held * liable for any damages arising from the use of this software. * * Permission is granted to anyone to use this software for any purpose, * including commercial applications, and to alter it and redistribute * it freely, subject to the following restrictions: * * 1. The origin of this software must not be misrepresented; * you must not claim that you wrote the original software. * If you use this software in a product, an acknowledgment * in the product documentation would be appreciated but * is not required. * * 2. Altered source versions must be plainly marked as such, * and must not be misrepresented as being the original software. * * 3. This notice may not be removed or altered from any * source distribution. */ #include "Image.hpp" #include "Color.hpp" #include "Rect.hpp" #include "main.hpp" #include #include VALUE globalImageClass; /* External classes */ extern VALUE globalColorClass; extern VALUE globalRectClass; /* Free a heap allocated object * Not accessible trough ruby directly! */ static void Image_Free( sf::Image *anObject ) { delete anObject; } /* call-seq: * image.loadFromFile( filename ) -> true or false * * Load the image from a file on disk. * * The supported image formats are bmp, png, tga, jpg, dds and psd. Some format options are not supported, like * progressive jpeg. The maximum size for an image depends on the graphics driver and can be retrieve with the * GetMaximumSize function. */ static VALUE Image_LoadFromFile( VALUE self, VALUE aFileName ) { sf::Image *object = NULL; Data_Get_Struct( self, sf::Image, object ); if( object->LoadFromFile( rb_string_value_cstr( &aFileName ) ) == true ) { return Qtrue; } else { return Qfalse; } } /* call-seq: * image.loadFromPixels( width, height, pixels ) -> true or false * * Load the image from an array of pixels. * * The pixels argument must point to an array of 32 bits RGBA pixels. In other words, the pixel array must have * this memory layout: * * [r0 g0 b0 a0 r1 g1 b1 a1 r2...] */ static VALUE Image_LoadFromPixels( VALUE self, VALUE aWidth, VALUE aHeight, VALUE somePixels ) { const unsigned int rawWidth = FIX2UINT( aWidth ); const unsigned int rawHeight = FIX2UINT( aHeight ); VALIDATE_CLASS( somePixels, rb_cArray, "pixels" ); const unsigned long dataSize = rawWidth * rawHeight * 4; sf::Uint8 * const tempData = new sf::Uint8[dataSize]; VALUE pixels = rb_funcall( somePixels, rb_intern("flatten"), 0 ); for(unsigned long index = 0; index < dataSize; index++) { sf::Uint8 val = NUM2CHR( rb_ary_entry( pixels, index ) ); tempData[index] = val; } sf::Image *object = NULL; Data_Get_Struct( self, sf::Image, object ); bool result = object->LoadFromPixels( rawWidth, rawHeight, tempData ); delete[] tempData; if( result == true ) { return Qtrue; } else { return Qfalse; } } /* call-seq: * image.saveToFile( filename ) -> true or false * * Save the image to a file on disk. * * The format of the image is automatically deduced from the extension. The supported image formats are bmp, png, * tga, jpg, dds and psd. The destination file is overwritten if it already exists. */ static VALUE Image_SaveToFile( VALUE self, VALUE aFileName ) { sf::Image *object = NULL; Data_Get_Struct( self, sf::Image, object ); if( object->SaveToFile( rb_string_value_cstr( &aFileName ) ) == true ) { return Qtrue; } else { return Qfalse; } } /* call-seq: * image.create( width, height, color = SFML::Color::Black ) -> true or false * * Create the image and fill it with a unique color. */ static VALUE Image_Create( int argc, VALUE *args, VALUE self ) { sf::Image *object = NULL; Data_Get_Struct( self, sf::Image, object ); unsigned int width = 0; unsigned int height = 0; VALUE rubyColor = Qnil; sf::Color color; switch( argc ) { case 3: rubyColor = Color_ForceType( args[2] ); color.r = FIX2INT( Color_GetR( rubyColor ) ); color.g = FIX2INT( Color_GetG( rubyColor ) ); color.b = FIX2INT( Color_GetB( rubyColor ) ); color.a = FIX2INT( Color_GetA( rubyColor ) ); case 2: width = FIX2UINT( args[0] ); height = FIX2UINT( args[1] ); break; default: rb_raise( rb_eArgError, "Expected 2 or 3 arguments but was given %d", argc ); } return ( object->Create( width, height, color ) == true ? Qtrue : Qfalse ); } /* call-seq: * image.createMaskFromColor( color, alpha = 0 ) * * Create a transparency mask from a specified colorkey. * * This function sets the alpha value of every pixel matching the given color to alpha (0 by default), * so that they become transparent. */ static VALUE Image_CreateMaskFromColor( int argc, VALUE *args, VALUE self ) { sf::Image *object = NULL; Data_Get_Struct( self, sf::Image, object ); sf::Uint8 alpha = 0; VALUE rubyColor = Qnil; sf::Color color; switch( argc ) { case 2: alpha = FIX2UINT( alpha ); case 1: rubyColor = Color_ForceType( args[0] ); color.r = FIX2INT( Color_GetR( rubyColor ) ); color.g = FIX2INT( Color_GetG( rubyColor ) ); color.b = FIX2INT( Color_GetB( rubyColor ) ); color.a = FIX2INT( Color_GetA( rubyColor ) ); break; default: rb_raise( rb_eArgError, "Expected 1 or 2 arguments but was given %d", argc ); } object->CreateMaskFromColor( color, alpha ); return Qnil; } /* call-seq: * image.copy( source, destX, destY, sourceRect = [0, 0, 0, 0], applyAlpha = false ) * * Copy pixels from another image onto this one. * * This function does a slow pixel copy and should only be used at initialization time. It can be used to prepare * a complex static image from several others, but if you need this kind of feature in real-time you'd better use * SFML::RenderImage. If sourceRect is empty, the whole image is copied. If applyAlpha is set to true, the * transparency of source pixels is applied. If it is false, the pixels are copied unchanged with their alpha value. */ static VALUE Image_Copy( int argc, VALUE *args, VALUE self ) { sf::Image *source; unsigned int destX = 0; unsigned int destY = 0; sf::IntRect sourceRect = sf::IntRect(0, 0, 0, 0); VALUE rubySourceRect = Qnil; bool applyAlpha = false; switch( argc ) { case 5: if( args[4] == Qtrue ) { applyAlpha = true; } else if( args[4] == Qfalse ) { applyAlpha = false; } else { VALIDATE_CLASS( args[4], rb_cTrueClass, "applyAlpha" ); } case 4: rubySourceRect = Rect_ForceType( args[3] ); sourceRect.Left = FIX2INT( Rect_GetLeft( rubySourceRect ) ); sourceRect.Top = FIX2INT( Rect_GetTop( rubySourceRect ) ); sourceRect.Width = FIX2INT( Rect_GetWidth( rubySourceRect ) ); sourceRect.Height = FIX2INT( Rect_GetHeight( rubySourceRect ) ); case 3: VALIDATE_CLASS( args[0], globalImageClass, "source" ); Data_Get_Struct( args[0], sf::Image, source ); destX = FIX2UINT( args[1] ); destX = FIX2UINT( args[2] ); break; default: rb_raise( rb_eArgError, "Expected 3..5 arguments but was given %d", argc ); } sf::Image *object = NULL; Data_Get_Struct( self, sf::Image, object ); object->Copy( *source, destX, destY, sourceRect, applyAlpha ); return Qnil; } /* call-seq: * image.copyScreen( window, sourceRect = [0, 0, 0, 0] ) -> true or false * * Copy the contents of a window to the image. * * If sourceRect is empty, the whole window is copied. Warning: this is a slow operation, if you need to draw dynamic * contents to an image then use SFML::RenderImage. */ static VALUE Image_CopyScreen( int argc, VALUE *args, VALUE self ) { sf::RenderWindow *source; sf::IntRect sourceRect = sf::IntRect(0, 0, 0, 0); VALUE rubySourceRect = Qnil; switch( argc ) { case 2: rubySourceRect = Rect_ForceType( args[3] ); sourceRect.Left = FIX2INT( Rect_GetLeft( rubySourceRect ) ); sourceRect.Top = FIX2INT( Rect_GetTop( rubySourceRect ) ); sourceRect.Width = FIX2INT( Rect_GetWidth( rubySourceRect ) ); sourceRect.Height = FIX2INT( Rect_GetHeight( rubySourceRect ) ); case 1: VALIDATE_CLASS( args[0], globalImageClass, "source" ); Data_Get_Struct( args[0], sf::RenderWindow, source ); break; default: rb_raise( rb_eArgError, "Expected 1 or 2 arguments but was given %d", argc ); } sf::Image *object = NULL; Data_Get_Struct( self, sf::Image, object ); if( object->CopyScreen( *source, sourceRect ) == true ) { return Qtrue; } else { return Qfalse; } } /* call-seq: * image.setPixel( x, y, color ) * * Change the color of a pixel. * * This function doesn't check the validity of the pixel coordinates, using out-of-range values will * result in an undefined behaviour. */ static VALUE Image_SetPixel( VALUE self, VALUE aX, VALUE aY, VALUE aColor ) { VALUE rbColor = Color_ForceType( aColor ); sf::Color color; color.r = FIX2INT( Color_GetR( rbColor ) ); color.g = FIX2INT( Color_GetG( rbColor ) ); color.b = FIX2INT( Color_GetB( rbColor ) ); color.a = FIX2INT( Color_GetA( rbColor ) ); sf::Image *object = NULL; Data_Get_Struct( self, sf::Image, object ); object->SetPixel( FIX2INT( aX ), FIX2INT( aY ), color ); return Qnil; } /* call-seq: * image.getPixel( x, y ) -> color * * Get the color of a pixel. * * This function doesn't check the validity of the pixel coordinates, using out-of-range values will * result in an undefined behaviour. */ static VALUE Image_GetPixel( VALUE self, VALUE aX, VALUE aY ) { sf::Image *object = NULL; Data_Get_Struct( self, sf::Image, object ); const sf::Color color = object->GetPixel( FIX2INT( aX ), FIX2INT( aY ) ); return rb_funcall( globalColorClass, rb_intern( "new" ), 4, INT2FIX( color.r ), INT2FIX( color.g ), INT2FIX( color.b ), INT2FIX( color.a ) ); } /* call-seq: * image.getPixelsPtr() -> array of pixels * * Get a read-only pointer to the array of pixels. * * The returned value points to an array of RGBA pixels made of 8 bits integers components. * The size of the array is width * height * 4. Warning: the returned pointer may become invalid if * you modify the image, so you should never store it for too long. */ static VALUE Image_GetPixelsPtr( VALUE self ) { sf::Image *object = NULL; Data_Get_Struct( self, sf::Image, object ); const unsigned int rawWidth = object->GetWidth(); const unsigned int rawHeight = object->GetHeight(); const unsigned long dataSize = rawWidth * rawHeight * 4; VALUE pixels = rb_ary_new2( dataSize ); const sf::Uint8 *const pixelPointer = object->GetPixelsPtr(); for(unsigned long index = 0; index < dataSize; index++) { rb_ary_store( pixels, index, CHR2FIX( pixelPointer[index] ) ); } return pixels; } /* call-seq: * image.updatePixels( pixels, rectangle = [0, 0, image.width, image.height] ) * * Update a sub-rectangle of the image from an array of pixels. * * The pixels array is assumed to store RGBA 32 bits pixels. Warning: for performances reasons, this function doesn't * perform any check; thus you're responsible of ensuring that rectangle does not exceed the image size, and that * pixels contains enough elements. */ static VALUE Image_UpdatePixels( int argc, VALUE *args, VALUE self ) { sf::Image *object = NULL; Data_Get_Struct( self, sf::Image, object ); VALUE somePixels = Qnil; VALUE aRectangle = Qnil; sf::IntRect rectangle = sf::IntRect(0, 0, object->GetWidth(), object->GetHeight() ); switch( argc ) { case 2: aRectangle = Rect_ForceType( args[1] ); rectangle.Left = FIX2INT( Rect_GetLeft( aRectangle ) ); rectangle.Top = FIX2INT( Rect_GetTop( aRectangle ) ); rectangle.Width = FIX2INT( Rect_GetWidth( aRectangle ) ); rectangle.Height = FIX2INT( Rect_GetHeight( aRectangle ) ); case 1: VALIDATE_CLASS( args[0], rb_cArray, "pixels" ); somePixels = args[0]; break; default: rb_raise( rb_eArgError, "Expected 1 or 2 arguments but was given %d", argc ); } const unsigned int rawWidth = FIX2UINT( rectangle.Width ); const unsigned int rawHeight = FIX2UINT( rectangle.Height ); const unsigned long dataSize = rawWidth * rawHeight * 4; sf::Uint8 * const tempData = new sf::Uint8[dataSize]; VALUE pixels = rb_funcall( somePixels, rb_intern("flatten"), 0 ); for(unsigned long index = 0; index < dataSize; index++) { sf::Uint8 val = NUM2CHR( rb_ary_entry( pixels, index ) ); tempData[index] = val; } object->UpdatePixels( tempData, rectangle ); delete[] tempData; return Qnil; } /* call-seq: * image.bind() * * Activate the image for rendering. * * This function is mainly used internally by the SFML render system. However it can be useful when * using SFML::Image together with OpenGL code (it calls glBindTexture). */ static VALUE Image_Bind( VALUE self ) { sf::Image *object = NULL; Data_Get_Struct( self, sf::Image, object ); object->Bind(); return Qnil; } /* call-seq: * image.setSmooth( smooth ) * * Enable or disable the smooth filter. * * When the filter is activated, the image appears smoother so that pixels are less noticeable. However if you want * the image to look exactly the same as its source file, you should disable it. The smooth filter is enabled * by default. */ static VALUE Image_SetSmooth( VALUE self, VALUE aSmoothFlag ) { sf::Image *object = NULL; Data_Get_Struct( self, sf::Image, object ); if( aSmoothFlag == Qtrue ) { object->SetSmooth( true ); } else if( aSmoothFlag == Qfalse ) { object->SetSmooth( false ); } else { VALIDATE_CLASS( aSmoothFlag, rb_cTrueClass, "smoothFlag" ); } return Qnil; } /* call-seq: * image.isSmooth() -> true or false * * Tell whether the smooth filter is enabled or not. */ static VALUE Image_IsSmooth( VALUE self ) { sf::Image *object = NULL; Data_Get_Struct( self, sf::Image, object ); return ( object->IsSmooth() == true ? Qtrue : Qfalse ); } /* call-seq: * image.getWidth() -> width * * Return the width of the image. */ static VALUE Image_GetWidth( VALUE self ) { sf::Image *object = NULL; Data_Get_Struct( self, sf::Image, object ); return INT2FIX( object->GetWidth() ); } /* call-seq: * image.getHeight() -> height * * Return the height of the image. */ static VALUE Image_GetHeight( VALUE self ) { sf::Image *object = NULL; Data_Get_Struct( self, sf::Image, object ); return INT2FIX( object->GetHeight() ); } /* call-seq: * image.getTexCoords( rectangle ) -> tex coordinates rectangle * * Convert a rectangle of pixels into texture coordinates. * * This function is used by code that needs to map the image to some OpenGL geometry. It converts the source * rectangle, expressed in pixels, to float coordinates in the range [0, 1]. */ static VALUE Image_GetTexCoords( VALUE self, VALUE aRectangle ) { VALUE rubyRectangle = Rect_ForceType( aRectangle ); sf::IntRect rectangle; rectangle.Left = FIX2INT( Rect_GetLeft( aRectangle ) ); rectangle.Top = FIX2INT( Rect_GetTop( aRectangle ) ); rectangle.Width = FIX2INT( Rect_GetWidth( aRectangle ) ); rectangle.Height = FIX2INT( Rect_GetHeight( aRectangle ) ); sf::Image *object = NULL; Data_Get_Struct( self, sf::Image, object ); sf::FloatRect result = object->GetTexCoords( rectangle ); return rb_funcall( globalRectClass, rb_intern( "new" ), 4, rb_float_new( result.Left ), rb_float_new( result.Top ), rb_float_new( result.Width ), rb_float_new( result.Height ) ); } static VALUE Image_InitializeCopy( VALUE self, VALUE aSource ) { sf::Image *object = NULL; Data_Get_Struct( self, sf::Image, object ); sf::Image *source = NULL; Data_Get_Struct( aSource, sf::Image, source ); *object = *source; } /* call-seq: * Image.new() -> image * * Creates an image instance for us. */ static VALUE Image_New( int argc, VALUE *args, VALUE aKlass ) { sf::Image *object = new sf::Image(); VALUE rbData = Data_Wrap_Struct( aKlass, 0, Image_Free, object ); rb_obj_call_init( rbData, argc, args ); return rbData; } /* call-seq: * Image.getMaximumSize() -> size * * Get the maximum image size allowed. * * This maximum size is defined by the graphics driver. You can expect a value of 512 pixels for low-end graphics * card, and up to 8192 pixels for newer hardware. */ static VALUE Image_GetMaximumSize( VALUE aKlass ) { return INT2FIX( sf::Image::GetMaximumSize() ); } void Init_Image( void ) { /* SFML namespace which contains the classes of this module. */ VALUE sfml = rb_define_module( "SFML" ); /* Class for loading, manipulating and saving images. * * SFML::Image is an abstraction to manipulate images as bidimensional arrays of pixels. * * The class provides functions to load, read, write and save pixels, as well as many other useful functions to... * * SFML::Image can handle a unique internal representation of pixels, which is RGBA 32 bits. This means that a pixel * must be composed of 8 bits red, green, blue and alpha channels -- just like a SFML::Color. All the functions that * return an array of pixels follow this rule, and all parameters that you pass to sf::Image functions (such as * loadFromPixels or updatePixels) must use this representation as well. * * A SFML::Image can be copied, but it is a heavy resource and if possible you should always use [const] references * to pass or return them to avoid useless copies. * * Usage example: * * # Load an image file * background = SFML::Image.new; * if background.loadFromFile( "background.jpg" ) == false * # Error * end * * # Create a 20x20 image filled with black color * image = SFML::Image.new; * if image.create( 20, 20, SFML::Color::Black ) == false * # Error * end * * # Copy image1 on image2 at position (10, 10) * image.copy( background, 10, 10 ) * * # Make the top-left pixel transparent * color = image.getPixel( 0, 0 ) * color.a = 0 * image.setPixel( 0, 0, color ) * * # Save the image to a file * if image.saveToFile( "result.png" ) == false * # Error * end */ globalImageClass = rb_define_class_under( sfml, "Image", rb_cObject ); // Class methods rb_define_singleton_method( globalImageClass, "new", Image_New, -1 ); rb_define_singleton_method( globalImageClass, "getMaximumSize", Image_GetMaximumSize, 0 ); // Instance methods rb_define_method( globalImageClass, "initialize_copy", Image_InitializeCopy, 1 ); rb_define_method( globalImageClass, "loadFromFile", Image_LoadFromFile, 1 ); rb_define_method( globalImageClass, "loadFromPixels", Image_LoadFromPixels, 3 ); rb_define_method( globalImageClass, "saveToFile", Image_SaveToFile, 1 ); rb_define_method( globalImageClass, "create", Image_Create, -1 ); rb_define_method( globalImageClass, "createMaskFromColor", Image_CreateMaskFromColor, -1 ); rb_define_method( globalImageClass, "copy", Image_Copy, -1 ); rb_define_method( globalImageClass, "copyScreen", Image_CopyScreen, -1 ); rb_define_method( globalImageClass, "setPixel", Image_SetPixel, 3 ); rb_define_method( globalImageClass, "getPixel", Image_GetPixel, 2 ); rb_define_method( globalImageClass, "getPixelsPtr", Image_GetPixelsPtr, 0 ); rb_define_method( globalImageClass, "updatePixels", Image_UpdatePixels, -1 ); rb_define_method( globalImageClass, "bind", Image_Bind, 0 ); rb_define_method( globalImageClass, "setSmooth", Image_SetSmooth, 1 ); rb_define_method( globalImageClass, "isSmooth", Image_IsSmooth, 0 ); rb_define_method( globalImageClass, "getWidth", Image_GetWidth, 0 ); rb_define_method( globalImageClass, "getHeight", Image_GetHeight, 0 ); rb_define_method( globalImageClass, "getTexCoords", Image_GetTexCoords, 1 ); // Class aliases rb_define_alias( CLASS_OF( globalImageClass ), "maximumSize", "getMaximumSize" ); rb_define_alias( CLASS_OF( globalImageClass ), "maximum_size", "getMaximumSize" ); // Instance Aliases rb_define_alias( globalImageClass, "load_from_file", "loadFromFile"); rb_define_alias( globalImageClass, "loadFile", "loadFromFile"); rb_define_alias( globalImageClass, "load_file", "loadFromFile"); rb_define_alias( globalImageClass, "load_from_pixels", "loadFromPixels"); rb_define_alias( globalImageClass, "loadPixels", "loadFromPixels"); rb_define_alias( globalImageClass, "load_pixels", "loadFromPixels"); rb_define_alias( globalImageClass, "save_to_file", "saveToFile"); rb_define_alias( globalImageClass, "save", "saveToFile"); rb_define_alias( globalImageClass, "create_mask_from_color", "createMaskFromColor"); rb_define_alias( globalImageClass, "create_mask", "createMaskFromColor"); rb_define_alias( globalImageClass, "createMask", "createMaskFromColor"); rb_define_alias( globalImageClass, "copy_screen", "copyScreen"); rb_define_alias( globalImageClass, "set_pixel", "setPixel"); rb_define_alias( globalImageClass, "get_pixel", "getPixel"); rb_define_alias( globalImageClass, "get_pixels_ptr", "getPixelsPtr"); rb_define_alias( globalImageClass, "pixelsPtr", "getPixelsPtr"); rb_define_alias( globalImageClass, "pixels_ptr", "getPixelsPtr"); rb_define_alias( globalImageClass, "getPixels", "getPixelsPtr"); rb_define_alias( globalImageClass, "get_pixels", "getPixelsPtr"); rb_define_alias( globalImageClass, "pixels", "getPixelsPtr"); rb_define_alias( globalImageClass, "update_pixels", "updatePixels"); rb_define_alias( globalImageClass, "set_smooth", "setSmooth"); rb_define_alias( globalImageClass, "smooth=", "setSmooth"); rb_define_alias( globalImageClass, "is_smooth", "isSmooth"); rb_define_alias( globalImageClass, "smooth?", "isSmooth"); rb_define_alias( globalImageClass, "smooth", "isSmooth"); rb_define_alias( globalImageClass, "get_width", "getWidth"); rb_define_alias( globalImageClass, "width", "getWidth"); rb_define_alias( globalImageClass, "get_height", "getHeight"); rb_define_alias( globalImageClass, "height", "getHeight"); rb_define_alias( globalImageClass, "get_tex_coords", "getTexCoords"); }