.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Image 3pm"
.TH Image 3pm "2022-06-16" "perl v5.34.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
OpenGL::Image \- OpenGL wrapper to load images
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module is an extensible wrapper to abstract imaging interfaces
.PP
By default, this module uses the OpenGL::Image::Targa module; support for
other imaging libraries may be added by providing plug-in modules
in the OpenGL/Image folder.
.PP
An OpenGL::Image::Magick module is also provided for use with
PerlMagick.  For best performance, ImageMagick 6.3.5 or newer should
be installed.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\&  ##########
\&  # Check for installed imaging engines
\&  use OpenGL::Image;
\&
\&  # Get hashref of installed imaging engines
\&  # Keys are engine names; values are info hashes, including version,
\&  # priority (1 .. n, 1 is highest), module (Perl module name)
\&  # and description.
\&  # Priority can be set using Engines.lst (see INSTALL); otherwise
\&  # \*(AqTarga\*(Aq has top priority, and others are in unspecified order.
\&  my $engine_hashref = OpenGL::Image::GetEngines();
\&
\&  # In list context, returns list of info hashes sorted by engine
\&  # priority; info hash does not include a priority value.
\&  my @sorted_engine_info = OpenGL::Image::GetEngines();
\&
\&  # Check for a specific engine and optional version support
\&  # Returns an info hashref for the engine if available; otherwise undef.
\&  my $info_hashref = OpenGL::Image::HasEngine(\*(AqMagick\*(Aq,\*(Aq6.3.5\*(Aq);
\&
\&
\&  ##########
\&  # Load texture \- defaults to highest priority engine if none specified;
\&  # if Engines.lst is not specified, the highest priority is the Targa engine.
\&  my $tex = new OpenGL::Image(source=>\*(Aqtest.tga\*(Aq);
\&
\&  # Get GL info
\&  my($ifmt,$fmt,$type) = $tex\->Get(\*(Aqgl_internalformat\*(Aq,\*(Aqgl_format\*(Aq,\*(Aqgl_type\*(Aq);
\&  my($w,$h) = $tex\->Get(\*(Aqwidth\*(Aq,\*(Aqheight\*(Aq);
\&
\&  # Test if power of 2
\&  if (!$tex\->IsPowerOf2()) return;
\&
\&  # Set texture  
\&  glTexImage2D_c(GL_TEXTURE_2D, 0, $ifmt, $w, $h, 0, $fmt, $type, $tex\->Ptr());
\&
\&
\&  ##########
\&  # Modify GL frame using ImageMagick
\&  my $frame = new OpenGL::Image(engine=>\*(AqMagick\*(Aq,width=>$w,height=>$h);
\&
\&  # Get default GL info
\&  my($def_fmt,$def_type) = $tex\->Get(\*(Aqgl_format\*(Aq,\*(Aqgl_type\*(Aq);
\&
\&  # Read frame pixels
\&  glReadPixels_c(0, 0, $width, $height, $def_fmt, $def_type, $frame\->Ptr());
\&
\&  # Sync native image buffer
\&  # Must use this prior to making native calls
\&  $frame\->Sync();
\&
\&  # Modify frame pixels
\&  $frame\->Native\->Blur();
\&
\&  # Sync OGA
\&  # Must use this atfer all native calls are done
\&  $frame\->SyncOGA();
\&
\&  # Draw back to frame
\&  glDrawPixels_c(0, 0, $width, $height, $def_fmt, $def_type, $frame\->Ptr());
\&
\&
\&  ##########
\&  # Save GL frame
\&  my $image = new OpenGL::Image(width=>$width,height=>$height);
\&
\&  # Read frame pixels
\&  glReadPixels_c(0, 0, $width, $height, $def_fmt, $def_type, $image\->Ptr());
\&
\&  # Save file \- automatically does a Sync before write
\&  $image\->Save(\*(AqMyImage.tga\*(Aq);
\&
\&
\&  ##########
\&  # Get/Set normalized pixels
\&
\&  my($r,$g,$b,$a) = $img\->GetPixel($x,$y);
\&
\&  $img\->SetPixel($x,$y, 1.0, 0.5, 0.0, 1.0);
\&
\&  # Sync cache after done modifying pixels
\&  $frame\->Sync();
\&
\&
\&  ##########
\&  # Methods defined in OpenGL::Image::Common:
\&
\&  # Get native engine object
\&  my $obj = $img\->Native;
\&  $obj\->Quantize() if ($obj);
\&
\&  # Alternately (Assuming the native engine supports Blur):
\&  $img\->Native\->Blur();
\&
\&  # Test if image width is a power of 2
\&  if ($img\->IsPowerOf2());
\&
\&  # Test if all listed values are a power of 2
\&  if ($img\->IsPowerOf2(@list));
\&
\&  # Get largest power of 2 size within dimensions of image
\&  my $size = $img\->GetPowerOf2();
\&
\&  # Get one or more parameter values
\&  my @values = $img\->Get(@params);
\&
\&  # Return the image\*(Aqs cache as an OpenGL::Array object.
\&  # Note: OGA may change after a cache update
\&  my $oga = $img\->GetArray();
\&
\&  # Return a C pointer to the image\*(Aqs cache.
\&  # For use with OpenGL\*(Aqs "_c" APIs.
\&  # Note: pointer may change after a cache update
\&  $img\->Ptr();
\&
\&
\&  ##########
\&  # Supported parameters:
\&
\&  # version \- version of the engine
\&  # source \- source image, if defined
\&  # width \- width of image in pixels
\&  # height \- height of image in pixels
\&  # pixels \- number of pixels
\&  # components \- number of pixel components
\&  # size \- bytes per component
\&  # length \- cache size in bytes
\&  # endian \- 1 if big endian; otherwise 0
\&  # alpha \- 1: normal alpha channel, \-1: inverted alpha channel; 0: none
\&  # flipped \- 1 bit set if cache ordered top to bottom; others reserved
\&  # gl_internalformat \- internal GL pixel format. eg: GL_RGBA8, GL_RGBA16
\&  # gl_format \- GL pixel format. eg: GL_RGBA, GL_BGRA
\&  # gl_type \- GL data type.  eg: GL_UNSIGNED_BYTE, GL_UNSIGNED_SHORT
\&
\&
\&  ##########
\&  # APIs and Methods defined in engine modules:
\&
\&  # Get engine version
\&  my $ver = OpenGL::Image::ENGINE_MODULE::EngineVersion();
\&
\&  # Sync the image cache after a write.
\&  # Used by some engines for paged caches; otherwise a NOP.
\&  $img\->Sync();
\&
\&  # Save the image to a PNG file (assuming the engine supports PNGs)
\&  $img\->Save(\*(AqMyImage.png\*(Aq);
\&
\&  # Get image blob.
\&  my $blob = $img\->GetBlob();
.Ve
.SH "VERSION"
.IX Header "VERSION"
v1.03
.SH "AUTHOR"
.IX Header "AUTHOR"
Author: Bob \*(L"grafman\*(R" Free \- grafman@graphcomp.com
.PP
Contributor: Geoff Broadwell
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
copyright 2007 Graphcomp \- \s-1ALL RIGHTS RESERVED\s0
.PP
This program is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.