27 Oct 2012 00:35:57 UTC
- Distribution: Gtk2-Ex-WidgetBits
- Module version: 48
- Source (raw)
- Browse (raw)
- How to Contribute
- Issues (0)
- Testers (2330 / 50 / 0)
- KwaliteeBus factor: 1
- 42.85% Coverage
- License: open_source
- Perl: v5.8.0
- Activity24 month
- Download (136.17KB)
- MetaCPAN Explorer
- Subscribe to distribution
- This version
- Latest versionKRYDE Kevin Rydeand 1 contributors
- Kevin Ryde
Gtk2::Ex::PixbufBits -- misc Gtk2::Gdk::Pixbuf helpers
Gtk2::Ex::PixbufBits::save_adapt ($pixbuf, $filename, $type, key => value, ...)
($filename, $type, ...) = Gtk2::Ex::PixbufBits::save_adapt_options ($pixbuf, $filename, $type, key => value, ...)
Gtk2::Gdk::Pixbufwith various options adapted for the target
$typeand the options supported by the Gtk in use.
$typeis a string per
$pixbuf->save, such as "png" or "jpeg".
save_adapt_options()adapts options and returns them without saving. The return can be passed to a
$pixbuf->save (save_adapt_options($pixbuf, $filename, $type, zlib_compression => 4));
The idea is to give a full set of options and have them automatically reduced if not applicable to the
$typeor not available in the Gtk version. For example the
compressionoption must be set differently for PNG or for TIFF. The two separate compression options here are used according to the
zlib_compression(integer 0 to 9 or -1)
A Zlib style compression level. For
$type"png" and Gtk 2.8 up this becomes the
tiff_compression_type(integer, or names "none", "huffman", "lzw", "jpeg" or "deflate")
A TIFF compression method. For
$type"tiff" and Gtk 2.20 up this becomes the
compressionoption. String names "deflate" etc are converted to the corresponding integer value.
quality_percent(0 to 100)
An image quality percentage for lossy formats such as JPEG. For
$type"jpeg" this becomes the
A PNG style keyword string. For
$type"png" and Gtk 2.8 up this is passed through as
tEXt, with a
utf8::upgradeif necessary for Gtk2-Perl 1.221.
tEXtoptions are moved to before any
compressionoption as a workaround for a Gtk bug where if
compressionthen wrong text strings are written.
The cursor hotspot position for
undefmeans no hotspot. The default is the pixbuf
y_hotwhich is set when reading an ICO or XPM file.
XPM is not writable as of Gtk 2.22 but if it becomes writable then perhaps its hotspot could be set from these options too.
Gtk2::Ex::PixbufBits::save_adapt ($pixbuf, # Gtk2::Gdk::Pixbuf object $users_filename, # eg. string "/tmp/foo" $users_type, # eg. string "png" zlib_compression => 9, quality_percent => 100, tiff_compression_type => "deflate", tEXt:Author => "Yorick");
$str = Gtk2::Ex::PixbufBits::sampled_majority_color($pixbuf)
Return a string which is the apparent majority colour in
$pixbuf, established by sampling some pixels at random. For an 8-bit RGB pixbuf the return is a string like "#FF00FF".
This function only makes sense for images which have a particular dominant background (or foreground) colour, it's no good if there's lots of shades of grey etc.
The current code only supports 8-bit RGB or RGBA data formats, which is all GdkPixbuf itself supports as of Gtk 2.22. Transparent pixels (alpha channel zero) are ignored.
The idea of sampling pixels at random is to avoid a fixed sampling algorithm hitting a grid or pattern in the image which is not the majority colour. For small images all pixels are checked (currently anything up to 1800 pixels).
($width, $height) = Gtk2::Ex::PixbufBits::type_max_size ($type)
$bool = Gtk2::Ex::PixbufBits::type_supports_size ($type, $width, $height)
type_max_size()returns the maximum which file format
$typesupports, or no values if there's no maximum known.
type_supports_size()returns true if the given size is supported by
$type(and true if unknown too).
The maximum sizes are
png 2**31-1 x 2**31-1 jpeg 65500x65500 tiff 2**32-1 x 2**32-1 bmp 2**31-1 x 2**31-1 ico 255x255
The PNG spec allows 2^31-1 and that's given here, but libpng (in
png_check_IHDR()) restricts the width to 2^29-130 (RGBA row in 32-bit malloced block), and also has compiled-in
PNG_USER_HEIGHT_MAXdefaulting to 1,000,000. Might try to include those limits here, if they can be identified reliably.
$format = Gtk2::Ex::PixbufBits::type_to_format ($type)
Gtk2::Gdk::PixbufFormatobject for the given
$typeis the format name, such as "png", "jpeg", etc (lower case). If
$typeis unknown then return
Gtk2::Gdk::PixbufFormatis new in Gtk 2.2. It's unspecified yet what this function does in Gtk 2.0.x.
Nothing is exported by default, but all functions can be requested in usual
use Gtk2::Ex::PixbufBits 'save_adapt'; save_adapt ($pixbuf, $filename, $type, 'tEXt::Title' => 'Picture of Matchstick Men');
:alltag since this module is meant as a grab-bag of functions and to import as-yet unknown things would be asking for name clashes.
Copyright 2007, 2008, 2009, 2010, 2011, 2012 Kevin Ryde
Gtk2-Ex-WidgetBits 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, or (at your option) any later version.
Gtk2-Ex-WidgetBits 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 Gtk2-Ex-WidgetBits. If not, see http://www.gnu.org/licenses/.
Module Install Instructions
To install Gtk2::Ex::WidgetBits, copy and paste the appropriate command in to your terminal.
perl -MCPAN -e shell install Gtk2::Ex::WidgetBits
For more information on module installation, please visit the detailed CPAN module installation guide.