Panda3D
Static Public Member Functions | List of all members
TexturePool Class Reference

This is the preferred interface for loading textures from image files. More...

Static Public Member Functions

static addTexture (Texture texture)
 Adds the indicated already-loaded texture to the pool. More...
 
static clearFakeTextureImage ()
 Restores normal behavior of loading the textures actually requested. More...
 
static TextureCollection findAllTextures (str name)
 Returns the set of all textures found in the pool that match the indicated name (which may contain wildcards). More...
 
static Texture findTexture (str name)
 Returns the first texture found in the pool that matches the indicated name (which may contain wildcards). More...
 
static int garbageCollect ()
 Releases only those textures in the pool that have a reference count of exactly 1; i.e. More...
 
static Texture getAlphaScaleMap ()
 Returns a standard Texture object that has been created with Texture::generate_alpha_scale_map(). More...
 
static const Filename getFakeTextureImage ()
 Returns the filename that was specified with a previous call to set_fake_texture_image(). More...
 
static Texture getNormalizationCubeMap (int size)
 Returns a standard Texture object that has been created with Texture::generate_normalization_cube_map(). More...
 
static bool hasFakeTextureImage ()
 Returns true if fake_texture_image mode has been enabled, false if we are in the normal mode. More...
 
static bool hasTexture (const Filename filename)
 Returns true if the texture has ever been loaded, false otherwise. More...
 
static listContents ()
 Lists the contents of the texture pool to cout. More...
 
static listContents (Ostream out)
 Lists the contents of the texture pool to the indicated output stream. More...
 
static Texture load2dTextureArray (const Filename filename_pattern, bool read_mipmaps, const LoaderOptions options)
 Loads a 2-D texture array that is specified with a series of n pages, all numbered in sequence, and beginning with index 0. More...
 
static Texture load3dTexture (const Filename filename_pattern, bool read_mipmaps, const LoaderOptions options)
 Loads a 3-D texture that is specified with a series of n pages, all numbered in sequence, and beginning with index 0. More...
 
static Texture loadCubeMap (const Filename filename_pattern, bool read_mipmaps, const LoaderOptions options)
 Loads a cube map texture that is specified with a series of 6 pages, numbered 0 through 5. More...
 
static Texture loadTexture (const Filename filename, const Filename alpha_filename, int primary_file_num_channels, int alpha_file_channel, bool read_mipmaps, const LoaderOptions options)
 Loads the given filename up into a texture, if it has not already been loaded, and returns the new texture. More...
 
static Texture loadTexture (const Filename filename, int primary_file_num_channels, bool read_mipmaps, const LoaderOptions options)
 Loads the given filename up into a texture, if it has not already been loaded, and returns the new texture. More...
 
static Texture makeTexture (str 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(). More...
 
static rehash ()
 Should be called when the model-path changes, to blow away the cache of texture pathnames found along the model-path. More...
 
static releaseAllTextures ()
 Releases all textures in the pool and restores the pool to the empty state. More...
 
static releaseTexture (Texture texture)
 Removes the indicated texture from the pool, indicating it will never be loaded again; the texture may then be freed. More...
 
static setFakeTextureImage (const Filename filename)
 Sets a bogus filename that will be loaded in lieu of any textures requested from this point on. More...
 
static bool verifyTexture (const Filename 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. More...
 
static write (Ostream out)
 Lists the contents of the texture pool to the indicated output stream. More...
 

Detailed Description

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.

Member Function Documentation

◆ addTexture()

static addTexture ( Texture  texture)
static

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.

◆ clearFakeTextureImage()

static clearFakeTextureImage ( )
static

Restores normal behavior of loading the textures actually requested.

◆ findAllTextures()

static TextureCollection findAllTextures ( str  name)
static

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

◆ findTexture()

static Texture findTexture ( str  name)
static

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.

◆ garbageCollect()

static int garbageCollect ( )
static

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.

◆ getAlphaScaleMap()

static Texture getAlphaScaleMap ( )
static

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.

◆ getFakeTextureImage()

static const Filename getFakeTextureImage ( )
static

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

◆ getNormalizationCubeMap()

static Texture getNormalizationCubeMap ( int  size)
static

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.

◆ hasFakeTextureImage()

static bool hasFakeTextureImage ( )
static

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

◆ hasTexture()

static bool hasTexture ( const Filename  filename)
static

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

◆ listContents() [1/2]

static listContents ( )
static

Lists the contents of the texture pool to cout.

◆ listContents() [2/2]

static listContents ( Ostream  out)
static

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

◆ load2dTextureArray()

static Texture load2dTextureArray ( const Filename  filename_pattern,
bool  read_mipmaps,
const LoaderOptions  options 
)
static

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.

◆ load3dTexture()

static Texture load3dTexture ( const Filename  filename_pattern,
bool  read_mipmaps,
const LoaderOptions  options 
)
static

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.

◆ loadCubeMap()

static Texture loadCubeMap ( const Filename  filename_pattern,
bool  read_mipmaps,
const LoaderOptions  options 
)
static

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.

◆ loadTexture() [1/2]

static Texture loadTexture ( const Filename  filename,
const Filename  alpha_filename,
int  primary_file_num_channels,
int  alpha_file_channel,
bool  read_mipmaps,
const LoaderOptions  options 
)
static

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.

◆ loadTexture() [2/2]

static Texture loadTexture ( const Filename  filename,
int  primary_file_num_channels,
bool  read_mipmaps,
const LoaderOptions  options 
)
static

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.

◆ makeTexture()

static Texture makeTexture ( str  extension)
static

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

◆ rehash()

static rehash ( )
static

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

◆ releaseAllTextures()

static releaseAllTextures ( )
static

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

◆ releaseTexture()

static releaseTexture ( Texture  texture)
static

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.

◆ setFakeTextureImage()

static setFakeTextureImage ( const Filename  filename)
static

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

◆ verifyTexture()

static bool verifyTexture ( const Filename  filename)
static

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.

◆ write()

static write ( Ostream  out)
static

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

For debugging.