---

SavedFrameBuffer Class Reference

Occasionally we need to save the contents of the frame buffer for restoring later, particularly when we are doing multipass effects. More...

#include <savedFrameBuffer.h>

Inheritance diagram for SavedFrameBuffer:

List of all members.

Public Member Functions
	SavedFrameBuffer (const RenderBuffer &buffer, ConstPointerTo< DisplayRegion > dr)
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 ()
Public Attributes
RenderBuffer	_buffer
ConstPointerTo< DisplayRegion >	_display_region
Static Private Attributes
TypeHandle	_type_handle

---

Detailed Description

Occasionally we need to save the contents of the frame buffer for restoring later, particularly when we are doing multipass effects.

The precise form in which the frame buffer is optimally saved may vary from one platform to another; hence, we have the SavedFrameBuffer class, which is a placeholder structure to store the frame buffer in whichever way a particular GSG would prefer to do it.

Each specific GSG will also derive a new kind of SavedFrameBuffer object that it will use to store its frame buffer contents meaningfully.

This class is not meant to be used directly; it is used within the FrameBufferStack class to support GraphicsStateGuardian::push_frame_buffer() and pop_frame_buffer().

Definition at line 72 of file savedFrameBuffer.h.

---

Constructor & Destructor Documentation

SavedFrameBuffer::SavedFrameBuffer (  const RenderBuffer &  buffer, ConstPointerTo< DisplayRegion >  dr )  [inline]

---

Member Function Documentation

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

Reimplemented from TypedReferenceCount. Reimplemented in CRSavedFrameBuffer, DXSavedFrameBuffer7, DXSavedFrameBuffer8, and GLSavedFrameBuffer. Definition at line 93 of file savedFrameBuffer.h.

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

Reimplemented from TypedReferenceCount. Reimplemented in CRSavedFrameBuffer, DXSavedFrameBuffer7, DXSavedFrameBuffer8, and GLSavedFrameBuffer. Definition at line 82 of file savedFrameBuffer.h. Referenced by GLSavedFrameBuffer::init_type(), DXSavedFrameBuffer8::init_type(), DXSavedFrameBuffer7::init_type(), and CRSavedFrameBuffer::init_type().

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 SavedFrameBuffer::get_type (  void   )  const [inline, virtual]

Reimplemented from TypedReferenceCount. Reimplemented in CRSavedFrameBuffer, DXSavedFrameBuffer7, DXSavedFrameBuffer8, and GLSavedFrameBuffer. Definition at line 90 of file savedFrameBuffer.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 SavedFrameBuffer::init_type (  void   )  [inline, static]

Reimplemented from TypedReferenceCount. Reimplemented in CRSavedFrameBuffer, DXSavedFrameBuffer7, DXSavedFrameBuffer8, and GLSavedFrameBuffer. Definition at line 85 of file savedFrameBuffer.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().

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

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

---

Member Data Documentation

RenderBuffer SavedFrameBuffer::_buffer

Definition at line 77 of file savedFrameBuffer.h. Referenced by CRGraphicsStateGuardian::enable_lighting().

ConstPointerTo< DisplayRegion > SavedFrameBuffer::_display_region

Definition at line 78 of file savedFrameBuffer.h. Referenced by CRGraphicsStateGuardian::enable_lighting().

TypeHandle SavedFrameBuffer::_type_handle [static, private]

Reimplemented from TypedReferenceCount. Reimplemented in CRSavedFrameBuffer, DXSavedFrameBuffer7, DXSavedFrameBuffer8, and GLSavedFrameBuffer. Definition at line 25 of file savedFrameBuffer.cxx.

---

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

• panda/src/display/savedFrameBuffer.h
• panda/src/display/savedFrameBuffer.cxx

---