---

vrj::GlPipe Class Reference

Handles the rendering on multiple GLWindows in a single process. More...

#include <GlPipe.h>

Collaboration diagram for vrj::GlPipe:

[legend]List of all members.

Public Methods
	GlPipe (int num, GlDrawManager *glMgr)
	Constructor. More...
int	start ()
	Starts the pipe running. More...
void	controlLoop (void *nullParam)
	The main loop routine. More...
void	stop ()
	Stops the pipe. More...
void	triggerRender ()
	Triggers rendering of the pipe to start. More...
void	completeRender ()
	Blocks until rendering of the windows is completed. More...
void	triggerSwap ()
	Triggers swapping of all pipe's windows. More...
void	completeSwap ()
	Blocks until swapping of the windows is completed. More...
void	addWindow (GlWindow *win)
	Adds a GLWindow to the window list. More...
void	removeWindow (GlWindow *win)
	Removes a GLWindow from the window list. More...
int	hasWindows ()
	Returns true if pipe has any windows. More...
std::vector< GlWindow * >	getOpenWindows ()
	Return a list of open windows. More...

---

Detailed Description

Handles the rendering on multiple GLWindows in a single process.

This class can be used to group glWindows to render efficiently on one pipe (SGI terminology).

Date:

1-12-98

Definition at line 56 of file GlPipe.h.

---

Constructor & Destructor Documentation

vrj::GlPipe::GlPipe (  int    num, GlDrawManager *    glMgr )  [inline]

Constructor. Parameters: num  The id number of the pipe. glMgr  The GL Draw Manager instance associated with this pipe. Note: All contained windows SHOULD have the same pipe number. Definition at line 67 of file GlPipe.h. : mActiveThread(NULL) , mPipeNum(num) , controlExit(0) , glManager(glMgr) , renderTriggerSema(0) , renderCompleteSema(0) , swapTriggerSema(0) , swapCompleteSema(0) { mThreadRunning = false; }

---

Member Function Documentation

int vrj::GlPipe::start (    )

Starts the pipe running. Precondition: The pipe should not have a thread of control yet. Postcondition: The pipe has it's own thread of control and is ready to operate The Thread of control is running controlLoop. Note: The pipe does NOT have to have any windows in order to run that way we can add windows to pipes at run-time. Definition at line 63 of file GlPipe.cpp. References vrjDBG_DRAW_MGR. { vprASSERT(mThreadRunning == false); // We should not be running yet // Create a new thread to call the control loop vpr::ThreadMemberFunctor<GlPipe>* memberFunctor = new vpr::ThreadMemberFunctor<GlPipe>(this, &GlPipe::controlLoop, NULL); mActiveThread = new vpr::Thread(memberFunctor); vprDEBUG(vrjDBG_DRAW_MGR, vprDBG_CONFIG_LVL) << "vjGlPipe::start: Started control loop. " << mActiveThread << std::endl << vprDEBUG_FLUSH; return 1; // XXX: Is this always true? }

void vrj::GlPipe::controlLoop (  void *    nullParam )

The main loop routine. -Checks for new windows -renders all windows when triggered Definition at line 160 of file GlPipe.cpp. { boost::ignore_unused_variable_warning(nullParam); mThreadRunning = true; // We are running so set flag // Loop until flag set while (!controlExit) { checkForWindowsToClose(); // Checks for closing windows checkForNewWindows(); // Checks for new windows to open // --- handle EVENTS for the windows --- // // XXX: This may have to be here because of need to get open window event (Win32) // otherwise I would like to move it to being after the swap to get better performance { for(unsigned int winId=0;winId<mOpenWins.size();winId++) mOpenWins[winId]->checkEvents(); } // --- RENDER the windows ---- // { renderTriggerSema.acquire(); GlApp* the_app = glManager->getApp(); // --- pipe PRE-draw function ---- // the_app->pipePreDraw(); // Can't get a context since I may not be guaranteed a window // Render the windows for (unsigned int winId=0;winId < mOpenWins.size();winId++) { renderWindow(mOpenWins[winId]); } renderCompleteSema.release(); } // ----- SWAP the windows ------ // { swapTriggerSema.acquire(); // Swap all the windows for(unsigned int winId=0;winId < mOpenWins.size();winId++) { swapWindowBuffers(mOpenWins[winId]); } swapCompleteSema.release(); } } mThreadRunning = false; // We are not running }

void vrj::GlPipe::stop (    )  [inline]

Stops the pipe. Postcondition: Flag is set to tell pipe to stop rendering. Definition at line 102 of file GlPipe.h. { controlExit = 1; } // Set the control loop exit flag

void vrj::GlPipe::triggerRender (    )

Triggers rendering of the pipe to start. Precondition: The pipe must have a thread of control. Postcondition: The pipe has be told to start rendering. Definition at line 83 of file GlPipe.cpp. References vrjDBG_DRAW_MGR. { //vprASSERT(mThreadRunning == true); // We must be running while(!mThreadRunning) { vprDEBUG(vrjDBG_DRAW_MGR,vprDBG_HVERB_LVL) << "Waiting in for thread to start triggerRender.\n" << vprDEBUG_FLUSH; vpr::Thread::yield(); } renderTriggerSema.release(); }

void vrj::GlPipe::completeRender (    )

Blocks until rendering of the windows is completed. Precondition: The pipe must have a thread of control. Postcondition: The pipe has completed its rendering. Definition at line 99 of file GlPipe.cpp. { vprASSERT(mThreadRunning == true); // We must be running renderCompleteSema.acquire(); }

void vrj::GlPipe::triggerSwap (    )

Triggers swapping of all pipe's windows. Precondition: The pipe must have a thread of control. Postcondition: The pipe has be told to swap. Definition at line 107 of file GlPipe.cpp. { vprASSERT(mThreadRunning == true); swapTriggerSema.release(); }

void vrj::GlPipe::completeSwap (    )

Blocks until swapping of the windows is completed. Precondition: The pipe must have a thread of control. Postcondition: The pipe has completed its rendering. Definition at line 114 of file GlPipe.cpp. { vprASSERT(mThreadRunning == true); swapCompleteSema.acquire(); }

void vrj::GlPipe::addWindow (  GlWindow *    win )

Adds a GLWindow to the window list. Control loop must now open the window on the next frame. Definition at line 125 of file GlPipe.cpp. References vrjDBG_DRAW_MGR. { vpr::Guard<vpr::Mutex> guardNew(mNewWinLock); // Protect the data vprDEBUG(vrjDBG_DRAW_MGR, vprDBG_STATE_LVL) << "vjGlPipe::addWindow: Pipe: " << mPipeNum << " adding window (to new wins):\n" << win << std::endl << vprDEBUG_FLUSH; mNewWins.push_back(win); }

void vrj::GlPipe::removeWindow (  GlWindow *    win )

Removes a GLWindow from the window list. Note: The window is not actually removed until the next draw trigger. Definition at line 139 of file GlPipe.cpp. References vrjDBG_DRAW_MGR. { vpr::Guard<vpr::Mutex> guardClosing(mClosingWinLock); vprDEBUG(vrjDBG_DRAW_MGR, vprDBG_STATE_LVL) << "vjGlPipe:: removeWindow: Pipe: " << mPipeNum << " window added to closingWins.\n" << win << std::endl << vprDEBUG_FLUSH; mClosingWins.push_back(win); }

int vrj::GlPipe::hasWindows (    )  [inline]

Returns true if pipe has any windows. Definition at line 149 of file GlPipe.h. { return ( (mNewWins.size() > 0) || (mOpenWins.size() > 0)); }

std::vector<GlWindow*> vrj::GlPipe::getOpenWindows (    )  [inline]

Return a list of open windows. Definition at line 155 of file GlPipe.h. { return mOpenWins; }

---

The documentation for this class was generated from the following files:

• GlPipe.h
• GlPipe.cpp

---