Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members

glxGraphicsPipe Class Reference

This graphics pipe represents the interface for creating OpenGL graphics windows on an X-based (e.g. More...

#include <glxGraphicsPipe.h>

Inheritance diagram for glxGraphicsPipe:


Public Member Functions
	glxGraphicsPipe (const string &display=string())
virtual	~glxGraphicsPipe ()
virtual string	get_interface_name () const
	Returns the name of the rendering interface associated with this GraphicsPipe.
Display *	get_display () const
	Returns a pointer to the X display associated with the pipe: the display on which to create the windows.
int	get_screen () const
	Returns the X screen number associated with the pipe.
Window	get_root () const
	Returns the handle to the root window on the pipe's display.
Atom	get_wm_delete_window () const
	Returns the X atom that represents WM_DELETE_WINDOW to the current display.
virtual TypeHandle	get_type () const
virtual TypeHandle	force_init_type ()
bool	is_valid () const
	Returns false if this pipe is known to be invalid, meaning that an attempt to create a GraphicsWindow with the pipe will certainly fail.
bool	supports_fullscreen () const
	Returns false if this pipe is known to not support any creation of fullscreen windows.
int	get_display_width () const
	Returns the width of the entire display, if it is known.
int	get_display_height () const
	Returns the height of the entire display, if it is known.
virtual int	get_num_hw_channels ()
	Returns the number of hardware channels available for pipes of this type.
virtual HardwareChannel *	get_hw_channel (GraphicsWindow *window, int index)
	Creates and returns an accessor to the HardwareChannel at the given index number, which must be in the range 0 <= index < get_num_hw_channels().
int	get_type_index () const
	Returns the internal index number associated with this object's TypeHandle, a unique number for each different type.
bool	is_of_type (TypeHandle handle) const
	Returns true if the current object is or derives from the indicated type.
bool	is_exact_type (TypeHandle handle) const
	Returns true if the current object is the indicated type exactly.
int	get_ref_count () const
	Returns the current reference count.
int	ref () const
	Explicitly increments the reference count.
int	unref () const
	Explicitly decrements the reference count.
void	test_ref_count_integrity () const
	Does some easy checks to make sure that the reference count isn't completely bogus.
Static Public Member Functions
	PT (GraphicsPipe) pipe_ const ructor()
TypeHandle	get_class_type ()
void	init_type ()
Protected Member Functions
virtual	PT (GraphicsStateGuardian) make_gsg(const FrameBufferProperties &properties)
virtual	PT (GraphicsWindow) make_window(GraphicsStateGuardian *gsg)
virtual PointerTo< GraphicsStateGuardian >	make_gsg (const FrameBufferProperties &properties)
	Creates a new GSG to use the pipe (but no windows have been created yet for the GSG).
virtual void	close_gsg (GraphicsStateGuardian *gsg)
	This will be called in the draw thread (the same thread in which the GSG was created via make_gsg, above) to close the indicated GSG and free its associated graphics objects just before it is destructed.
virtual PointerTo< GraphicsWindow >	make_window (GraphicsStateGuardian *gsg)=0
Protected Attributes
Mutex	_lock
bool	_is_valid
bool	_supports_fullscreen
int	_display_width
int	_display_height
Private Types
typedef int	ErrorHandlerFunc (Display , XErrorEvent )
typedef int	IOErrorHandlerFunc (Display *)
Private Member Functions
XVisualInfo *	choose_visual (FrameBufferProperties &properties) const
	Selects an appropriate X visual for the given frame buffer properties.
XVisualInfo *	try_for_visual (int framebuffer_mode, int want_depth_bits, int want_color_bits) const
	Attempt to get the requested visual, if it is available.
Static Private Member Functions
void	install_error_handlers ()
	Installs new Xlib error handler functions if this is the first time this function has been called.
int	error_handler (Display display, XErrorEvent error)
	This function is installed as the error handler for a non-fatal Xlib error.
int	io_error_handler (Display *display)
	This function is installed as the error handler for a fatal Xlib error.
Private Attributes
Display *	_display
int	_screen
Window	_root
Atom	_wm_protocols
Atom	_wm_delete_window
Static Private Attributes
bool	_error_handlers_installed = false
ErrorHandlerFunc *	_prev_error_handler
IOErrorHandlerFunc *	_prev_io_error_handler
TypeHandle	_type_handle

Detailed Description

This graphics pipe represents the interface for creating OpenGL graphics windows on an X-based (e.g.

Unix) client.

Definition at line 54 of file glxGraphicsPipe.h.

Member Typedef Documentation

typedef int glxGraphicsPipe::ErrorHandlerFunc(Display *, XErrorEvent *) [private]

Definition at line 88 of file glxGraphicsPipe.h.

typedef int glxGraphicsPipe::IOErrorHandlerFunc(Display *) [private]

Definition at line 89 of file glxGraphicsPipe.h.

Constructor & Destructor Documentation

glxGraphicsPipe::glxGraphicsPipe ( const string & display = string() )

Definition at line 46 of file glxGraphicsPipe.cxx.

glxGraphicsPipe::~glxGraphicsPipe ( ) [virtual]

Definition at line 97 of file glxGraphicsPipe.cxx.

Member Function Documentation

XVisualInfo * glxGraphicsPipe::choose_visual ( FrameBufferProperties & properties ) const [private]

Selects an appropriate X visual for the given frame buffer properties.
Returns the visual pointer if successful, or NULL otherwise.
If successful, this may modify properties to reflect the actual visual chosen.
Definition at line 219 of file glxGraphicsPipe.cxx.
References NS_info.
Referenced by get_interface_name().

void GraphicsPipe::close_gsg ( GraphicsStateGuardian * gsg ) [protected, virtual, inherited]

This will be called in the draw thread (the same thread in which the GSG was created via make_gsg, above) to close the indicated GSG and free its associated graphics objects just before it is destructed.
This method exists to provide a hook for the graphics pipe to do any necessary cleanup, if any.
Definition at line 173 of file graphicsPipe.cxx.

int glxGraphicsPipe::error_handler ( Display * display,

XErrorEvent * error

) [static, private]

This function is installed as the error handler for a non-fatal Xlib error.

Definition at line 566 of file glxGraphicsPipe.cxx.

virtual TypeHandle glxGraphicsPipe::force_init_type ( void ) [inline, virtual]

Reimplemented from GraphicsPipe.
Definition at line 106 of file glxGraphicsPipe.h.

TypeHandle glxGraphicsPipe::get_class_type ( void ) [inline, static]

Reimplemented from GraphicsPipe.
Definition at line 95 of file glxGraphicsPipe.h.
Referenced by init_type().

Display * glxGraphicsPipe::get_display ( ) const [inline]

Returns a pointer to the X display associated with the pipe: the display on which to create the windows.

Definition at line 34 of file glxGraphicsPipe.I.
References _screen, and INLINE.

int GraphicsPipe::get_display_height ( ) const [inline, inherited]

Returns the height of the entire display, if it is known.
This may return 0. See the caveats for get_display_width().
Definition at line 115 of file graphicsPipe.I.

int GraphicsPipe::get_display_width ( ) const [inline, inherited]

Returns the width of the entire display, if it is known.
This may return 0. This is not a guarantee that windows (particularly fullscreen windows) may not be created larger than this width, but it is intended to provide a hint to the application.
Definition at line 98 of file graphicsPipe.I.

HardwareChannel * GraphicsPipe::get_hw_channel ( GraphicsWindow * window,

int index

) [virtual, inherited]

Creates and returns an accessor to the HardwareChannel at the given index number, which must be in the range 0 <= index < get_num_hw_channels().
This function will return NULL if the index number is out of range or the hardware channel at that index is unavailable.
Most kinds of GraphicsPipes do not have any special hardware channels available, and this function will always return NULL.
Definition at line 129 of file graphicsPipe.cxx.
References GraphicsStateGuardian::close_gsg(), and NULL.

string glxGraphicsPipe::get_interface_name ( ) const [virtual]

Returns the name of the rendering interface associated with this GraphicsPipe.
This is used to present to the user to allow him/her to choose between several possible GraphicsPipes available on a particular platform, so the name should be meaningful and unique for a given platform.
Implements GraphicsPipe.
Definition at line 122 of file glxGraphicsPipe.cxx.
References GraphicsPipe::_is_valid, choose_visual(), and NULL.

int GraphicsPipe::get_num_hw_channels ( ) [virtual, inherited]

Returns the number of hardware channels available for pipes of this type.
See get_hw_channel().
Definition at line 98 of file graphicsPipe.cxx.

int ReferenceCount::get_ref_count ( ) const [inline, inherited]

Returns the current reference count.

Definition at line 183 of file referenceCount.I.
Referenced by RenderState::determine_bin_index(), RenderEffects::determine_show_bounds(), FontPool::ns_garbage_collect(), TexturePool::ns_garbage_collect(), MaterialPool::ns_get_material(), and TexturePool::ns_release_texture().

Window glxGraphicsPipe::get_root ( ) const [inline]

Returns the handle to the root window on the pipe's display.

Definition at line 62 of file glxGraphicsPipe.I.

int glxGraphicsPipe::get_screen ( ) const [inline]

Returns the X screen number associated with the pipe.

Definition at line 47 of file glxGraphicsPipe.I.
References _root, and INLINE.

virtual TypeHandle glxGraphicsPipe::get_type ( void ) const [inline, virtual]

Reimplemented from GraphicsPipe.
Definition at line 103 of file glxGraphicsPipe.h.

int TypedObject::get_type_index ( ) const [inline, inherited]

Returns the internal index number associated with this object's TypeHandle, a unique number for each different type.
This is equivalent to get_type().get_index().
Definition at line 71 of file typedObject.I.
References TypeHandle::get_name(), TypedObject::get_type(), and INLINE.

Atom glxGraphicsPipe::get_wm_delete_window ( ) const [inline]

Returns the X atom that represents WM_DELETE_WINDOW to the current display.

Definition at line 77 of file glxGraphicsPipe.I.

void glxGraphicsPipe::init_type ( void ) [inline, static]

Reimplemented from GraphicsPipe.
Definition at line 98 of file glxGraphicsPipe.h.
References get_class_type().
Referenced by ConfigureFn().

void glxGraphicsPipe::install_error_handlers ( ) [static, private]

Installs new Xlib error handler functions if this is the first time this function has been called.
These error handler functions will attempt to reduce Xlib's annoying tendency to shut down the client at the first error. Unfortunately, it is difficult to play nice with the client if it has already installed its own error handlers.
Definition at line 545 of file glxGraphicsPipe.cxx.

int glxGraphicsPipe::io_error_handler ( Display * display ) [static, private]

This function is installed as the error handler for a fatal Xlib error.

Definition at line 589 of file glxGraphicsPipe.cxx.

bool TypedObject::is_exact_type ( TypeHandle handle ) const [inline, inherited]

Returns true if the current object is the indicated type exactly.

Definition at line 101 of file typedObject.I.
Referenced by PT(), and CollisionNode::xform().

bool TypedObject::is_of_type ( TypeHandle handle ) const [inline, inherited]

Returns true if the current object is or derives from the indicated type.

Definition at line 86 of file typedObject.I.
Referenced by EggMaterialCollection::collapse_equivalent_materials(), EggTextureCollection::collapse_equivalent_textures(), DeferredNodeProperty::compose(), AnimBundleMaker::create_s_channel(), CharacterMaker::create_slider(), ProjectionScreen::cull_callback(), DataNode::define_output(), EggNode::determine_draw_order(), CharacterMaker::egg_to_index(), EggGroupUniquifier::EggGroupUniquifier(), EggPoolUniquifier::EggPoolUniquifier(), EggGroupNode::find_textures(), StaticTextFont::get_glyph(), EggMaterialCollection::insert_materials(), EggTextureCollection::insert_textures(), CharacterJoint::make_copy(), PT(), EggGroupNode::r_flatten_transforms(), EggGroupNode::r_transform_vertices(), EggGroupNode::recompute_polygon_normals(), CollisionLevelState::reserve(), PandaFramework::reset_frame_rate(), PandaFramework::set_texture(), EggGroupNode::steal_children(), and DataGraphTraverser::traverse().

bool GraphicsPipe::is_valid ( ) const [inline, inherited]

Returns false if this pipe is known to be invalid, meaning that an attempt to create a GraphicsWindow with the pipe will certainly fail.
Returns true if the pipe is probably valid (is this case, an attempt to create a GraphicsWindow should succeed, but might still fail).
Use the GraphicsEngine class to create a GraphicsWindow on a particular pipe.
Definition at line 48 of file graphicsPipe.I.
References GraphicsPipe::_supports_fullscreen, and INLINE.

PointerTo< GraphicsStateGuardian > GraphicsPipe::make_gsg ( const FrameBufferProperties & properties ) [protected, virtual, inherited]

Creates a new GSG to use the pipe (but no windows have been created yet for the GSG).
This method will be called in the draw thread for the GSG.
Definition at line 146 of file graphicsPipe.cxx.
Referenced by GraphicsEngine::set_threading_model().

virtual PointerTo< GraphicsWindow > GraphicsPipe::make_window ( GraphicsStateGuardian * gsg ) [protected, pure virtual, inherited]

virtual glxGraphicsPipe::PT ( GraphicsWindow ) [protected, virtual]

virtual glxGraphicsPipe::PT ( GraphicsStateGuardian ) const [protected, virtual]

glxGraphicsPipe::PT ( GraphicsPipe ) const [static]

int ReferenceCount::ref ( ) const [inline, inherited]

Explicitly increments the reference count.
User code should avoid using ref() and unref() directly, which can result in missed reference counts. Instead, let a PointerTo object manage the reference counting automatically.
This function is const, even though it changes the object, because generally fiddling with an object's reference count isn't considered part of fiddling with the object. An object might be const in other ways, but we still need to accurately count the number of references to it.
The return value is the new reference count.
Definition at line 225 of file referenceCount.I.
Referenced by ClientDevice::ClientDevice(), EggGroupNode::find_textures(), EggGroupNode::r_apply_texmats(), EggGroupNode::r_flatten_transforms(), and EggGroupNode::reverse_vertex_ordering().

bool GraphicsPipe::supports_fullscreen ( ) const [inline, inherited]

Returns false if this pipe is known to not support any creation of fullscreen windows.
If this returns false, any attempt to create a window with the fullscreen property set will certainly fail.
Returns true when the pipe will probably support fullscreen windows. This is not, however, a guarantee that an attempt to create a fullscreen window will not fail.
Definition at line 77 of file graphicsPipe.I.
References GraphicsPipe::_display_height, and INLINE.

void ReferenceCount::test_ref_count_integrity ( ) const [inline, inherited]

Does some easy checks to make sure that the reference count isn't completely bogus.

Definition at line 328 of file referenceCount.I.
References INLINE.
Referenced by EggNode::determine_bin(), and ReferenceCount::~ReferenceCount().

XVisualInfo * glxGraphicsPipe::try_for_visual ( int framebuffer_mode,

int want_depth_bits,

int want_color_bits

) const [private]

Attempt to get the requested visual, if it is available.
It's just a wrapper around glXChooseVisual(). It returns the visual information if possible, or NULL if it is not.
Definition at line 438 of file glxGraphicsPipe.cxx.

int ReferenceCount::unref ( ) const [inline, inherited]

Explicitly decrements the reference count.
Note that the object will not be implicitly deleted by unref() simply because the reference count drops to zero. (Having a member function delete itself is problematic; plus, we don't have a virtual destructor anyway.) However, see the helper function unref_delete().
User code should avoid using ref() and unref() directly, which can result in missed reference counts. Instead, let a PointerTo object manage the reference counting automatically.
This function is const, even though it changes the object, because generally fiddling with an object's reference count isn't considered part of fiddling with the object. An object might be const in other ways, but we still need to accurately count the number of references to it.
The return value is the new reference count.
Definition at line 293 of file referenceCount.I.
References INLINE.
Referenced by RenderState::determine_bin_index(), and RenderEffects::determine_show_bounds().

Member Data Documentation

Display* glxGraphicsPipe::_display [private]

Definition at line 81 of file glxGraphicsPipe.h.

int GraphicsPipe::_display_height [protected, inherited]

Definition at line 105 of file graphicsPipe.h.
Referenced by GraphicsPipe::GraphicsPipe(), and GraphicsPipe::supports_fullscreen().

int GraphicsPipe::_display_width [protected, inherited]

Definition at line 104 of file graphicsPipe.h.
Referenced by GraphicsPipe::GraphicsPipe().

bool glxGraphicsPipe::_error_handlers_installed = false [static, private]

Definition at line 33 of file glxGraphicsPipe.cxx.

bool GraphicsPipe::_is_valid [protected, inherited]

Definition at line 102 of file graphicsPipe.h.
Referenced by wglGraphicsPipe::get_interface_name(), get_interface_name(), and wdxGraphicsPipe8::get_interface_name().

Mutex GraphicsPipe::_lock [protected, inherited]

Definition at line 100 of file graphicsPipe.h.

glxGraphicsPipe::ErrorHandlerFunc * glxGraphicsPipe::_prev_error_handler [static, private]

Definition at line 34 of file glxGraphicsPipe.cxx.

glxGraphicsPipe::IOErrorHandlerFunc * glxGraphicsPipe::_prev_io_error_handler [static, private]

Definition at line 35 of file glxGraphicsPipe.cxx.

Window glxGraphicsPipe::_root [private]

Definition at line 83 of file glxGraphicsPipe.h.
Referenced by get_screen().

int glxGraphicsPipe::_screen [private]

Definition at line 82 of file glxGraphicsPipe.h.
Referenced by get_display().

bool GraphicsPipe::_supports_fullscreen [protected, inherited]

Definition at line 103 of file graphicsPipe.h.
Referenced by GraphicsPipe::GraphicsPipe(), and GraphicsPipe::is_valid().

TypeHandle glxGraphicsPipe::_type_handle [static, private]

Reimplemented from GraphicsPipe.
Definition at line 31 of file glxGraphicsPipe.cxx.

Atom glxGraphicsPipe::_wm_delete_window [private]

Definition at line 86 of file glxGraphicsPipe.h.

Atom glxGraphicsPipe::_wm_protocols [private]

Definition at line 85 of file glxGraphicsPipe.h.

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

panda/src/glxdisplay/glxGraphicsPipe.h
panda/src/glxdisplay/glxGraphicsPipe.cxx
panda/src/glxdisplay/glxGraphicsPipe.I

Generated on Fri May 2 00:51:13 2003 for Panda by

1.3

glxGraphicsPipe Class Reference

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation