# RenderEffects

from pandac.PandaModules import RenderEffects

Class : RenderEffects
Description : This represents a unique collection of RenderEffect objects that correspond to a particular renderable state.
You should not attempt to create or modify a RenderEffects object directly. Instead, call one of the make() functions to create one for you. And instead of modifying a RenderEffects object, create a new one.

## Inheritance:

RenderEffects: TypedWritableReferenceCount
TypedWritableReferenceCount: TypedWritable ReferenceCount
TypedWritable: TypedObject
TypedObject: MemoryBase
MemoryBase:
ReferenceCount: MemoryBase

## Methods of RenderEffects:

addEffect
findEffect
getClassType
getEffect
getNumEffects
getNumStates
isEmpty
listStates
make
makeEmpty
operator <
output
removeEffect
unref
validateStates
write

## Methods of TypedWritableReferenceCount:

getClassType

## Methods of TypedWritable:

getClassType

## Methods of TypedObject:

getClassType
getType
getTypeIndex
isExactType
isOfType

## Methods of ReferenceCount:

getClassType
getRefCount
ref
testRefCountIntegrity
testRefCountNonzero
unref

addEffect ConstPointerTo< RenderEffects > RenderEffects::add_effect(RenderEffect const *effect) const; Description: Returns a new RenderEffects object that represents the same as the source state, with the new RenderEffect added. If there is already a RenderEffect with the same type, it is replaced.

findEffect int RenderEffects::find_effect(TypeHandle type) const; Description: Searches for an effect with the indicated type in the state, and returns its index if it is found, or -1 if it is not.

getClassType static TypeHandle RenderEffects::get_class_type(void); Undocumented function.

getEffect RenderEffect const *RenderEffects::get_effect(int n) const; Description: Returns the nth effect in the state. Description: Looks for a RenderEffect of the indicated type in the state, and returns it if it is found, or NULL if it is not.

getNumEffects int RenderEffects::get_num_effects(void) const; Description: Returns the number of separate effects indicated in the state.

getNumStates static int RenderEffects::get_num_states(void); Description: Returns the total number of unique RenderEffects objects allocated in the world. This will go up and down during normal operations.

isEmpty bool RenderEffects::is_empty(void) const; Description: Returns true if the state is empty, false otherwise.

listStates static void RenderEffects::list_states(ostream &out); Description: Lists all of the RenderEffects 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.

make static ConstPointerTo< RenderEffects > RenderEffects::make(RenderEffect const *effect); Description: Returns a RenderEffects with one effect set. Description: Returns a RenderEffects with two effects set. Description: Returns a RenderEffects with three effects set. Description: Returns a RenderEffects with four effects set.

makeEmpty static ConstPointerTo< RenderEffects > RenderEffects::make_empty(void); Description: Returns a RenderEffects with no effects set.

operator < bool RenderEffects::operator <(RenderEffects const &other) const; Description: Provides an arbitrary ordering among all unique RenderEffects, 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 RenderEffects class because all equivalent RenderEffects objects are guaranteed to share the same pointer; thus, a pointer comparison is always sufficient.

output void RenderEffects::output(ostream &out) const; Description:

removeEffect ConstPointerTo< RenderEffects > RenderEffects::remove_effect(TypeHandle type) const; Description: Returns a new RenderEffects object that represents the same as the source state, with the indicated RenderEffect removed.

unref bool RenderEffects::unref(void) const; Description: This method overrides ReferenceCount::unref() to check whether the remaining reference count is entirely in the cache, and if so, it checks for and breaks a cycle in the cache involving this object. This is designed to prevent leaks from cyclical references within the cache. Note that this is not a virtual method, and cannot be because ReferenceCount itself declares no virtual methods (it avoids the overhead of a virtual function pointer). But this doesn't matter, because PT(TransformState) is a template class, and will call the appropriate method even though it is non-virtual.

validateStates static bool RenderEffects::validate_states(void); Description: Ensures that the cache is still stored in sorted order. Returns true if so, false if there is a problem (which implies someone has modified one of the supposedly-const RenderEffects objects).

write void RenderEffects::write(ostream &out, int indent_level) const; Description:

getClassType static TypeHandle TypedWritableReferenceCount::get_class_type(void); Undocumented function.

getClassType static TypeHandle TypedWritable::get_class_type(void); Undocumented function.

getClassType static TypeHandle TypedObject::get_class_type(void); Undocumented function.

getType virtual TypeHandle TypedObject::get_type(void) const = 0; Derived classes should override this function to return get_class_type().

getTypeIndex int TypedObject::get_type_index(void) const; Description: 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().

isExactType bool TypedObject::is_exact_type(TypeHandle handle) const; Description: Returns true if the current object is the indicated type exactly.

isOfType bool TypedObject::is_of_type(TypeHandle handle) const; Description: Returns true if the current object is or derives from the indicated type.

getClassType static TypeHandle ReferenceCount::get_class_type(void); Undocumented function.

getRefCount int ReferenceCount::get_ref_count(void) const; Description: Returns the current reference count.

ref void ReferenceCount::ref(void) const; Description: 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.

testRefCountIntegrity bool ReferenceCount::test_ref_count_integrity(void) const; Description: Does some easy checks to make sure that the reference count isn't completely bogus. Returns true if ok, false otherwise.

testRefCountNonzero bool ReferenceCount::test_ref_count_nonzero(void) const; Description: Does some easy checks to make sure that the reference count isn't zero, or completely bogus. Returns true if ok, false otherwise.

unref bool ReferenceCount::unref(void) const; Description: 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 true if the new reference count is nonzero, false if it is zero.