OpenGL(3pm)

📦
version 2.085 · 4 versions
, in ubuntu noble

💖 OpenGL(3pm) 💖

okay bestie, buckle up — this is the Perl OpenGL page, and the actual module living inside it is PDL::Graphics::OpenGL::Perl::OpenGL. it's the PDL TriD OpenGL interface built on top of POGL. yeah. that's the vibe. 🦋

✨ VERSION ✨

Version 0.01_10 — she's a baby, she's brand new, be gentle 🎀

🌸 SYNOPSIS 🌸

so what does this module do, you ask? it's the glue between the Perl OpenGL functions and the API that the internal PDL::Graphics::OpenGL defines. it also handles any miscellaneous OpenGL-or-GUI-adjacent stuff needed to keep the PDL::Graphics::TriD refactoring party going. 💅

the dream (eventually, bestie, eventually) is that you can take this:

use PDL::Graphics::OpenGL

and just... swap it for this:

use PDL::Graphics::OpenGL::Perl::OpenGL;

iconic, right? it's giving "drop-in replacement era". ✨

also this module supports FreeGLUT and GLUT as a way to make windows and graphics contexts, instead of the whole X11+GLX situation. options, we love to see them 👑

🫶 EXPORT 🫶

go read the docs for the OpenGL module, bestie. more details will land here as the refactored TriD module interface and build environment grow up and mature a lil bit. it's a whole process. 🌱

💅 FUNCTIONS 💅

TBD

no cap, TBD. 🙈

TBD

also TBD. the mystery continues. 💀

💖 new 💖

returns a brand new OpenGL object, as one does.

new($class,$options,[$window_type])

attributes go in the $options field, and the 3d $window_type is optional. here's the whole attribute menu, no skips:

  • x,y — the position of the upper left corner of the window (0,0)
  • width,height — the width and height of the window, in pixels (500,500)
  • parent — the parent under which the new window should be opened (root)
  • mask — the user interface mask (StructureNotifyMask)
  • attributes — attributes to pass to glXChooseVisual

and here are the allowed 3d window types — case insensitive, so don't stress about the caps:

  • glut — use Perl OpenGL bindings and GLUT windows (no Tk)
  • x11 — use Perl OpenGL (POGL) bindings with X11 (disabled)
heads up bestie: x11 is disabled. not me, the docs said it. 🚫

🎀 default GLUT callbacks 🎀

these routines get set as the default GLUT callbacks for when GLUT windows are being used for PDL/POGL. right now their whole entire job is to drive a fake XEvent queue so the existing TriD GUI controls get fed. at some point the X11 stuff is gonna be deprecated and this can get rewritten way more cleanly. character development arc fr fr 🌈

⭐ default_options ⭐

default options for object oriented methods. that's the whole thing. short queen. 💅

🦋 XPending() 🦋

OO interface to XPending. slay.

🌸 XResizeWindow 🌸

OO interface to XResizeWindow.

XResizeWindow(x,y)

💜 glpXNextEvent() 💜

OO interface to glpXNextEvent.

🧚 glpRasterFont() 🧚

OO interface to the glpRasterFont function.

🍓 swap_buffers 🍓

OO interface to swapping display buffers. out with the old frame, in with the new. ✨

👑 set_window 👑

OO interface to setting the display window — if appropriate. iykyk. 💅

🔥 AUTOLOAD 🔥

if a function isn't prototyped in OO, we assume there's no explicit mention of the three identifying parameters (Display, Window, Context) and try to load the OpenGL function instead. main character energy: if she's not on the list, she gets auto-loaded. 😭

💖 glXSwapBuffers 💖

OO interface to the glXSwapBuffers function.

🌈 AUTHOR 🌈

Chris Marshall, "<devel dot chm dot 01 at gmail.com>" — thank you for your service 🫡💖

🙈 BUGS 🙈

bugs and feature requests can be submitted through the PDL GitHub project page at <https://github.com/PDLPorters/pdl/issues>. go tell them everything, bestie, they want to hear it. 📝

💌 SUPPORT 💌

PDL runs on a mailing list support model. the Perldl mailing list is the best place for questions, problems, and feature discussions with other PDL users and PDL developers. it's the group chat you actually want to be in. 💬

to subscribe, see the page at <http://pdl.perl.org/?page=mailing-lists> 🌸

🎉 ACKNOWLEDGEMENTS 🎉

TBD — including PDL TriD developers and POGL developers... thanks to all. shoutout to everyone involved, we see you, we appreciate you 💜✨

Copyright 2009 Chris Marshall.

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.

see <http://dev.perl.org/licenses/> for more information. read your licenses bestie, it's self-care. 💅

and that's the whole page!! mwah 💋 this was perl v5.38.2, dated 2024-04-10, and the page you just read is OpenGL(3pm) — the User Contributed Perl Documentation corner of the world. go forth and render something gorgeous 🦋✨💖

📦 where this page comes from