panda3d.core.TextureStagePool

class TextureStagePool

The TextureStagePool (there is only one in the universe) serves to unify different pointers to the same TextureStage, mainly to help developers use a common pointer to access things that are loaded from different model files.

It runs in one of three different modes, according to setMode(). See that method for more information.

Inheritance diagram

Inheritance diagram of TextureStagePool

enum Mode
enumerator M_none = 0
enumerator M_name = 1
enumerator M_unique = 2
static garbageCollect() → int

Releases only those TextureStages in the pool that have a reference count of exactly 1; i.e. only those TextureStages that are not being used outside of the pool. Returns the number of TextureStages released.

static getMode() → Mode

Returns the fundamental operating mode of the TextureStagePool. See setMode().

Return type

Mode

static getStage(temp: TextureStage) → TextureStage

Returns a TextureStage pointer that represents the same TextureStage described by temp, except that it is a shared pointer.

Each call to getStage() passing an equivalent TextureStage pointer will return the same shared pointer.

If you modify the shared pointer, it will automatically disassociate it from the pool.

Also, the return value may be a different pointer than that passed in, or it may be the same pointer. In either case, the passed in pointer has now been sacrificed to the greater good and should not be used again (like any other PointerTo, it will be freed when the last reference count is removed).

Return type

TextureStage

static listContents(out: ostream) → None

Lists the contents of the TextureStage pool to the indicated output stream.

property mode
Getter

Returns the fundamental operating mode of the TextureStagePool. See setMode().

Setter

Specifies the fundamental operating mode of the TextureStagePool.

If this is M_none, each call to getStage() returns the same TextureStage pointer that was passed in (the pool is effectively disabled). If this is M_name, each call to getStage() returns the last TextureStage passed in with the same name, whether it has different properties or not. If this is M_unique, then each call to getStage() returns only TextureStages with identical properties.

Return type

Mode

static releaseAllStages() → None

Releases all TextureStages in the pool and restores the pool to the empty state.

static releaseStage(temp: TextureStage) → None

Removes the indicated TextureStage from the pool.

static setMode(mode: Mode) → None

Specifies the fundamental operating mode of the TextureStagePool.

If this is M_none, each call to getStage() returns the same TextureStage pointer that was passed in (the pool is effectively disabled). If this is M_name, each call to getStage() returns the last TextureStage passed in with the same name, whether it has different properties or not. If this is M_unique, then each call to getStage() returns only TextureStages with identical properties.

static write(out: ostream) → None

Lists the contents of the TextureStage pool to the indicated output stream.