panda3d.core.RenderState

class RenderState

Bases: NodeCachedReferenceCount

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.

Inheritance diagram

Inheritance diagram of RenderState

compareTo(other: RenderState) → int

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.

compareSort(other: RenderState) → int

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.getSlotSort()) are more likely to be grouped together. This is not related to the sorting order defined by compare_to.

compareMask(other: RenderState, compare_mask: SlotMask) → int

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.

getHash() → size_t

Returns a suitable hash value for phash_map.

Return type

size_t

isEmpty() → bool

Returns true if the state is empty, false otherwise.

hasCullCallback() → bool

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

cullCallback(trav: CullTraverser, data: CullTraverserData) → bool

Calls cullCallback() on each attrib. If any attrib returns false, interrupts the list and returns false immediately; otherwise, completes the list and returns true.

static makeEmpty() → RenderState

Returns a RenderState with no attributes set.

Return type

RenderState

static make(attrib1: RenderAttrib, attrib2: RenderAttrib, attrib3: RenderAttrib, attrib4: RenderAttrib, attrib5: RenderAttrib, override: int) → RenderState

Returns a RenderState with five attributes set.

Return type

RenderState

static make(attrib1: RenderAttrib, attrib2: RenderAttrib, attrib3: RenderAttrib, attrib4: RenderAttrib, override: int) → RenderState

Returns a RenderState with four attributes set.

Return type

RenderState

static make(attrib1: RenderAttrib, attrib2: RenderAttrib, attrib3: RenderAttrib, override: int) → RenderState

Returns a RenderState with three attributes set.

Return type

RenderState

static make(attrib1: RenderAttrib, attrib2: RenderAttrib, override: int) → RenderState

Returns a RenderState with two attributes set.

Return type

RenderState

static make(attrib: RenderAttrib, override: int) → RenderState

Returns a RenderState with one attribute set.

Return type

RenderState

compose(other: RenderState) → RenderState

Returns a new RenderState object that represents the composition of this state with the other state.

The result of this operation is cached, and will be retained as long as both this RenderState object and the other RenderState object continue to exist. Should one of them destruct, the cached entry will be removed, and its pointer will be allowed to destruct as well.

Return type

RenderState

invertCompose(other: RenderState) → RenderState

Returns a new RenderState object that represents the composition of this state’s inverse with the other state.

This is similar to compose(), but is particularly useful for computing the relative state of a node as viewed from some other node.

Return type

RenderState

addAttrib(attrib: RenderAttrib, override: int) → RenderState

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

Return type

RenderState

setAttrib(attrib: RenderAttrib) → RenderState

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.

Return type

RenderState

setAttrib(attrib: RenderAttrib, override: int) → RenderState

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.

Return type

RenderState

removeAttrib(type: TypeHandle) → RenderState

Returns a new RenderState object that represents the same as the source state, with the indicated RenderAttrib removed.

Return type

RenderState

removeAttrib(slot: int) → RenderState

Returns a new RenderState object that represents the same as the source state, with the indicated RenderAttrib removed.

Return type

RenderState

adjustAllPriorities(adjustment: int) → RenderState

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.

Return type

RenderState

hasAttrib(type: TypeHandle) → bool

Returns true if an attrib of the indicated type is present, false otherwise.

hasAttrib(slot: int) → bool

Returns true if an attrib of the indicated type is present, false otherwise.

getAttrib(type: TypeHandle) → RenderAttrib

Looks for a RenderAttrib of the indicated type in the state, and returns it if it is found, or NULL if it is not.

Return type

RenderAttrib

getAttrib(slot: int) → RenderAttrib

Returns the RenderAttrib with the indicated slot index, or NULL if there is no such RenderAttrib in the state.

Return type

RenderAttrib

getAttribDef(slot: int) → RenderAttrib

Returns the RenderAttrib with the indicated slot index, or the default attrib for that slot if there is no such RenderAttrib in the state.

Return type

RenderAttrib

getOverride(type: TypeHandle) → int

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.

getOverride(slot: int) → int

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.

getUnique() → RenderState

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.

Return type

RenderState

cacheRef() → None

Overrides this method to update PStats appropriately.

cacheUnref() → bool

Overrides this method to update PStats appropriately.

nodeRef() → None

Overrides this method to update PStats appropriately.

nodeUnref() → bool

Overrides this method to update PStats appropriately.

getCompositionCacheNumEntries() → size_t

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.

Return type

size_t

getInvertCompositionCacheNumEntries() → size_t

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 invertCompose() operation. See getCompositionCacheNumEntries().

Return type

size_t

getCompositionCacheSize() → size_t

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 getCompositionCacheSource() or result().

This has no practical value other than for examining the cache for performance analysis.

Return type

size_t

getCompositionCacheSource(n: size_t) → RenderState

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

This has no practical value other than for examining the cache for performance analysis.

Return type

RenderState

getCompositionCacheResult(n: size_t) → RenderState

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.

In general, a->compose(a->get_composition_cache_source(n)) == a->get_composition_cache_result(n).

This has no practical value other than for examining the cache for performance analysis.

Return type

RenderState

getInvertCompositionCacheSize() → size_t

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 getInvertCompositionCacheSource() or result().

This has no practical value other than for examining the cache for performance analysis.

Return type

size_t

getInvertCompositionCacheSource(n: size_t) → RenderState

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

This has no practical value other than for examining the cache for performance analysis.

Return type

RenderState

getInvertCompositionCacheResult(n: size_t) → RenderState

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.

In general, a->invert_compose(a->get_invert_composition_cache_source(n)) == a->get_invert_composition_cache_result(n).

This has no practical value other than for examining the cache for performance analysis.

Return type

RenderState

getCompositionCache() → object
getInvertCompositionCache() → object
output(out: ostream) → None
write(out: ostream, indent_level: int) → None
static getMaxPriority() → int

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.

static getNumStates() → int

Returns the total number of unique RenderState objects allocated in the world. This will go up and down during normal operations.

static getNumUnusedStates() → int

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 listCycles() to get an idea of the number of actual “leaked” RenderState objects.

static clearCache() → int

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.

static clearMungerCache() → None

Completely empties the cache of state + gsg -> munger, for all states and all gsg’s. Normally there is no need to empty this cache.

static garbageCollect() → int

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.garbageCollect() as well.

static listCycles(out: ostream) → None

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 clearCache(); but they will not be reclaimed automatically.

static listStates(out: ostream) → None

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.

static validateStates() → bool

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

static getStates() → object
getDrawOrder() → int

Returns the draw order indicated by the CullBinAttrib, if any, associated by this state (or 0 if there is no CullBinAttrib). See getBinIndex().

getBinIndex() → int

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.

getGeomRendering(geom_rendering: int) → int

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.

static getClassType() → TypeHandle
Return type

TypeHandle

property attribs

Looks for a RenderAttrib of the indicated type in the state, and returns it if it is found, or NULL if it is not.

Returns the RenderAttrib with the indicated slot index, or NULL if there is no such RenderAttrib in the state.

Return type

Mapping[RenderAttrib]