Panda3D
Classes | Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Friends | List of all members
RenderState Class Reference

This represents a unique collection of RenderAttrib objects that correspond to a particular renderable state. More...

#include "renderState.h"

Inheritance diagram for RenderState:
NodeCachedReferenceCount CachedTypedWritableReferenceCount TypedWritableReferenceCount TypedWritable ReferenceCount TypedObject MemoryBase MemoryBase

Public Types

typedef RenderAttribRegistry::SlotMask SlotMask
 
- Public Types inherited from NodeCachedReferenceCount
enum  Referenced { R_node = 0x001, R_cache = 0x002 }
 

Public Member Functions

virtual ~RenderState ()
 The destructor is responsible for removing the RenderState from the global set if it is there. More...
 
void cache_ref () const
 
bool cache_unref () const
 
int compare_mask (const RenderState &other, SlotMask compare_mask) const
 This version of compare_to takes a slot mask that indicates which attributes to include in the comparison. More...
 
int compare_sort (const RenderState &other) const
 Returns -1, 0, or 1 according to the relative sorting of these two RenderStates, with regards to rendering performance, so that "heavier" RenderAttribs (as defined by RenderAttribRegistry::get_slot_sort()) are more likely to be grouped together. More...
 
int compare_to (const RenderState &other) const
 Provides an arbitrary ordering among all unique RenderStates, so we can store the essentially different ones in a big set and throw away the rest. More...
 
virtual int complete_pointers (TypedWritable **plist, BamReader *manager)
 Receives an array of pointers, one for each time manager->read_pointer() was called in fillin(). More...
 
 CPT (RenderState) compose(const RenderState *other) const
 
 CPT (RenderState) invert_compose(const RenderState *other) const
 
 CPT (RenderState) add_attrib(const RenderAttrib *attrib
 
 CPT (RenderState) set_attrib(const RenderAttrib *attrib) const
 
 CPT (RenderState) set_attrib(const RenderAttrib *attrib
 
 CPT (RenderState) remove_attrib(TypeHandle type) const
 
 CPT (RenderState) remove_attrib(int slot) const
 
 CPT (RenderState) adjust_all_priorities(int adjustment) const
 
 CPT (RenderState) get_unique() const
 
 CPT (RenderAttrib) _generated_shader
 
bool cull_callback (CullTraverser *trav, const CullTraverserData &data) const
 Calls cull_callback() on each attrib. More...
 
virtual void finalize (BamReader *manager)
 Called by the BamReader to perform any final actions needed for setting up the object after all objects have been read and all pointers have been completed. More...
 
virtual TypeHandle force_init_type ()
 
const RenderAttribget_attrib (TypeHandle type) const
 
const RenderAttribget_attrib (int slot) const
 
template<class AttribType >
bool get_attrib (const AttribType *&attrib) const
 Handy templated version of get_attrib that casts to the right type. More...
 
template<class AttribType >
bool get_attrib (CPT(AttribType) &attrib) const
 
const RenderAttribget_attrib_def (int slot) const
 
template<class AttribType >
void get_attrib_def (const AttribType *&attrib) const
 Handy templated version of get_attrib_def that casts to the right type. More...
 
template<class AttribType >
void get_attrib_def (CPT(AttribType) &attrib) const
 
int get_bin_index () const
 
size_t get_composition_cache_num_entries () const
 
const RenderStateget_composition_cache_result (size_t n) const
 
size_t get_composition_cache_size () const
 
const RenderStateget_composition_cache_source (size_t n) const
 
int get_draw_order () const
 
int get_geom_rendering (int geom_rendering) const
 Returns the union of the Geom::GeomRendering bits that will be required once this RenderState is applied to a geom which includes the indicated geom_rendering bits. More...
 
size_t get_hash () const
 Returns a suitable hash value for phash_map. More...
 
size_t get_invert_composition_cache_num_entries () const
 
const RenderStateget_invert_composition_cache_result (size_t n) const
 
size_t get_invert_composition_cache_size () const
 
const RenderStateget_invert_composition_cache_source (size_t n) const
 
int get_override (TypeHandle type) const
 
int get_override (int slot) const
 
virtual TypeHandle get_type () const
 
bool has_attrib (TypeHandle type) const
 
bool has_attrib (int slot) const
 
bool has_cull_callback () const
 Returns true if any of the RenderAttribs in this state request a cull_callback(), false if none of them do. More...
 
bool is_empty () const
 Returns true if the state is empty, false otherwise. More...
 
void node_ref () const
 
bool node_unref () const
 
RenderStateoperator= (const RenderState &copy)=delete
 
void output (std::ostream &out) const
 
virtual bool unref () const
 Explicitly decrements the reference count. More...
 
void write (std::ostream &out, int indent_level) const
 
virtual void write_datagram (BamWriter *manager, Datagram &dg)
 Writes the contents of this object to the datagram for shipping out to a Bam file. More...
 
- Public Member Functions inherited from NodeCachedReferenceCount
int get_node_ref_count () const
 Returns the current reference count. More...
 
int get_referenced_bits () const
 Returns the union of the values defined in the Referenced enum that represents the various things that appear to be holding a pointer to this object. More...
 
void node_ref () const
 Explicitly increments the reference count. More...
 
bool node_unref () const
 Explicitly decrements the node reference count and the normal reference count simultaneously. More...
 
bool test_ref_count_integrity () const
 Does some easy checks to make sure that the reference count isn't completely bogus. More...
 
- Public Member Functions inherited from CachedTypedWritableReferenceCount
void cache_ref () const
 Explicitly increments the cache reference count and the normal reference count simultaneously. More...
 
void cache_ref_only () const
 Decrements the cache reference count without affecting the normal reference count. More...
 
bool cache_unref () const
 Explicitly decrements the cache reference count and the normal reference count simultaneously. More...
 
int get_cache_ref_count () const
 
bool test_ref_count_integrity () const
 Does some easy checks to make sure that the reference count isn't completely bogus. More...
 
- Public Member Functions inherited from TypedWritableReferenceCount
 TypedWritableReferenceCount (const TypedWritableReferenceCount &copy)
 
virtual ReferenceCountas_reference_count ()
 Returns the pointer cast to a ReferenceCount pointer, if it is in fact of that type. More...
 
void operator= (const TypedWritableReferenceCount &copy)
 
- Public Member Functions inherited from TypedWritable
 TypedWritable (const TypedWritable &copy)
 
vector_uchar encode_to_bam_stream () const
 Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a bytes object. More...
 
bool encode_to_bam_stream (vector_uchar &data, BamWriter *writer=nullptr) const
 Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string. More...
 
UpdateSeq get_bam_modified () const
 Returns the current bam_modified counter. More...
 
void mark_bam_modified ()
 Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams. More...
 
void operator= (const TypedWritable &copy)
 
virtual bool require_fully_complete () const
 Some objects require all of their nested pointers to have been completed before the objects themselves can be completed. More...
 
virtual void update_bam_nested (BamWriter *manager)
 Called by the BamWriter when this object has not itself been modified recently, but it should check its nested objects for updates. More...
 
- Public Member Functions inherited from TypedObject
 TypedObject (const TypedObject &copy)=default
 
TypedObjectas_typed_object ()
 Returns the object, upcast (if necessary) to a TypedObject pointer. More...
 
const TypedObjectas_typed_object () const
 Returns the object, upcast (if necessary) to a TypedObject pointer. More...
 
int get_best_parent_from_Set (const std::set< int > &) const
 
int get_type_index () const
 Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. More...
 
bool is_exact_type (TypeHandle handle) const
 Returns true if the current object is the indicated type exactly. More...
 
bool is_of_type (TypeHandle handle) const
 Returns true if the current object is or derives from the indicated type. More...
 
TypedObjectoperator= (const TypedObject &copy)=default
 
- Public Member Functions inherited from ReferenceCount
int get_ref_count () const
 
WeakReferenceListget_weak_list () const
 Returns the WeakReferenceList associated with this ReferenceCount object. More...
 
bool has_weak_list () const
 Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise. More...
 
void local_object ()
 This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack. More...
 
void ref () const
 Explicitly increments the reference count. More...
 
bool ref_if_nonzero () const
 Atomically increases the reference count of this object if it is not zero. More...
 
bool test_ref_count_integrity () const
 Does some easy checks to make sure that the reference count isn't completely bogus. More...
 
bool test_ref_count_nonzero () const
 Does some easy checks to make sure that the reference count isn't zero, or completely bogus. More...
 
WeakReferenceListweak_ref ()
 Adds the indicated PointerToVoid as a weak reference to this object. More...
 
void weak_unref ()
 Removes the indicated PointerToVoid as a weak reference to this object. More...
 

Static Public Member Functions

static void bin_removed (int bin_index)
 Intended to be called by CullBinManager::remove_bin(), this informs all the RenderStates in the world to remove the indicated bin_index from their cache if it has been cached. More...
 
static TypedWritablechange_this (TypedWritable *old_ptr, BamReader *manager)
 Called immediately after complete_pointers(), this gives the object a chance to adjust its own pointer if desired. More...
 
static int clear_cache ()
 Empties the cache of composed RenderStates. More...
 
static void clear_munger_cache ()
 Completely empties the cache of state + gsg -> munger, for all states and all gsg's. More...
 
static CPT (RenderState) make_empty()
 
static CPT (RenderState) make(const RenderAttrib *attrib
 
static CPT (RenderState) make(const RenderAttrib *attrib1
 
static CPT (RenderState) make(const RenderAttrib *attrib1
 
static CPT (RenderState) make(const RenderAttrib *attrib1
 
static CPT (RenderState) make(const RenderAttrib *attrib1
 
static CPT (RenderState) make(const RenderAttrib *const *attrib
 
static void flush_level ()
 Flushes the PStatCollectors used during traversal. More...
 
static int garbage_collect ()
 Performs a garbage-collection cycle. More...
 
static TypeHandle get_class_type ()
 
static int get_max_priority ()
 
static int get_num_states ()
 Returns the total number of unique RenderState objects allocated in the world. More...
 
static int get_num_unused_states ()
 Returns the total number of RenderState objects that have been allocated but have no references outside of the internal RenderState cache. More...
 
static void init_states ()
 Make sure the global _states map is allocated. More...
 
static void init_type ()
 
static void list_cycles (std::ostream &out)
 Detects all of the reference-count cycles in the cache and reports them to standard output. More...
 
static void list_states (std::ostream &out)
 Lists all of the RenderStates in the cache to the output stream, one per line. More...
 
static void register_with_read_factory ()
 Tells the BamReader how to create objects of type RenderState. More...
 
static bool validate_states ()
 Ensures that the cache is still stored in sorted order, and that none of the cache elements have been inadvertently deleted. More...
 
- Static Public Member Functions inherited from NodeCachedReferenceCount
static TypeHandle get_class_type ()
 
static void init_type ()
 
- Static Public Member Functions inherited from CachedTypedWritableReferenceCount
static TypeHandle get_class_type ()
 
static void init_type ()
 
- Static Public Member Functions inherited from TypedWritableReferenceCount
static TypeHandle get_class_type ()
 
static void init_type ()
 
static PT (TypedWritableReferenceCount) decode_from_bam_stream(vector_uchar data
 
- Static Public Member Functions inherited from TypedWritable
static bool decode_raw_from_bam_stream (TypedWritable *&ptr, ReferenceCount *&ref_ptr, vector_uchar data, BamReader *reader=nullptr)
 Reads the bytes created by a previous call to encode_to_bam_stream(), and extracts the single object on those bytes. More...
 
static TypeHandle get_class_type ()
 
static void init_type ()
 
- Static Public Member Functions inherited from TypedObject
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. More...
 
- Static Public Member Functions inherited from ReferenceCount
static TypeHandle get_class_type ()
 
static void init_type ()
 

Public Attributes

UpdateSeq _generated_shader_seq
 
static const RenderAttribattrib2
 
static const RenderAttrib const RenderAttribattrib3
 
static const RenderAttrib const RenderAttrib const RenderAttribattrib4
 
static const RenderAttrib const RenderAttrib const RenderAttrib const RenderAttribattrib5
 
int override const
 
 get_attrib
 
 has_attrib
 
static int num_attribs
 
static int override = 0)
 
static const RenderAttrib int override = 0)
 
static const RenderAttrib const RenderAttrib int override = 0)
 
static const RenderAttrib const RenderAttrib const RenderAttrib int override = 0)
 
static const RenderAttrib const RenderAttrib const RenderAttrib const RenderAttrib int override = 0)
 
static int int override = 0)
 
int override = 0) const
 
- Public Attributes inherited from CachedTypedWritableReferenceCount
 get_cache_ref_count
 Returns the current reference count. More...
 
- Public Attributes inherited from TypedWritableReferenceCount
static BamReaderreader = nullptr)
 
- Public Attributes inherited from TypedObject
 get_type
 
- Public Attributes inherited from ReferenceCount
 get_ref_count
 Returns the current reference count. More...
 

Friends

class Extension< RenderState >
 
class GraphicsStateGuardian
 
class RenderAttribRegistry
 
class ShaderGenerator
 
class StateMunger
 

Additional Inherited Members

- Static Public Attributes inherited from TypedWritable
static TypedWritable *const Null = nullptr
 

Detailed Description

This represents a unique collection of RenderAttrib objects that correspond to a particular renderable state.

You should not attempt to create or modify a RenderState object directly. Instead, call one of the make() functions to create one for you. And instead of modifying a RenderState object, create a new one.

Definition at line 47 of file renderState.h.

Constructor & Destructor Documentation

◆ ~RenderState()

RenderState::~RenderState ( )
virtual

The destructor is responsible for removing the RenderState from the global set if it is there.

Definition at line 115 of file renderState.cxx.

Member Function Documentation

◆ bin_removed()

void RenderState::bin_removed ( int  bin_index)
static

Intended to be called by CullBinManager::remove_bin(), this informs all the RenderStates in the world to remove the indicated bin_index from their cache if it has been cached.

Definition at line 1185 of file renderState.cxx.

◆ change_this()

TypedWritable * RenderState::change_this ( TypedWritable old_ptr,
BamReader manager 
)
static

Called immediately after complete_pointers(), this gives the object a chance to adjust its own pointer if desired.

Most objects don't change pointers after completion, but some need to.

Once this function has been called, the old pointer will no longer be accessed.

Definition at line 1945 of file renderState.cxx.

◆ clear_cache()

int RenderState::clear_cache ( )
static

Empties the cache of composed RenderStates.

This makes every RenderState forget what results when it is composed with other RenderStates.

This will eliminate any RenderState objects that have been allocated but have no references outside of the internal RenderState map. It will not eliminate RenderState objects that are still in use.

Nowadays, this method should not be necessary, as reference-count cycles in the composition cache should be automatically detected and broken.

The return value is the number of RenderStates freed by this operation.

Definition at line 823 of file renderState.cxx.

References SimpleHashMap< Key, Value, Compare >::get_key(), and SimpleHashMap< Key, Value, Compare >::get_num_entries().

◆ clear_munger_cache()

void RenderState::clear_munger_cache ( )
static

Completely empties the cache of state + gsg -> munger, for all states and all gsg's.

Normally there is no need to empty this cache.

Definition at line 980 of file renderState.cxx.

References SimpleHashMap< Key, Value, Compare >::clear(), SimpleHashMap< Key, Value, Compare >::get_key(), and SimpleHashMap< Key, Value, Compare >::get_num_entries().

◆ compare_mask()

int RenderState::compare_mask ( const RenderState other,
SlotMask  compare_mask 
) const

This version of compare_to takes a slot mask that indicates which attributes to include in the comparison.

Unlike compare_to, this method compares the attributes by pointer.

Definition at line 192 of file renderState.cxx.

References BitMask< WType, nbits >::clear_bit(), and BitMask< WType, nbits >::get_lowest_on_bit().

◆ compare_sort()

int RenderState::compare_sort ( const RenderState other) const

Returns -1, 0, or 1 according to the relative sorting of these two RenderStates, with regards to rendering performance, so that "heavier" RenderAttribs (as defined by RenderAttribRegistry::get_slot_sort()) are more likely to be grouped together.

This is not related to the sorting order defined by compare_to.

Definition at line 164 of file renderState.cxx.

References RenderAttribRegistry::get_num_sorted_slots(), RenderAttribRegistry::get_sorted_slot(), and RenderAttribRegistry::quick_get_global_ptr().

◆ compare_to()

int RenderState::compare_to ( const RenderState other) const

Provides an arbitrary ordering among all unique RenderStates, so we can store the essentially different ones in a big set and throw away the rest.

This method is not needed outside of the RenderState class because all equivalent RenderState objects are guaranteed to share the same pointer; thus, a pointer comparison is always sufficient.

Definition at line 141 of file renderState.cxx.

References BitMask< WType, nbits >::clear_bit(), and BitMask< WType, nbits >::get_lowest_on_bit().

◆ complete_pointers()

int RenderState::complete_pointers ( TypedWritable **  p_list,
BamReader manager 
)
virtual

Receives an array of pointers, one for each time manager->read_pointer() was called in fillin().

Returns the number of pointers processed.

Reimplemented from TypedWritable.

Definition at line 1910 of file renderState.cxx.

◆ cull_callback()

bool RenderState::cull_callback ( CullTraverser trav,
const CullTraverserData data 
) const

Calls cull_callback() on each attrib.

If any attrib returns false, interrupts the list and returns false immediately; otherwise, completes the list and returns true.

Definition at line 214 of file renderState.cxx.

◆ finalize()

void RenderState::finalize ( BamReader manager)
virtual

Called by the BamReader to perform any final actions needed for setting up the object after all objects have been read and all pointers have been completed.

Reimplemented from TypedWritable.

Definition at line 1970 of file renderState.cxx.

References unref().

◆ flush_level()

void RenderState::flush_level ( )
inlinestatic

Flushes the PStatCollectors used during traversal.

Definition at line 479 of file renderState.I.

◆ garbage_collect()

int RenderState::garbage_collect ( )
static

Performs a garbage-collection cycle.

This must be called periodically if garbage-collect-states is true to ensure that RenderStates get cleaned up appropriately. It does no harm to call it even if this variable is not true, but there is probably no advantage in that case.

This automatically calls RenderAttrib::garbage_collect() as well.

Definition at line 895 of file renderState.cxx.

References RenderAttrib::garbage_collect().

◆ get_attrib()

template<class AttribType >
bool RenderState::get_attrib ( const AttribType *&  attrib) const
inline

Handy templated version of get_attrib that casts to the right type.

Returns true if the attribute was present, false otherwise.

Definition at line 491 of file renderState.I.

◆ get_attrib_def()

template<class AttribType >
void RenderState::get_attrib_def ( const AttribType *&  attrib) const
inline

Handy templated version of get_attrib_def that casts to the right type.

Definition at line 507 of file renderState.I.

◆ get_geom_rendering()

int RenderState::get_geom_rendering ( int  geom_rendering) const

Returns the union of the Geom::GeomRendering bits that will be required once this RenderState is applied to a geom which includes the indicated geom_rendering bits.

Definition at line 1161 of file renderState.cxx.

References TexMatrixAttrib::get_geom_rendering(), TexGenAttrib::get_geom_rendering(), and RenderModeAttrib::get_geom_rendering().

◆ get_hash()

size_t RenderState::get_hash ( ) const
inline

Returns a suitable hash value for phash_map.

Definition at line 18 of file renderState.I.

◆ get_num_states()

int RenderState::get_num_states ( )
static

Returns the total number of unique RenderState objects allocated in the world.

This will go up and down during normal operations.

Definition at line 718 of file renderState.cxx.

References SimpleHashMap< Key, Value, Compare >::get_num_entries().

◆ get_num_unused_states()

int RenderState::get_num_unused_states ( )
static

Returns the total number of RenderState objects that have been allocated but have no references outside of the internal RenderState cache.

A nonzero return value is not necessarily indicative of leaked references; it is normal for two RenderState objects, both of which have references held outside the cache, to have to result of their composition stored within the cache. This result will be retained within the cache until one of the base RenderStates is released.

Use list_cycles() to get an idea of the number of actual "leaked" RenderState objects.

Definition at line 740 of file renderState.cxx.

References SimpleHashMap< Key, Value, Compare >::get_key(), and SimpleHashMap< Key, Value, Compare >::get_num_entries().

◆ has_cull_callback()

bool RenderState::has_cull_callback ( ) const
inline

Returns true if any of the RenderAttribs in this state request a cull_callback(), false if none of them do.

Definition at line 36 of file renderState.I.

◆ init_states()

void RenderState::init_states ( )
static

Make sure the global _states map is allocated.

This only has to be done once. We could make this map static, but then we run into problems if anyone creates a RenderState object at static init time; it also seems to cause problems when the Panda shared library is unloaded at application exit time.

Definition at line 1851 of file renderState.cxx.

References CacheStats::init().

Referenced by init_libpgraph().

◆ is_empty()

bool RenderState::is_empty ( ) const
inline

Returns true if the state is empty, false otherwise.

Definition at line 27 of file renderState.I.

References BitMask< WType, nbits >::is_zero().

◆ list_cycles()

void RenderState::list_cycles ( std::ostream &  out)
static

Detects all of the reference-count cycles in the cache and reports them to standard output.

These cycles may be inadvertently created when state compositions cycle back to a starting point. Nowadays, these cycles should be automatically detected and broken, so this method should never list any cycles unless there is a bug in that detection logic.

The cycles listed here are not leaks in the strictest sense of the word, since they can be reclaimed by a call to clear_cache(); but they will not be reclaimed automatically.

Definition at line 1006 of file renderState.cxx.

References SimpleHashMap< Key, Value, Compare >::get_key(), SimpleHashMap< Key, Value, Compare >::get_num_entries(), and ReferenceCount::get_ref_count.

◆ list_states()

void RenderState::list_states ( std::ostream &  out)
static

Lists all of the RenderStates in the cache to the output stream, one per line.

This can be quite a lot of output if the cache is large, so be prepared.

Definition at line 1083 of file renderState.cxx.

References SimpleHashMap< Key, Value, Compare >::get_key(), and SimpleHashMap< Key, Value, Compare >::get_num_entries().

◆ register_with_read_factory()

void RenderState::register_with_read_factory ( )
static

Tells the BamReader how to create objects of type RenderState.

Definition at line 1874 of file renderState.cxx.

References BamReader::get_factory(), and Factory< Type >::register_factory().

Referenced by init_libpgraph().

◆ unref()

virtual bool RenderState::unref ( ) const
virtual

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.) 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 true if the new reference count is nonzero, false if it is zero.

Reimplemented from ReferenceCount.

Referenced by finalize().

◆ validate_states()

bool RenderState::validate_states ( )
static

Ensures that the cache is still stored in sorted order, and that none of the cache elements have been inadvertently deleted.

Returns true if so, false if there is a problem (which implies someone has modified one of the supposedly-const RenderState objects).

Definition at line 1105 of file renderState.cxx.

References SimpleHashMap< Key, Value, Compare >::get_num_entries(), SimpleHashMap< Key, Value, Compare >::is_empty(), and SimpleHashMap< Key, Value, Compare >::validate().

◆ write_datagram()

void RenderState::write_datagram ( BamWriter manager,
Datagram dg 
)
virtual

Writes the contents of this object to the datagram for shipping out to a Bam file.

Reimplemented from TypedWritable.

Definition at line 1883 of file renderState.cxx.

References BitMask< WType, nbits >::get_num_on_bits(), and TypedWritable::write_datagram().


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