.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" 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 .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . 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 "OpenGL 3pm" .TH OpenGL 3pm 2024-03-07 "perl v5.38.2" "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 PDL::Graphics::OpenGL::Perl::OpenGL \- PDL TriD OpenGL interface using POGL .SH VERSION .IX Header "VERSION" Version 0.01_10 .SH SYNOPSIS .IX Header "SYNOPSIS" This module provides the glue between the Perl OpenGL functions and the API defined by the internal PDL::Graphics::OpenGL one. It also supports any miscellaneous OpenGL or GUI related functionality to support PDL::Graphics::TriD refactoring. .PP You should eventually be able to replace: .PP .Vb 3 \& use PDL::Graphics::OpenGL \&by \& use PDL::Graphics::OpenGL::Perl::OpenGL; .Ve .PP This module also includes support for FreeGLUT and GLUT instead of X11+GLX as mechanism for creating windows and graphics contexts. .SH EXPORT .IX Header "EXPORT" See the documentation for the OpenGL module. More details to follow as the refactored TriD module interface and build environment matures .SH FUNCTIONS .IX Header "FUNCTIONS" .SS TBD .IX Subsection "TBD" .SS TBD .IX Subsection "TBD" .SS new .IX Subsection "new" Returns a new OpenGL object. .PP .Vb 1 \& new($class,$options,[$window_type]) \& \& Attributes are specified in the $options field; the 3d $window_type is optionsl. The attributes are: .Ve .IP "x,y \- the position of the upper left corner of the window (0,0)" 4 .IX Item "x,y - the position of the upper left corner of the window (0,0)" .PD 0 .IP "width,height \- the width and height of the window in pixels (500,500)" 4 .IX Item "width,height - the width and height of the window in pixels (500,500)" .IP "parent \- the parent under which the new window should be opened (root)" 4 .IX Item "parent - the parent under which the new window should be opened (root)" .IP "mask \- the user interface mask (StructureNotifyMask)" 4 .IX Item "mask - the user interface mask (StructureNotifyMask)" .IP "attributes \- attributes to pass to glXChooseVisual" 4 .IX Item "attributes - attributes to pass to glXChooseVisual" .PD .PP Allowed 3d window types, case insensitive, are: .IP "glut \- use Perl OpenGL bindings and GLUT windows (no Tk)" 4 .IX Item "glut - use Perl OpenGL bindings and GLUT windows (no Tk)" .PD 0 .IP "x11 \- use Perl OpenGL (POGL) bindings with X11 (disabled)" 4 .IX Item "x11 - use Perl OpenGL (POGL) bindings with X11 (disabled)" .PD .SS "default GLUT callbacks" .IX Subsection "default GLUT callbacks" These routines are set as the default GLUT callbacks for when GLUT windows are used for PDL/POGL. Their only function at the moment is to drive a fake XEvent queue to feed the existing TriD GUI controls. At some point, the X11 stuff will be deprecated and we can rewrite this more cleanly. .SS default_options .IX Subsection "default_options" default options for object oriented methods .SS \fBXPending()\fP .IX Subsection "XPending()" OO interface to XPending .SS XResizeWindow .IX Subsection "XResizeWindow" OO interface to XResizeWindow .PP .Vb 1 \& XResizeWindow(x,y) .Ve .SS \fBglpXNextEvent()\fP .IX Subsection "glpXNextEvent()" OO interface to glpXNextEvent .SS \fBglpRasterFont()\fP .IX Subsection "glpRasterFont()" OO interface to the glpRasterFont function .SS swap_buffers .IX Subsection "swap_buffers" OO interface to swapping display buffers .SS set_window .IX Subsection "set_window" OO interface to setting the display window (if appropriate) .SS AUTOLOAD .IX Subsection "AUTOLOAD" If the function is not prototyped in OO we assume there is no explicit mention of the three identifying parameters (Display, Window, Context) and try to load the OpenGL function. .SS glXSwapBuffers .IX Subsection "glXSwapBuffers" OO interface to the glXSwapBuffers function .SH AUTHOR .IX Header "AUTHOR" Chris Marshall, \f(CW\*(C`\*(C'\fR .SH BUGS .IX Header "BUGS" Bugs and feature requests may be submitted through the PDL GitHub project page at . .SH SUPPORT .IX Header "SUPPORT" PDL uses a mailing list support model. The Perldl mailing list is the best for questions, problems, and feature discussions with other PDL users and PDL developers. .PP To subscribe see the page at .SH ACKNOWLEDGEMENTS .IX Header "ACKNOWLEDGEMENTS" TBD including PDL TriD developers and POGL developers...thanks to all. .SH "COPYRIGHT & LICENSE" .IX Header "COPYRIGHT & LICENSE" Copyright 2009 Chris Marshall. .PP This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License. .PP See http://dev.perl.org/licenses/ for more information.