adesklets.pm -- Perl bindings to the adesklets interpreter

- NAME
- COPYRIGHT
- SYNOPSIS
- DESCRIPTION

- Functions
- Constants

- SEE ALSO

# NAME

adesklets.pm -- Perl bindings to the adesklets interpreter

# COPYRIGHT

Copyright (C) 2006, Lucas Brutschy <lbrutschy@users.sourceforge.net>

Released under the GPL, version 2.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the ``Software''), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies of the Software and its documentation and acknowledgment shall be given in the documentation and software packages that this Software was used.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

# SYNOPSIS

     # Simple desklet: draw red lines following the mouse
     use adesklets;
     adesklets::open_streams();

     # These are just normal adesklet commands
     adesklets::window_resize(100,100);
     adesklets::window_reset(adesklets::WINDOW_UNMANAGED);
     adesklets::window_set_transparency(1);
     adesklets::context_set_color(255,255,255,64);
     adesklets::image_fill_rectangle(5,5,90,90);
     adesklets::window_show();

     adesklets::event_loop(ButtonPress=>\&onbutton); # supply a hash of callbacks
     adesklets::close_streams();

     sub onbutton
     {
        my($x,$y) = @_;
        adesklets::context_set_color(255,0,0,255);
        adesklets::image_fill_rectangle($x,$y,3,3);
     }

# DESCRIPTION

## Functions

     time_gate: Set a time gate
     help: Display short help about a command
     ping: Ping the interpreter
     pause: Freeze the interpreter for debugging
     version: Get interpreter version
     get_id: Get current applet identificator
     history: List/save commands history
     set: Set or unset a textual variable
     unset_all: Unset all defined textual variables
     echo: Echo a string
     start_recording: Start recording a macro
     stop_recording: Stop recording the macro
     play_get_abort_on_events: Get replays interuptable status
     play_set_abort_on_events: Set replays to be interuptable
     play: Play a given macro
     context_get_dither: Get context dither
     context_get_anti_alias: Get context anti alias
     context_get_blend: Get context blending
     context_get_operation: Get context operation
     context_get_cliprect: Get clipping rectange
     context_get_image: Get context image
     context_get_font: Get context font
     context_get_color_range: Get context color range
     context_get_color_modifier: Get context color modifier
     context_get_filter: Get context filter
     context_get_color: Get context color
     context_get_angle: Get context angle
     context_get_direction: Get context direction
     context_set_dither: Set context dither
     context_set_anti_alias: Set context anti-alias
     context_set_blend: Set context blending
     context_set_operation: Set context operation
     context_set_cliprect: Set context clipping rectangle
     context_set_image: Set context image
     context_set_font: Set context font
     context_set_color_range: Set context color range
     context_set_color_modifier: Set context color modifier
     context_set_filter: Set context filter
     context_set_color: Set context RGBA color
     context_set_angle: Set context angle
     context_set_direction: Set context direction
     add_color_to_color_range: Add a color to a color range
     blend_image_onto_image: Blend images together
     blend_image_onto_image_at_angle: Blend images together
     blend_image_onto_image_skewed: Blend images together
     apply_filter: Apply a dynamic filter
     get_text_size: Get size of text
     get_text_advance: Get advance of text
     text_draw: Draw a text string
     modify_color_modifier_gamma: Modify gamma correction
     modify_color_modifier_brightness: Modify brightness
     modify_color_modifier_contrast: Modify contrast
     get_color_modifier_tables: Get tables for a color modifier
     set_color_modifier_tables: Set tables for a color modifier
     get_color_modifier_value: Get a value for a color modifier
     set_color_modifier_value: Set a value for a color modifier
     apply_color_modifier: Apply a color modifier
     apply_color_modifier_to_rectangle: Apply a color modifier
     load_image_without_cache: Load an image from disk bypassing the cache
     load_image: Load an image from disk
     save_image: Save an image to disk
     create_image: Create an image
     create_image_using_data: Create an image from data
     clone_image: Create a copy of an image
     free_image: Free an image
     load_font: Load a font
     free_font: Free a font
     list_fonts: List all fonts
     list_font_path: List all fonts path
     add_path_to_font_path: Add a font path
     remove_path_from_font_path: Remove a font path
     create_color_range: Create a color range
     free_color_range: Free a color range
     create_filter: Create a filter
     free_filter: Free a filter
     create_color_modifier: Create a color modifier
     free_color_modifier: Free a color modifier
     polygon_new: Create a polygon
     polygon_free: Free a polygon
     polygon_add_point: Add point to a polygon
     images_reset_all: Free all images and refresh foreground
     images_info: Get information on all images
     fonts_reset_all: Free all fonts
     fonts_info: Get information on all fonts
     color_ranges_reset_all: Free all color ranges
     color_ranges_info: Get information on all color ranges
     color_modifiers_reset_all: Free all color modifiers
     color_modifiers_info: Get information on all color modifiers
     filters_reset_all: Free all filters
     filters_info: Get information on all filters
     polygons_reset_all: Free all polygons
     polygons_info: Get information on all polygons
     image_has_alpha: Get alpha channel setting of an image
     image_get_width: Get width of an image
     image_get_height: Get height of an image
     image_get_filename: Get filename of an image
     image_get_data: Get the data of an image
     image_query_pixel: Query a pixel value
     image_set_has_alpha: Set alpha channel of an image
     image_set_changes_on_disk: Set image load time behavior
     image_set_format: Set image format
     image_filter_recurse:
     image_draw_line: Draw a line
     image_draw_rectangle: Draw a rectangle
     image_fill_rectangle: Draw a filled rectangle
     image_fill_color_range_rectangle: Draw a gradian filled rectange
     image_draw_ellipse: Draw an ellipse
     image_fill_ellipse: Fill an ellipse
     image_copy_alpha_to_image: Transfert alpha channel
     image_copy_alpha_rectangle_to_image: Transfert alpha channel
     image_draw_polygon: Draw a polygon onto image
     image_fill_polygon: Fill a polygon onto image
     image_flip_horizontal: Flip an image horizontally
     image_flip_vertical: Flip an image vertically
     image_flip_diagonal: Flip an image diagonally
     image_orientate: Orientate an image
     image_blur: Blur an image
     image_sharpen: Sharpen an image
     filter_set: Set filter
     filter_set_red: Set filter red channel
     filter_set_green: Set filter grean channel
     filter_set_blue: Set filter blue channel
     filter_set_alpha: Set filter alpha channel
     filter_constants: Set filter constants
     filter_divisors: Set filter divisors
     menu_fire: Fire a given menu
     menu_reset_all: Reset all menus to initial state
     menu_add_menu: Add a new menu
     menu_add_submenu: Add a submenu to current menu
     menu_add_item: Add an item to current menu
     menu_add_separator: Add a separator to current menu
     menu_end_submenu: End a submenu construction
     events_info: Get all caught events
     events_get_echo: Get events echo status
     events_get_send_sigusr1: Get sending of SIGUSR1 to parent on event
     window_reset: Reset the window
     window_show: Map the window on the screen
     window_hide: Unmap the window from the screen
     window_resize: Resize the window
     window_get_transparency: Get automatic transparency
     window_get_background_grab: Get automatic grab
     window_get_background_image: Get background image
     window_get_managed_status: Get managed status
     window_set_transparency: Set automatic transparency
     window_set_background_grab: Set automatic grab
     window_set_background_image: Set background image
     screen_get_width: Get screen width
     screen_get_height: Get screen height
     screen_get_depth: Get screen depth
     get_charset: Get input charset
     set_charset: Set input charset
     charset_status: Get charset capabilities
     x_status: Status of connection to X Window server
     quit: Quit the program

## Constants

     TEXT_TO_RIGHT
     TEXT_TO_LEFT
     TEXT_TO_DOWN
     TEXT_TO_UP
     TEXT_TO_ANGLE
     OP_COPY
     OP_ADD
     OP_SUBSTRACT
     OP_RESHADE
     CHANNEL_RED
     CHANNEL_GREEN
     CHANNEL_BLUE
     CHANNEL_ALPHA
     WINDOW_UNMANAGED
     WINDOW_MANAGED

# SEE ALSO

adesklets manual