pfvDispPipe(3pf) OpenGL Performer 3.2.2 libpfv C++ Reference Pages
NAMEpfvDispPipe - Configure one or more hardware pipes through an XML file or
API calls.
FUNCTION SPECIFICATION
#include <Performer/pfv/pfvDisplay.h>
virtual int pfvDispPipe::config();
pfPipe* pfvDispPipe::getHandle();
virtual pfvDispPWin* pfvDispPipe::createPWin(pfvXmlNode*xml=NULL);
int pfvDispPipe::getNumPWins();
pfvDispPWin* pfvDispPipe::getPWin(int index);
pfvDispPWin* pfvDispPipe::findPWin(char* _name);
int pfvDispPipe::setWSConnName( char* _name );
char* pfvDispPipe::getWSConnName();
int pfvDispPipe::setScreen(int _screen);
int pfvDispPipe::getScreen();
PARENT CLASS FUNCTIONS
The OpenGL Performer class pfvDispPipe is derived from the parent class
pfvObject, so each of these member functions of class pfvObject are also
directly usable with objects of class pfvDispPipe. This is also true for
ancestor classes of class pfvObject.
virtual int pfvObject::parseXml(pfvXmlNode*xml);
virtual int pfvObject::setXmlField(pfvXmlNode*xml);
char* pfvObject::getName();
void pfvObject::setName(char*_name);
Since the class pfvObject is itself derived from the parent class
pfObject, objects of class pfvDispPipe can also be used with these
functions designed for objects of class pfObject.
void* pfObject::operator new(size_t);
void* pfObject::operator new(size_t, pfFluxMemory *fmem);
void pfObject::setUserData(void *data);
void pfObject::setUserData(int slot, void *data);
void* pfObject::getUserData(pfObject *obj);
void* pfObject::getUserData(pfObject *obj, int slot);
int pfObject::getNumUserData();
Page 1
pfvDispPipe(3pf) OpenGL Performer 3.2.2 libpfv C++ Reference Pages
Since the class pfObject is itself derived from the parent class
pfMemory, objects of class pfvDispPipe can also be used with these
functions designed for objects of class pfMemory.
void* pfMemory::getData(const void *ptr);
pfType * pfMemory::getType();
int pfMemory::isOfType(pfType *type);
int pfMemory::isExactType(pfType *type);
const char * pfMemory::getTypeName();
int pfMemory::copy(pfMemory *src);
int pfMemory::compare(const pfMemory *mem);
void pfMemory::print(uint which, uint verbose, char *prefix,
FILE *file);
int pfMemory::getArena(void *ptr);
void* pfMemory::getArena();
int pfMemory::ref();
int pfMemory::unref();
int pfMemory::unrefDelete();
int pfMemory::unrefGetRef();
int pfMemory::getRef();
int pfMemory::checkDelete();
int pfMemory::isFluxed();
void * pfMemory::getArena();
int pfMemory::getSize();
DESCRIPTION
The pfvDispPipe class is a libpfv wrapper for the libpf pfPipe class. It
allows a pipe object to be configured through an XML file or
programatically through the API. A pfvDispPipe cannot be created
directly, instead, it has to be created through the createPipe method on
the pfvDisplayMngr class or a derived class such as the pfvViewer. All
pfvDispPipe objects must be created before calling
pfDisplayMngr::preConfig.
pfvDispPipe::config initializes a graphics pipe to a user-requested
screen index or to a named Display connection and then iterates through
all pfvDispWins in the pipe and calls pfvDispPWin::config on each one.
This method is called from the pfvDisplayMngr::config function and
normally should not be called by application code.
pfvDispPipe::getHandle returns a handle to the pfPipe object associated
with this pfvDispPipe. This function must be called after
pfvDisplayMngr::config or it will return NULL.
pfvDispPipe::createPWin creates a new pfvDispPWin object on this pipe,
and returns a handle to it. The newly created pfvDispPWin will be added
to both this pfvDispPipe's pfvDispPWin list, and pfvDisplayMngr global
pfvDispPWin list. The index associated with the pfvDispPWin will be its
position in Display Manager's global pfvDispPWin list. The optional xml
parameter can be used to supply an XML field which describes the
configuration of the pfvDispPWin. If the xml parameter is NULL, a
pfvDispPWin will be constructed that contains no pfvDispChan's.
Page 2
pfvDispPipe(3pf) OpenGL Performer 3.2.2 libpfv C++ Reference Pages
pfvDispPipe::getNumPWins returns the number of pfvDispPWin's currently in
the pfvDispPipe's pfvDispPWin list.
pfvDispPipe::getPWin returns a pointer to the pfvDispPWin stored at the
specified index in the pfvDispPipe's window list. If the index is
invalid, the return value is NULL.
pfvDispPipe::findPWin returns a pointer to the first pfvDispPWin in the
pfvDispPipe's pfvDispPWin list whose name matches _name. If no
pfvDispPWin's name matches, this function returns NULL.
pfvDispPipe::setWSConnName is used to specify an X server and default
screen for the successive opening of the window. This method must be
called before pfvDispPipe::config is called. Note that
pfvDispPipe::config will be called automatically by method
pfvDispMngr::postConfig and should not be called by application code
directly.
pfvDispPipe::getWSConnName returns the the name of the X Display that was
specified via pfvDispPipe::setWSConnName.
pfvDispPipe::setScreen specifies the hardware screen (graphics pipeline)
used for rendering by the pfPipe associated with this pfvDispPipe. Refer
to pfPipe man page for more information.
pfvDispPipe::getScreen will return the screen index set through
pfvDispPipe::setScreen, or -1 if screen has not been set.
NOTES
XML FILE CONFIGURATION
A pfDispPipe object can be fully configured using an xml tag, by calling
method parseXml() or by passing an XmlNode to pfDisplayMngr::createPipe.
If a <pipe> tag is found inside a display manager tag <display>, Display
Manager will automatically create a new pipe by parsing the <pipe> tag.
The list of valid tags inside <pipe> is:
<name> a string that will uniquely identify the pipe
<screen> a screen index
<wsconnName> window server connection name. See man page for
pfPipeWindow, method setWSConnectionName.
<pwin> sets up a pfvDispPWin. See man page pfvDispPWin for
details.
Page 3
pfvDispPipe(3pf) OpenGL Performer 3.2.2 libpfv C++ Reference Pages
SEE ALSO
pfvXml, pfvDisplayMngr, pfvViewer, pfvDispPWin, pfPipe, pfPipeWindow
Page 4
