TexturePool

class TexturePool

This is the preferred interface for loading textures from image files. It unifies all references to the same filename, so that multiple models that reference the same textures don’t waste texture memory unnecessarily.

Inheritance diagram

void add_texture(Texture *texture)

Adds the indicated already-loaded texture to the pool. The texture must have a filename set for its name. The texture will always replace any previously-loaded texture in the pool that had the same filename.

void clear_fake_texture_image(void)

Restores normal behavior of loading the textures actually requested.

TextureCollection find_all_textures(std::string const &name = "*")

Returns the set of all textures found in the pool that match the indicated name (which may contain wildcards).

Texture *find_texture(std::string const &name)

Returns the first texture found in the pool that matches the indicated name (which may contain wildcards). Returns the texture if it is found, or NULL if it is not.

int garbage_collect(void)

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

Texture *get_alpha_scale_map(void)

Returns a standard Texture object that has been created with Texture::generate_alpha_scale_map().

This Texture object is used internally by Panda to apply an alpha scale to an object (instead of munging its vertices) when gsg->get_alpha_scale_via_texture() returns true.

Filename const &get_fake_texture_image(void)

Returns the filename that was specified with a previous call to set_fake_texture_image().

Texture *get_normalization_cube_map(int size)

Returns a standard Texture object that has been created with Texture::generate_normalization_cube_map(). This Texture may be shared by any application code requiring a normalization cube map. It will be at least as large as the specified size, though it may be larger.

Texture *get_texture(Filename const &filename, int primary_file_num_channels = 0, bool read_mipmaps = false)

Texture *get_texture(Filename const &filename, Filename const &alpha_filename, int primary_file_num_channels = 0, int alpha_file_channel = 0, bool read_mipmaps = false)

Returns the texture that has already been previously loaded, or NULL otherwise.

bool has_fake_texture_image(void)

Returns true if fake_texture_image mode has been enabled, false if we are in the normal mode.

bool has_texture(Filename const &filename)

Returns true if the texture has ever been loaded, false otherwise.

void list_contents(std::ostream &out)

void list_contents(void)

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

Lists the contents of the texture pool to cout

Texture *load_2d_texture_array(Filename const &filename_pattern, bool read_mipmaps = false, LoaderOptions const &options = LoaderOptions())

Loads a 2-D texture array that is specified with a series of n pages, all numbered in sequence, and beginning with index 0. The filename should include a sequence of one or more hash characters (“#”) which will be filled in with the index number of each level.

If read_mipmaps is true, the filename should contain an additional hash mark. The first hash mark will be filled in with the mipmap level number, and the second with the index number of each 2-d level.

Texture *load_3d_texture(Filename const &filename_pattern, bool read_mipmaps = false, LoaderOptions const &options = LoaderOptions())

Loads a 3-D texture that is specified with a series of n pages, all numbered in sequence, and beginning with index 0. The filename should include a sequence of one or more hash characters (“#”) which will be filled in with the index number of each level.

If read_mipmaps is true, the filename should contain an additional hash mark. The first hash mark will be filled in with the mipmap level number, and the second with the index number of each 3-d level.

Texture *load_cube_map(Filename const &filename_pattern, bool read_mipmaps = false, LoaderOptions const &options = LoaderOptions())

Loads a cube map texture that is specified with a series of 6 pages, numbered 0 through 5. The filename should include a sequence of one or more hash characters (“#”) which will be filled in with the index number of each pagee.

If read_mipmaps is true, the filename should contain an additional hash mark. The first hash mark will be filled in with the mipmap level number, and the second with the face number, 0 through 5.

Texture *load_texture(Filename const &filename, int primary_file_num_channels = 0, bool read_mipmaps = false, LoaderOptions const &options = LoaderOptions())

Texture *load_texture(Filename const &filename, Filename const &alpha_filename, int primary_file_num_channels = 0, int alpha_file_channel = 0, bool read_mipmaps = false, LoaderOptions const &options = LoaderOptions())

Loads the given filename up into a texture, if it has not already been loaded, and returns the new texture. If a texture with the same filename was previously loaded, returns that one instead. If the texture file cannot be found, returns NULL.

If read_mipmaps is true, the filename should contain a hash mark (‘#’), which will be filled in with the mipmap level number; and the texture will be defined with a series of images, one for each mipmap level.

Loads the given filename up into a texture, if it has not already been loaded, and returns the new texture. If a texture with the same filename was previously loaded, returns that one instead. If the texture file cannot be found, returns NULL.

If read_mipmaps is true, both filenames should contain a hash mark (‘#’), which will be filled in with the mipmap level number; and the texture will be defined with a series of images, two for each mipmap level.

PointerTo<Texture> make_texture(std::string const &extension)

Creates a new Texture object of the appropriate type for the indicated filename extension, according to the types that have been registered via register_texture_type().

void rehash(void)

Should be called when the model-path changes, to blow away the cache of texture pathnames found along the model-path.

void release_all_textures(void)

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

void release_texture(Texture *texture)

Removes the indicated texture from the pool, indicating it will never be loaded again; the texture may then be freed. If this function is never called, a reference count will be maintained on every texture every loaded, and textures will never be freed.

The texture’s name should not have been changed during its lifetime, or this function may fail to locate it in the pool.

void set_fake_texture_image(Filename const &filename)

Sets a bogus filename that will be loaded in lieu of any textures requested from this point on.

bool verify_texture(Filename const &filename)

Loads the given filename up into a texture, if it has not already been loaded, and returns true to indicate success, or false to indicate failure. If this returns true, it is guaranteed that a subsequent call to load_texture() with the same texture name will return a valid Texture pointer.

static void write(std::ostream &out)

Lists the contents of the texture pool to the indicated output stream. For debugging.