.\" 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::Common 3pm"
.TH Image::Common 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::Common \- class for OpenGL imaging engines
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module provides a base class for OpenGL imaging engines.
Requires the OpenGL module.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&  ##########
\&  # Check for installed imaging engines
\&
\&  use OpenGL::Image::Common;
\&  my $img = new OpenGL::Image::Common(%params);
\&
\&
\&  ##########
\&  # Must supply width and height, or source:
\&
\&  # source \- source image file path (some engines supports URLs).
\&  # width,height \- width and height in pixels for cache allocation.
\&
\&
\&  ##########
\&  # Optional params:
\&
\&  # engine \- specifies imaging engine; defaults to \*(AqTarga\*(Aq.
\&
\&
\&  ##########
\&  # Methods defined in this Common module:
\&
\&  # Get native engine object
\&  # Note: must not change image dimensions
\&  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 all parameters as a hashref
\&  my $params = $img\->Get();
\&
\&  # Get one or more parameter values
\&  my @values = $img\->Get(@params);
\&
\&  # Get/Set Pixel values (normalized to 1.0)
\&  my($r,$g,$b,$a) = $img\->GetPixel($x,$y);
\&
\&  # Sync cache after done modifying pixels
\&  $img\->SetPixel($x,$y,$r,$g,$b,$a);
\&  $frame\->Sync();
\&
\&
\&  ##########
\&  # 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 if has alpha channel, \-1 if has inverted alpha channel; 0 if none
\&  # flipped \- 1 bit set if cache scanlines are 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 defined in engine modules:
\&
\&  # Get engine version
\&  my $ver = OpenGL::Image::ENGINE_MODULE::EngineVersion();
\&
\&  # Get engine description
\&  my $desc = OpenGL::Image::ENGINE_MODULE::EngineDescription();
\&
\&
\&  ##########
\&  # Methods defined in engine modules:
\&
\&  # Sync the image cache after modifying pixels.
\&  # Used by some engines for paged caches; otherwise a NOP.
\&  $img\->Sync();
\&
\&  # 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();
\&
\&  # Save the image to a PNG file (assuming the native 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
.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.