Documentation of the MLV-2.0.2 library

/*
 *   This file is part of the MLV Library.
 *
 *   Copyright (C) 2010,2011,2012 Adrien Boussicault, Marc Zipstein
 *
 *
 *    This Library is free software: you can redistribute it and/or modify
 *    it under the terms of the GNU General Public License as published by
 *    the Free Software Foundation, either version 3 of the License, or
 *    (at your option) any later version.
 *
 *    This Library is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *    GNU General Public License for more details.
 *
 *    You should have received a copy of the GNU General Public License
 *    along with this Library.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef __MLV__MLV_IMAGE_H__
#define __MLV__MLV_IMAGE_H__

#include "MLV_color.h"

#ifdef __cplusplus
extern "C" {
#endif

typedef struct _MLV_Image MLV_Image;

MLV_Image* MLV_load_image( const char* file_image );


int MLV_save_image_as_bmp( const MLV_Image* image,  const char* file_image );

MLV_Image* MLV_create_image( int width, int height );

void MLV_free_image( MLV_Image *image );

MLV_Image* MLV_copy_image( const MLV_Image* image );

MLV_Image* MLV_copy_partial_image(
        const MLV_Image* image, int x, int y, int width, int height
);

void MLV_get_image_size( const MLV_Image* image, int* width, int* height );

int MLV_get_image_width( const MLV_Image* image );

int MLV_get_image_height( const MLV_Image* image );


void MLV_resize_image( MLV_Image* image, int width, int height );

void MLV_vertical_image_mirror( MLV_Image* image );

void MLV_horizontal_image_mirror( MLV_Image* image );

void MLV_resize_image_with_proportions(
        MLV_Image* image, int width, int height
);

void MLV_scale_image( MLV_Image* image, double scalar );

void MLV_rotate_image( MLV_Image* image, double rotation );

void MLV_rotate_and_scale_image( MLV_Image* image, double rotation, double scalar );

void MLV_scale_xy_image( MLV_Image* image, double scalar_x, double scalar_y );

void MLV_rotate_and_scale_xy_image(
        MLV_Image* image, double rotation, double scalar_x, double scalar_y 
);

void MLV_draw_image( const MLV_Image *image, int x, int y );

void MLV_draw_partial_image(
        const MLV_Image *image, int x_source, int y_source, 
        int width_source, int height_source, 
        int x, int y
);


void MLV_set_alpha_on_image( MLV_Alpha alpha, MLV_Image *image );

void MLV_set_pixel_on_image(
        int x, int y,
        MLV_Color color, 
        MLV_Image *image
);

void MLV_get_pixel(
        int x, int y, int* red, int* green, int* blue, int* alpha
);

void MLV_get_pixel_on_image(
        const MLV_Image* image, int x, int y,
        int* red, int* green, int* blue, int* alpha
);

void MLV_draw_partial_image_on_image(
        const MLV_Image* source_image,
        int source_x, int source_y,
        int width, int height,
        MLV_Image* destination_image,
        int destination_x, int destination_y
);

void MLV_draw_image_on_image(
        const MLV_Image* source_image,
        MLV_Image* destination_image,
        int destination_x, int destination_y
);

SDL_Surface* MLV_get_image_data( MLV_Image* image );

void MLV_save_screen();

void MLV_load_screen();

// TODO
#if 0

typedef enum {
        MLV_NONE,
        MLV_REPLACE,
        MLV_MAX,
        MLV_MIN,
        MLV_BARYCENTER
} MLV_Mathematic_operations;


void MLV_draw_partial_image_on_image(
        const MLV_Image* source_image,
        int source_x, int source_y,
        int with, int height,
        MLV_Image* destination_image,
        int destination_x, int destination_y,
        MLV_Mathematic_operations rgb_treatment,
        MLV_Mathematic_operations alpha_treatment
);

void MLV_draw_partial_image_on_image_FAST(
        const MLV_Image* source_image,
        int source_x, int source_y,
        int with, int height,
        const MLV_Image* destination_image,
        int destination_x, int destination_y
);
#endif

/* TODO  : A Vérifier !
void MLV_draw_rotated_image(  MLV_Image *image, int x, int y, double rotation );
void MLV_draw_scaled_image(  MLV_Image *image, int x, int y, double scalar );
void MLV_draw_scaled_rotated_image(  MLV_Image *image, int x, int y, double roation, double scalar );
*/

#ifdef __cplusplus
}
#endif

#endif