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

GraphicsPipe Class Reference

An object to create GraphicsWindows that share a particular 3-D API. More...

#include <graphicsPipe.h>

Inheritance diagram for GraphicsPipe:

TypedReferenceCount TypedObject ReferenceCount glxGraphicsPipe WinGraphicsPipe wdxGraphicsPipe7 wdxGraphicsPipe8 wglGraphicsPipe List of all members.

Public Member Functions

virtual ~GraphicsPipe ()
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 string get_interface_name () const=0
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().

virtual TypeHandle get_type () const
virtual TypeHandle force_init_type ()
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

TypeHandle get_class_type ()
void init_type ()

Protected Member Functions

 GraphicsPipe ()
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 Member Functions

 GraphicsPipe (const GraphicsPipe &copy)
 Don't try to copy GraphicsPipes.

void operator= (const GraphicsPipe &copy)
 Don't try to copy GraphicsPipes.


Static Private Attributes

TypeHandle _type_handle

Friends

class GraphicsEngine

Detailed Description

An object to create GraphicsWindows that share a particular 3-D API.

Normally, there will only be one GraphicsPipe in an application, although it is possible to have multiple of these at once if there are multiple different API's available in the same machine.

Often, the GraphicsPipe corresponds to a physical output device, hence the term "pipe", but this is not necessarily the case.

The GraphicsPipe is used by the GraphicsEngine object to create and destroy windows; it keeps ownership of the windows it creates.

Definition at line 70 of file graphicsPipe.h.

Constructor & Destructor Documentation

GraphicsPipe::GraphicsPipe (   )  [protected]
 

Definition at line 36 of file graphicsPipe.cxx.

References _display_height, _display_width, and _supports_fullscreen.

GraphicsPipe::GraphicsPipe (  const GraphicsPipe &  copy  )  [private]
 

Don't try to copy GraphicsPipes.

Definition at line 58 of file graphicsPipe.cxx.

References nassertv.

GraphicsPipe::~GraphicsPipe (   )  [virtual]
 

Definition at line 84 of file graphicsPipe.cxx.

Member Function Documentation

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

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.

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

Reimplemented from TypedReferenceCount.

Reimplemented in wdxGraphicsPipe7, wdxGraphicsPipe8, glxGraphicsPipe, wglGraphicsPipe, and WinGraphicsPipe.

Definition at line 119 of file graphicsPipe.h.

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

Reimplemented from TypedReferenceCount.

Reimplemented in wdxGraphicsPipe7, wdxGraphicsPipe8, glxGraphicsPipe, wglGraphicsPipe, and WinGraphicsPipe.

Definition at line 108 of file graphicsPipe.h.

int GraphicsPipe::get_display_height (   )  const [inline]
 

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]
 

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]
 

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.

virtual string GraphicsPipe::get_interface_name (   )  const [pure virtual]
 

Implemented in wdxGraphicsPipe7, wdxGraphicsPipe8, glxGraphicsPipe, and wglGraphicsPipe.

int GraphicsPipe::get_num_hw_channels (   )  [virtual]
 

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().

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

Reimplemented from TypedReferenceCount.

Reimplemented in wdxGraphicsPipe7, wdxGraphicsPipe8, glxGraphicsPipe, wglGraphicsPipe, and WinGraphicsPipe.

Definition at line 116 of file graphicsPipe.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.

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

Reimplemented from TypedReferenceCount.

Reimplemented in wdxGraphicsPipe7, wdxGraphicsPipe8, glxGraphicsPipe, wglGraphicsPipe, and WinGraphicsPipe.

Definition at line 111 of file graphicsPipe.h.

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]
 

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 _supports_fullscreen, and INLINE.

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

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]
 

void GraphicsPipe::operator= (  const GraphicsPipe &  copy  )  [private]
 

Don't try to copy GraphicsPipes.

Definition at line 72 of file graphicsPipe.cxx.

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]
 

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 _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().

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().

Friends And Related Function Documentation

friend class GraphicsEngine [friend]
 

Definition at line 123 of file graphicsPipe.h.

Member Data Documentation

int GraphicsPipe::_display_height [protected]
 

Definition at line 105 of file graphicsPipe.h.

Referenced by GraphicsPipe(), and supports_fullscreen().

int GraphicsPipe::_display_width [protected]
 

Definition at line 104 of file graphicsPipe.h.

Referenced by GraphicsPipe().

bool GraphicsPipe::_is_valid [protected]
 

Definition at line 102 of file graphicsPipe.h.

Referenced by wglGraphicsPipe::get_interface_name(), glxGraphicsPipe::get_interface_name(), and wdxGraphicsPipe8::get_interface_name().

Mutex GraphicsPipe::_lock [protected]
 

Definition at line 100 of file graphicsPipe.h.

bool GraphicsPipe::_supports_fullscreen [protected]
 

Definition at line 103 of file graphicsPipe.h.

Referenced by GraphicsPipe(), and is_valid().

TypeHandle GraphicsPipe::_type_handle [static, private]
 

Reimplemented from TypedReferenceCount.

Reimplemented in wdxGraphicsPipe7, wdxGraphicsPipe8, glxGraphicsPipe, wglGraphicsPipe, and WinGraphicsPipe.

Definition at line 26 of file graphicsPipe.cxx.

The documentation for this class was generated from the following files:
Generated on Fri May 2 00:51:22 2003 for Panda by doxygen1.3