|
const RenderState | addAttrib (const RenderAttrib attrib, int override) |
| Returns a new RenderState object that represents the same as the source state, with the new RenderAttrib added. If there is already a RenderAttrib with the same type, it is replaced (unless the override is lower). More...
|
|
const RenderState | adjustAllPriorities (int adjustment) |
| Returns a new RenderState object that represents the same as the source state, with all attributes' override values incremented (or decremented, if negative) by the indicated amount. If the override would drop below zero, it is set to zero. More...
|
|
| cacheRef () |
| Overrides this method to update PStats appropriately. More...
|
|
bool | cacheUnref () |
| Overrides this method to update PStats appropriately. More...
|
|
int | compareMask (const RenderState other, RenderState::SlotMask compare_mask) |
| 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. More...
|
|
int | compareSort (const RenderState other) |
| 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. More...
|
|
int | compareTo (const RenderState other) |
| 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...
|
|
const RenderState | compose (const RenderState other) |
| Returns a new RenderState object that represents the composition of this state with the other state. More...
|
|
bool | cullCallback (CullTraverser trav, const CullTraverserData data) |
| 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. More...
|
|
const RenderAttrib | getAttrib (TypeHandle type) |
| Looks for a RenderAttrib of the indicated type in the state, and returns it if it is found, or NULL if it is not. More...
|
|
const RenderAttrib | getAttrib (int slot) |
| Returns the RenderAttrib with the indicated slot index, or NULL if there is no such RenderAttrib in the state. More...
|
|
const RenderAttrib | getAttribDef (int slot) |
| Returns the RenderAttrib with the indicated slot index, or the default attrib for that slot if there is no such RenderAttrib in the state. More...
|
|
const RenderState | getAutoShaderState () |
| Returns the base RenderState that should have the generated_shader stored within it, for generated shader states. The returned object might be the same as this object, or it might be a different RenderState with certain attributes removed, or set to their default values. More...
|
|
int | getBinIndex () |
| Returns the bin index indicated by the CullBinAttrib, if any, associated by this state (or the default bin index if there is no CullBinAttrib). This function is provided as an optimization for determining this at render time. More...
|
|
object | getCompositionCache () |
|
int | getCompositionCacheNumEntries () |
| Returns the number of entries in the composition cache for this RenderState. This is the number of other RenderStates whose composition with this one has been cached. This number is not useful for any practical reason other than performance analysis. More...
|
|
const RenderState | getCompositionCacheResult (int n) |
| Returns the result RenderState of the nth element in the composition cache. Returns NULL if there doesn't happen to be an entry in the nth element. More...
|
|
int | getCompositionCacheSize () |
| Returns the number of slots in the composition cache for this RenderState. You may use this as an upper bound when walking through all of the composition cache results via get_composition_cache_source() or result(). More...
|
|
const RenderState | getCompositionCacheSource (int n) |
| Returns the source RenderState of the nth element in the composition cache. Returns NULL if there doesn't happen to be an entry in the nth element. See get_composition_cache_result(). More...
|
|
int | getDrawOrder () |
| Returns the draw order indicated by the CullBinAttrib, if any, associated by this state (or 0 if there is no CullBinAttrib). See get_bin_index(). More...
|
|
int | getGeomRendering (int geom_rendering) |
| 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 | getHash () |
| Returns a suitable hash value for phash_map. More...
|
|
object | getInvertCompositionCache () |
|
int | getInvertCompositionCacheNumEntries () |
| Returns the number of entries in the invert_composition cache for this RenderState. This is similar to the composition cache, but it records cache entries for the invert_compose() operation. See get_composition_cache_num_entries(). More...
|
|
const RenderState | getInvertCompositionCacheResult (int n) |
| Returns the result RenderState of the nth element in the invert composition cache. Returns NULL if there doesn't happen to be an entry in the nth element. More...
|
|
int | getInvertCompositionCacheSize () |
| Returns the number of slots in the composition cache for this RenderState. You may use this as an upper bound when walking through all of the composition cache results via get_invert_composition_cache_source() or result(). More...
|
|
const RenderState | getInvertCompositionCacheSource (int n) |
| Returns the source RenderState of the nth element in the invert composition cache. Returns NULL if there doesn't happen to be an entry in the nth element. See get_invert_composition_cache_result(). More...
|
|
int | getOverride (TypeHandle type) |
| Looks for a RenderAttrib of the indicated type in the state, and returns its override value if it is found, or 0 if it is not. More...
|
|
int | getOverride (int slot) |
| Looks for a RenderAttrib of the indicated type in the state, and returns its override value if it is found, or 0 if it is not. More...
|
|
const RenderState | getUnique () |
| Returns the pointer to the unique RenderState in the cache that is equivalent to this one. This may be the same pointer as this object, or it may be a different pointer; but it will be an equivalent object, and it will be a shared pointer. This may be called from time to time to improve cache benefits. More...
|
|
bool | hasAttrib (TypeHandle type) |
| Returns true if an attrib of the indicated type is present, false otherwise. More...
|
|
bool | hasAttrib (int slot) |
| Returns true if an attrib of the indicated type is present, false otherwise. More...
|
|
bool | hasCullCallback () |
| Returns true if any of the RenderAttribs in this state request a cull_callback(), false if none of them do. More...
|
|
const RenderState | invertCompose (const RenderState other) |
| Returns a new RenderState object that represents the composition of this state's inverse with the other state. More...
|
|
bool | isEmpty () |
| Returns true if the state is empty, false otherwise. More...
|
|
| nodeRef () |
| Overrides this method to update PStats appropriately. More...
|
|
bool | nodeUnref () |
| Overrides this method to update PStats appropriately. More...
|
|
| output (Ostream out) |
|
const RenderState | removeAttrib (TypeHandle type) |
| Returns a new RenderState object that represents the same as the source state, with the indicated RenderAttrib removed. More...
|
|
const RenderState | removeAttrib (int slot) |
| Returns a new RenderState object that represents the same as the source state, with the indicated RenderAttrib removed. More...
|
|
const RenderState | setAttrib (const RenderAttrib attrib) |
| Returns a new RenderState object that represents the same as the source state, with the new RenderAttrib added. If there is already a RenderAttrib with the same type, it is replaced unconditionally. The override is not changed. More...
|
|
const RenderState | setAttrib (const RenderAttrib attrib, int override) |
| Returns a new RenderState object that represents the same as the source state, with the new RenderAttrib added. If there is already a RenderAttrib with the same type, it is replaced unconditionally. The override is also replaced unconditionally. More...
|
|
| write (Ostream out, int indent_level) |
|
Public Member Functions inherited from NodeCachedReferenceCount |
int | getNodeRefCount () |
| Returns the current reference count. More...
|
|
int | getReferencedBits () |
| 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...
|
|
| nodeRef () |
| Explicitly increments the reference count. More...
|
|
bool | nodeUnref () |
| Explicitly decrements the node reference count and the normal reference count simultaneously. More...
|
|
bool | testRefCountIntegrity () |
| Does some easy checks to make sure that the reference count isn't completely bogus. More...
|
|
Public Member Functions inherited from CachedTypedWritableReferenceCount |
| cacheRef () |
| Explicitly increments the cache reference count and the normal reference count simultaneously. More...
|
|
bool | cacheUnref () |
| Explicitly decrements the cache reference count and the normal reference count simultaneously. More...
|
|
int | getCacheRefCount () |
| Returns the current reference count. More...
|
|
bool | testRefCountIntegrity () |
| Does some easy checks to make sure that the reference count isn't completely bogus. More...
|
|
Public Member Functions inherited from TypedWritable |
object | __reduce__ () |
|
object | __reduce_persist__ (object pickler) |
|
str | encodeToBamStream () |
| Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a string string. Returns empty string on failure. More...
|
|
bool | encodeToBamStream (String data, BamWriter writer) |
| Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string. Returns true on success, false on failure. More...
|
|
UpdateSeq | getBamModified () |
| Returns the current bam_modified counter. This counter is normally incremented automatically whenever the object is modified. More...
|
|
| markBamModified () |
| Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams. This should normally not need to be called by user code; it should be called internally when the object has been changed in a way that legitimately requires its retransmission to any connected clients. More...
|
|
Public Member Functions inherited from TypedObject |
TypeHandle | getType () |
| Derived classes should override this function to return get_class_type(). More...
|
|
int | getTypeIndex () |
| 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(). More...
|
|
bool | isExactType (TypeHandle handle) |
| Returns true if the current object is the indicated type exactly. More...
|
|
bool | isOfType (TypeHandle handle) |
| Returns true if the current object is or derives from the indicated type. More...
|
|
Public Member Functions inherited from ReferenceCount |
int | getRefCount () |
| Returns the current reference count. More...
|
|
| ref () |
| 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. More...
|
|
bool | testRefCountIntegrity () |
| Does some easy checks to make sure that the reference count isn't completely bogus. Returns true if ok, false otherwise. More...
|
|
bool | testRefCountNonzero () |
| Does some easy checks to make sure that the reference count isn't zero, or completely bogus. Returns true if ok, false otherwise. More...
|
|
bool | unref () |
| 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(). More...
|
|
|
static int | clearCache () |
| Empties the cache of composed RenderStates. This makes every RenderState forget what results when it is composed with other RenderStates. More...
|
|
static | clearMungerCache () |
| Completely empties the cache of state + gsg -> munger, for all states and all gsg's. Normally there is no need to empty this cache. More...
|
|
static int | garbageCollect () |
| 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. More...
|
|
static TypeHandle | getClassType () |
|
static int | getMaxPriority () |
| Returns the maximum priority number (sometimes called override) that may be set on any node. This may or may not be enforced, but the scene graph code assumes that no priority numbers will be larger than this, and some effects may not work properly if you use a larger number. More...
|
|
static int | getNumStates () |
| Returns the total number of unique RenderState objects allocated in the world. This will go up and down during normal operations. More...
|
|
static int | getNumUnusedStates () |
| Returns the total number of RenderState objects that have been allocated but have no references outside of the internal RenderState cache. More...
|
|
static object | getStates () |
|
static | listCycles (Ostream out) |
| Detects all of the reference-count cycles in the cache and reports them to standard output. More...
|
|
static | listStates (Ostream out) |
| 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. More...
|
|
static const RenderState | make (const RenderAttrib attrib1, const RenderAttrib attrib2, const RenderAttrib attrib3, const RenderAttrib attrib4, const RenderAttrib attrib5, int override) |
| Returns a RenderState with five attributes set. More...
|
|
static const RenderState | make (const RenderAttrib attrib1, const RenderAttrib attrib2, const RenderAttrib attrib3, const RenderAttrib attrib4, int override) |
| Returns a RenderState with four attributes set. More...
|
|
static const RenderState | make (const RenderAttrib attrib1, const RenderAttrib attrib2, const RenderAttrib attrib3, int override) |
| Returns a RenderState with three attributes set. More...
|
|
static const RenderState | make (const RenderAttrib attrib1, const RenderAttrib attrib2, int override) |
| Returns a RenderState with two attributes set. More...
|
|
static const RenderState | make (const RenderAttrib attrib, int override) |
| Returns a RenderState with one attribute set. More...
|
|
static const RenderState | makeEmpty () |
| Returns a RenderState with no attributes set. More...
|
|
static const RenderState | makeFullDefault () |
| Returns a RenderState with all possible attributes set to their default value. More...
|
|
static bool | validateStates () |
| 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). More...
|
|
Static Public Member Functions inherited from NodeCachedReferenceCount |
static TypeHandle | getClassType () |
|
Static Public Member Functions inherited from CachedTypedWritableReferenceCount |
static TypeHandle | getClassType () |
|
Static Public Member Functions inherited from TypedWritableReferenceCount |
static TypedWritableReferenceCount | decodeFromBamStream (str data, BamReader reader) |
| Reads the string created by a previous call to encode_to_bam_stream(), and extracts and returns the single object on that string. Returns NULL on error. More...
|
|
static TypeHandle | getClassType () |
|
Static Public Member Functions inherited from TypedWritable |
static TypeHandle | getClassType () |
|
Static Public Member Functions inherited from TypedObject |
static TypeHandle | getClassType () |
|
Static Public Member Functions inherited from ReferenceCount |
static TypeHandle | getClassType () |
|
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.