Panda3D
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends

VertexBufferContext Class Reference

This is a special class object that holds all the information returned by a particular GSG to indicate the vertex data array's internal context identifier. More...

#include "vertexBufferContext.h"

Inheritance diagram for VertexBufferContext:
BufferContext AdaptiveLruPage SavedContext LinkedListNode AdaptiveLruPageDynamicList AdaptiveLruPageStaticList TypedObject LinkedListNode LinkedListNode MemoryBase DXVertexBufferContext8 DXVertexBufferContext9

List of all members.

Public Member Functions

 VertexBufferContext (PreparedGraphicsObjects *pgo, GeomVertexArrayData *data)
TypedObjectas_typed_object ()
 Returns the object, upcast (if necessary) to a TypedObject pointer.
const TypedObjectas_typed_object () const
 Returns the object, upcast (if necessary) to a TypedObject pointer.
bool changed_size (const GeomVertexArrayDataHandle *reader) const
 Returns true if the data has changed size since the last time mark_loaded() was called.
bool changed_usage_hint (const GeomVertexArrayDataHandle *reader) const
 Returns true if the data has changed its usage hint since the last time mark_loaded() was called.
void dequeue_lru ()
 Removes the page from its AdaptiveLru.
void enqueue_lru (AdaptiveLru *lru)
 Adds the page to the LRU for the first time, or marks it recently-accessed if it has already been added.
virtual void evict_lru ()
 Evicts the page from the LRU.
virtual TypeHandle force_init_type ()
bool get_active () const
 Returns the active flag associated with this object.
int get_best_parent_from_Set (const std::set< int > &) const
GeomVertexArrayDataget_data () const
 Returns the pointer to the client-side array data object.
size_t get_data_size_bytes () const
 Returns the number of bytes previously reported for the data object.
AdaptiveLruget_lru () const
 Returns the LRU that manages this page, or NULL if it is not currently managed by any LRU.
size_t get_lru_size () const
 Returns the size of this page as reported to the LRU, presumably in bytes.
UpdateSeq get_modified () const
 Returns the UpdateSeq that was recorded the last time mark_loaded() was called.
BufferContextget_next () const
 This can be used along with BufferContextChain::get_first() to walk through the list of objects stored on a tracker.
unsigned int get_num_frames () const
 Returns the number of frames since the page was first added to its LRU.
unsigned int get_num_inactive_frames () const
 Returns the number of frames since the page was last accessed on its LRU.
bool get_resident () const
 Returns the resident flag associated with this object.
virtual TypeHandle get_type () const
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_exact_type (TypeHandle handle) const
 Returns true if the current object is the indicated type exactly.
bool is_of_type (TypeHandle handle) const
 Returns true if the current object is or derives from the indicated type.
void mark_loaded (const GeomVertexArrayDataHandle *reader)
 Should be called after the VertexBufferContext has been loaded into graphics memory, this updates the internal flags for changed_size() and modified().
void mark_unloaded ()
 Should be called after the buffer has been forced out of graphics memory.
void mark_used_lru () const
 To be called when the page is used; this will move it to the tail of the AdaptiveLru queue it is already on.
void mark_used_lru (AdaptiveLru *lru)
 To be called when the page is used; this will move it to the tail of the specified AdaptiveLru queue.
void operator delete (void *ptr)
void operator delete (void *ptr, void *)
void operator delete[] (void *, void *)
void operator delete[] (void *ptr)
void * operator new (size_t size, void *ptr)
void * operator new (size_t size)
void * operator new[] (size_t size, void *ptr)
void * operator new[] (size_t size)
virtual void output (ostream &out) const
void set_active (bool flag)
 Changes the active flag associated with this object.
void set_lru_size (size_t lru_size)
 Specifies the size of this page, presumably in bytes, although any unit is possible.
void set_resident (bool flag)
 Changes the resident flag associated with this object.
void update_data_size_bytes (size_t new_data_size_bytes)
 Should be called (usually by a derived class) when the on-card size of this object has changed.
void update_modified (UpdateSeq new_modified)
 Should be called (usually by a derived class) when the modified counter for this object has changed.
bool was_modified (const GeomVertexArrayDataHandle *reader) const
 Returns true if the data has been modified since the last time mark_loaded() was called.
virtual void write (ostream &out, int indent_level) const

Static Public Member Functions

static TypeHandle get_class_type ()
static void init_type ()
 This function is declared non-inline to work around a compiler bug in g++ 2.96.

Protected Member Functions

void insert_after (LinkedListNode *node)
 Adds a LinkedListNode record after the indicated node in the doubly-linked list.
void insert_after (LinkedListNode *node)
 Adds a LinkedListNode record after the indicated node in the doubly-linked list.
void insert_before (LinkedListNode *node)
 Adds a LinkedListNode record before the indicated node in the doubly-linked list.
void insert_before (LinkedListNode *node)
 Adds a LinkedListNode record before the indicated node in the doubly-linked list.
bool is_on_list () const
 Returns true if the node is member of any list, false if it has been removed or never added.
bool is_on_list () const
 Returns true if the node is member of any list, false if it has been removed or never added.
void remove_from_list ()
 Removes a LinkedListNode record from the doubly-linked list.
void remove_from_list ()
 Removes a LinkedListNode record from the doubly-linked list.
void take_list_from (LinkedListNode *other_root)
 Given that this LinkedListNode represents the root of a list, and the other pointer represents the root of a different list, move all of the nodes (except the root itself) from other_root onto this list.
void take_list_from (LinkedListNode *other_root)
 Given that this LinkedListNode represents the root of a list, and the other pointer represents the root of a different list, move all of the nodes (except the root itself) from other_root onto this list.

Protected Attributes

LinkedListNode_next
LinkedListNode_next
LinkedListNode_prev
LinkedListNode_prev

Friends

class PreparedGraphicsObjects

Detailed Description

This is a special class object that holds all the information returned by a particular GSG to indicate the vertex data array's internal context identifier.

This allows the GSG to cache the vertex data array in whatever way makes sense. For instance, DirectX can allocate a vertex buffer for the array. OpenGL can create a buffer object.

Definition at line 36 of file vertexBufferContext.h.


Member Function Documentation

TypedObject * TypedObject::as_typed_object ( ) [inline, inherited]

Returns the object, upcast (if necessary) to a TypedObject pointer.

Definition at line 99 of file typedObject.I.

const TypedObject * TypedObject::as_typed_object ( ) const [inline, inherited]

Returns the object, upcast (if necessary) to a TypedObject pointer.

Definition at line 110 of file typedObject.I.

bool VertexBufferContext::changed_size ( const GeomVertexArrayDataHandle reader) const [inline]

Returns true if the data has changed size since the last time mark_loaded() was called.

Definition at line 47 of file vertexBufferContext.I.

References BufferContext::get_data_size_bytes().

Referenced by DXGraphicsStateGuardian9::apply_vertex_buffer(), and DXGraphicsStateGuardian8::apply_vertex_buffer().

bool VertexBufferContext::changed_usage_hint ( const GeomVertexArrayDataHandle reader) const [inline]

Returns true if the data has changed its usage hint since the last time mark_loaded() was called.

Definition at line 59 of file vertexBufferContext.I.

void AdaptiveLruPage::dequeue_lru ( ) [inline, inherited]
void AdaptiveLruPage::enqueue_lru ( AdaptiveLru lru) [inherited]
void AdaptiveLruPage::evict_lru ( ) [virtual, inherited]

Evicts the page from the LRU.

Called internally when the LRU determines that it is full. May also be called externally when necessary to explicitly evict the page.

It is legal for this method to either evict the page as requested, do nothing (in which case the eviction will be requested again at the next epoch), or requeue itself on the tail of the queue (in which case the eviction will be requested again much later).

Reimplemented in DXIndexBufferContext8, DXTextureContext8, DXVertexBufferContext8, DXIndexBufferContext9, DXTextureContext9, DXVertexBufferContext9, and TinyTextureContext.

Definition at line 557 of file adaptiveLru.cxx.

References AdaptiveLruPage::dequeue_lru().

Referenced by AdaptiveLru::do_evict_to().

bool BufferContext::get_active ( ) const [inline, inherited]

Returns the active flag associated with this object.

An object is considered "active" if it was rendered in the current frame.

Definition at line 49 of file bufferContext.I.

Referenced by Texture::get_active().

GeomVertexArrayData * VertexBufferContext::get_data ( ) const [inline]
size_t BufferContext::get_data_size_bytes ( ) const [inline, inherited]

Returns the number of bytes previously reported for the data object.

This is used to track changes in the data object's allocated size; if it changes from this, we need to create a new buffer. This is also used to track memory utilization in PStats.

Definition at line 26 of file bufferContext.I.

Referenced by changed_size(), IndexBufferContext::changed_size(), and Texture::get_data_size_bytes().

AdaptiveLru * AdaptiveLruPage::get_lru ( ) const [inline, inherited]

Returns the LRU that manages this page, or NULL if it is not currently managed by any LRU.

Definition at line 161 of file adaptiveLru.I.

size_t AdaptiveLruPage::get_lru_size ( ) const [inline, inherited]

Returns the size of this page as reported to the LRU, presumably in bytes.

Definition at line 209 of file adaptiveLru.I.

UpdateSeq BufferContext::get_modified ( ) const [inline, inherited]

Returns the UpdateSeq that was recorded the last time mark_loaded() was called.

Definition at line 37 of file bufferContext.I.

Referenced by IndexBufferContext::was_modified(), and was_modified().

BufferContext * BufferContext::get_next ( ) const [inline, inherited]

This can be used along with BufferContextChain::get_first() to walk through the list of objects stored on a tracker.

Definition at line 110 of file bufferContext.I.

unsigned int AdaptiveLruPage::get_num_frames ( ) const [inherited]

Returns the number of frames since the page was first added to its LRU.

Returns 0 if it does not have an LRU.

Definition at line 589 of file adaptiveLru.cxx.

unsigned int AdaptiveLruPage::get_num_inactive_frames ( ) const [inherited]

Returns the number of frames since the page was last accessed on its LRU.

Returns 0 if it does not have an LRU.

Definition at line 604 of file adaptiveLru.cxx.

bool BufferContext::get_resident ( ) const [inline, inherited]

Returns the resident flag associated with this object.

An object is considered "resident" if it appears to be resident in texture memory.

Definition at line 61 of file bufferContext.I.

Referenced by Texture::get_resident().

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 52 of file typedObject.I.

References TypeHandle::get_index().

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

This function is declared non-inline to work around a compiler bug in g++ 2.96.

Making it inline seems to cause problems in the optimizer.

Reimplemented from BufferContext.

Reimplemented in DXVertexBufferContext8, and DXVertexBufferContext9.

Definition at line 67 of file vertexBufferContext.h.

References BufferContext::init_type().

Referenced by DXVertexBufferContext9::init_type(), and DXVertexBufferContext8::init_type().

void LinkedListNode::insert_after ( LinkedListNode node) [inline, protected, inherited]

Adds a LinkedListNode record after the indicated node in the doubly-linked list.

Definition at line 108 of file linkedListNode.I.

void LinkedListNode::insert_after ( LinkedListNode node) [inline, protected, inherited]

Adds a LinkedListNode record after the indicated node in the doubly-linked list.

Definition at line 108 of file linkedListNode.I.

void LinkedListNode::insert_before ( LinkedListNode node) [inline, protected, inherited]

Adds a LinkedListNode record before the indicated node in the doubly-linked list.

Definition at line 91 of file linkedListNode.I.

Referenced by SimpleAllocator::do_alloc(), AdaptiveLru::do_partial_lru_update(), and SimpleLruPage::enqueue_lru().

void LinkedListNode::insert_before ( LinkedListNode node) [inline, protected, inherited]

Adds a LinkedListNode record before the indicated node in the doubly-linked list.

Definition at line 91 of file linkedListNode.I.

Referenced by SimpleAllocator::do_alloc(), AdaptiveLru::do_partial_lru_update(), and SimpleLruPage::enqueue_lru().

bool TypedObject::is_exact_type ( TypeHandle  handle) const [inline, inherited]
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 63 of file typedObject.I.

References TypeHandle::is_derived_from().

Referenced by EggSliderData::add_back_pointer(), EggJointData::add_back_pointer(), CIntervalManager::add_c_interval(), XFileNode::add_child(), CollisionTraverser::add_collider(), CollisionHandlerPhysical::add_collider(), EggXfmSAnim::add_data(), CharacterJointBundle::add_node(), NonlinearImager::add_screen(), EggGroupNode::apply_first_attribute(), EggGroupNode::apply_last_attribute(), DeferredNodeProperty::apply_to_node(), RecorderController::begin_playback(), NodePath::clear_clip_plane(), EggGroupNode::clear_connected_shading(), NodePath::clear_light(), EggBase::convert_paths(), NodePath::decode_from_bam_stream(), VrpnClient::disconnect_device(), PhysicsManager::do_physics(), GraphicsStateGuardian::fetch_specified_part(), EggRenderState::fill_state(), AnimBundleNode::find_anim_bundle(), EggGroupNode::find_coordsys_entry(), XFile::find_data_object(), Character::find_joint(), EggGroupNode::find_materials(), Character::find_slider(), XFile::find_template(), EggGroupNode::find_textures(), EggMaterialCollection::find_used_materials(), EggTextureCollection::find_used_textures(), EggGroupNode::force_filenames(), EggJointData::force_initial_rest_frame(), WindowFramework::get_aspect_2d(), EggPoolUniquifier::get_category(), EggGroupUniquifier::get_category(), EggGroupNode::get_connected_shading(), PandaFramework::get_mouse(), FactoryParams::get_param_of_type(), EggGroupNode::has_absolute_pathnames(), NodePath::has_clip_plane(), NodePath::has_clip_plane_off(), NodePath::has_light(), PandaFramework::hide_collision_solids(), x11GraphicsWindow::open_window(), eglGraphicsWindow::open_window(), EggNode::parse_egg(), CharacterMaker::part_to_node(), EggGroupNode::post_apply_flat_attribute(), EggBinner::prepare_node(), PortalClipper::prepare_portal(), NodePath::project_texture(), EggMatrixTablePointer::quantize_channels(), ParametricCurveCollection::r_add_curves(), SceneGraphReducer::r_collect_vertex_data(), EggGroupNode::r_load_externals(), EggGroupNode::rebuild_vertex_pools(), EggGroupNode::recompute_polygon_normals(), EggGroupNode::remove_invalid_primitives(), EggGroupNode::remove_unused_vertices(), EggLoader::reparent_decals(), EggMaterialCollection::replace_materials(), EggTextureCollection::replace_textures(), EggGroupNode::resolve_filenames(), EggGroupNode::reverse_vertex_ordering(), NodePath::set_clip_plane(), NodePath::set_clip_plane_off(), NodePath::set_light(), ProjectionScreen::set_projector(), NonlinearImager::set_source_camera(), EggXfmSAnim::set_value(), NonlinearImager::set_viewer_camera(), PandaFramework::show_collision_solids(), BamCache::store(), XFileToEggConverter::strip_nodes(), EggGroupNode::strip_normals(), DataGraphTraverser::traverse(), DataGraphTraverser::traverse_below(), EggGroupNode::triangulate_polygons(), EggGroupNode::unify_attributes(), EggNameUniquifier::uniquify(), NodeCullCallbackData::upcall(), PhysicsCollisionHandler::validate_target(), EggXfmSAnim::write(), EggGroup::write(), EggToDXFLayer::write_3d_face(), and EggToDXFLayer::write_entities().

bool LinkedListNode::is_on_list ( ) const [inline, protected, inherited]

Returns true if the node is member of any list, false if it has been removed or never added.

The head of a list generally appears to to always be a member of itself.

Definition at line 62 of file linkedListNode.I.

bool LinkedListNode::is_on_list ( ) const [inline, protected, inherited]

Returns true if the node is member of any list, false if it has been removed or never added.

The head of a list generally appears to to always be a member of itself.

Definition at line 62 of file linkedListNode.I.

void VertexBufferContext::mark_loaded ( const GeomVertexArrayDataHandle reader) [inline]

Should be called after the VertexBufferContext has been loaded into graphics memory, this updates the internal flags for changed_size() and modified().

Definition at line 96 of file vertexBufferContext.I.

References BufferContext::set_resident(), update_data_size_bytes(), and BufferContext::update_modified().

Referenced by DXGraphicsStateGuardian8::apply_vertex_buffer(), and DXGraphicsStateGuardian9::apply_vertex_buffer().

void VertexBufferContext::mark_unloaded ( ) [inline]

Should be called after the buffer has been forced out of graphics memory.

Definition at line 113 of file vertexBufferContext.I.

References UpdateSeq::old(), BufferContext::set_resident(), and BufferContext::update_modified().

Referenced by DXVertexBufferContext9::evict_lru(), and DXVertexBufferContext8::evict_lru().

void AdaptiveLruPage::mark_used_lru ( ) const [inline, inherited]

To be called when the page is used; this will move it to the tail of the AdaptiveLru queue it is already on.

This method is const because it's not technically modifying the contents of the page itself.

Definition at line 185 of file adaptiveLru.I.

Referenced by DXTextureContext8::evict_lru(), and DXTextureContext9::evict_lru().

void AdaptiveLruPage::mark_used_lru ( AdaptiveLru lru) [inline, inherited]

To be called when the page is used; this will move it to the tail of the specified AdaptiveLru queue.

Definition at line 198 of file adaptiveLru.I.

References AdaptiveLruPage::enqueue_lru().

void LinkedListNode::remove_from_list ( ) [inline, protected, inherited]

Removes a LinkedListNode record from the doubly-linked list.

Definition at line 73 of file linkedListNode.I.

Referenced by SimpleLruPage::dequeue_lru(), SimpleAllocatorBlock::do_free(), AdaptiveLru::do_partial_lru_update(), and SimpleLruPage::enqueue_lru().

void LinkedListNode::remove_from_list ( ) [inline, protected, inherited]

Removes a LinkedListNode record from the doubly-linked list.

Definition at line 73 of file linkedListNode.I.

Referenced by SimpleLruPage::dequeue_lru(), SimpleAllocatorBlock::do_free(), AdaptiveLru::do_partial_lru_update(), and SimpleLruPage::enqueue_lru().

void BufferContext::set_active ( bool  flag) [inline, inherited]
void AdaptiveLruPage::set_lru_size ( size_t  lru_size) [inline, inherited]

Specifies the size of this page, presumably in bytes, although any unit is possible.

Definition at line 220 of file adaptiveLru.I.

Referenced by update_data_size_bytes(), IndexBufferContext::update_data_size_bytes(), and TextureContext::update_data_size_bytes().

void BufferContext::set_resident ( bool  flag) [inline, inherited]

Changes the resident flag associated with this object.

An object is considered "resident" if it appears to be resident in texture memory.

Definition at line 93 of file bufferContext.I.

Referenced by mark_loaded(), TextureContext::mark_loaded(), IndexBufferContext::mark_loaded(), TextureContext::mark_simple_loaded(), mark_unloaded(), TextureContext::mark_unloaded(), and IndexBufferContext::mark_unloaded().

void LinkedListNode::take_list_from ( LinkedListNode other_root) [inline, protected, inherited]

Given that this LinkedListNode represents the root of a list, and the other pointer represents the root of a different list, move all of the nodes (except the root itself) from other_root onto this list.

Definition at line 127 of file linkedListNode.I.

Referenced by BufferContextChain::take_from().

void LinkedListNode::take_list_from ( LinkedListNode other_root) [inline, protected, inherited]

Given that this LinkedListNode represents the root of a list, and the other pointer represents the root of a different list, move all of the nodes (except the root itself) from other_root onto this list.

Definition at line 127 of file linkedListNode.I.

Referenced by BufferContextChain::take_from().

void VertexBufferContext::update_data_size_bytes ( size_t  new_data_size_bytes) [inline]

Should be called (usually by a derived class) when the on-card size of this object has changed.

Reimplemented from BufferContext.

Definition at line 83 of file vertexBufferContext.I.

References AdaptiveLruPage::set_lru_size().

Referenced by DXVertexBufferContext9::evict_lru(), DXVertexBufferContext8::evict_lru(), and mark_loaded().

void BufferContext::update_modified ( UpdateSeq  new_modified) [inline, inherited]

Should be called (usually by a derived class) when the modified counter for this object has changed.

Definition at line 139 of file bufferContext.I.

Referenced by mark_loaded(), TextureContext::mark_loaded(), IndexBufferContext::mark_loaded(), TextureContext::mark_simple_loaded(), mark_unloaded(), TextureContext::mark_unloaded(), and IndexBufferContext::mark_unloaded().

bool VertexBufferContext::was_modified ( const GeomVertexArrayDataHandle reader) const [inline]

Returns true if the data has been modified since the last time mark_loaded() was called.

Definition at line 71 of file vertexBufferContext.I.

References BufferContext::get_modified().

Referenced by DXGraphicsStateGuardian8::apply_vertex_buffer(), and DXGraphicsStateGuardian9::apply_vertex_buffer().


The documentation for this class was generated from the following files:
 All Classes Functions Variables Enumerations