231 lines
10 KiB
Plaintext
231 lines
10 KiB
Plaintext
// Filename: texturePool.I
|
|
// Created by: drose (26Apr00)
|
|
//
|
|
////////////////////////////////////////////////////////////////////
|
|
//
|
|
// PANDA 3D SOFTWARE
|
|
// Copyright (c) 2001 - 2004, Disney Enterprises, Inc. All rights reserved
|
|
//
|
|
// All use of this software is subject to the terms of the Panda 3d
|
|
// Software license. You should have received a copy of this license
|
|
// along with this source code; you will also find a current copy of
|
|
// the license at http://etc.cmu.edu/panda3d/docs/license/ .
|
|
//
|
|
// To contact the maintainers of this program write to
|
|
// panda3d-general@lists.sourceforge.net .
|
|
//
|
|
////////////////////////////////////////////////////////////////////
|
|
|
|
|
|
////////////////////////////////////////////////////////////////////
|
|
// Function: TexturePool::has_texture
|
|
// Access: Published, Static
|
|
// Description: Returns true if the texture has ever been loaded,
|
|
// false otherwise.
|
|
////////////////////////////////////////////////////////////////////
|
|
INLINE bool TexturePool::
|
|
has_texture(const string &filename) {
|
|
return get_global_ptr()->ns_has_texture(filename);
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////
|
|
// Function: TexturePool::verify_texture
|
|
// Access: Published, Static
|
|
// Description: 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.
|
|
////////////////////////////////////////////////////////////////////
|
|
INLINE bool TexturePool::
|
|
verify_texture(const string &filename) {
|
|
return load_texture(filename) != (Texture *)NULL;
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////
|
|
// Function: TexturePool::load_texture
|
|
// Access: Published, Static
|
|
// Description: 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.
|
|
////////////////////////////////////////////////////////////////////
|
|
INLINE Texture *TexturePool::
|
|
load_texture(const string &filename, int primary_file_num_channels) {
|
|
return get_global_ptr()->ns_load_texture(filename, primary_file_num_channels);
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////
|
|
// Function: TexturePool::load_texture
|
|
// Access: Published, Static
|
|
// Description: 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.
|
|
////////////////////////////////////////////////////////////////////
|
|
INLINE Texture *TexturePool::
|
|
load_texture(const string &filename, const string &alpha_filename,
|
|
int primary_file_num_channels, int alpha_file_channel) {
|
|
return get_global_ptr()->ns_load_texture(filename, alpha_filename,
|
|
primary_file_num_channels,
|
|
alpha_file_channel);
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////
|
|
// Function: TexturePool::load_3d_texture
|
|
// Access: Published, Static
|
|
// Description: 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.
|
|
////////////////////////////////////////////////////////////////////
|
|
INLINE Texture *TexturePool::
|
|
load_3d_texture(const string &filename_pattern) {
|
|
return get_global_ptr()->ns_load_3d_texture(filename_pattern);
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////
|
|
// Function: TexturePool::load_cube_map
|
|
// Access: Published, Static
|
|
// Description: 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.
|
|
////////////////////////////////////////////////////////////////////
|
|
INLINE Texture *TexturePool::
|
|
load_cube_map(const string &filename_pattern) {
|
|
return get_global_ptr()->ns_load_cube_map(filename_pattern);
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////
|
|
// Function: TexturePool::get_normalization_cube_map
|
|
// Access: Published, Static
|
|
// Description: 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.
|
|
////////////////////////////////////////////////////////////////////
|
|
INLINE Texture *TexturePool::
|
|
get_normalization_cube_map(int size) {
|
|
return get_global_ptr()->ns_get_normalization_cube_map(size);
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////
|
|
// Function: TexturePool::add_texture
|
|
// Access: Published, Static
|
|
// Description: 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.
|
|
////////////////////////////////////////////////////////////////////
|
|
INLINE void TexturePool::
|
|
add_texture(Texture *texture) {
|
|
get_global_ptr()->ns_add_texture(texture);
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////
|
|
// Function: TexturePool::release_texture
|
|
// Access: Published, Static
|
|
// Description: 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.
|
|
////////////////////////////////////////////////////////////////////
|
|
INLINE void TexturePool::
|
|
release_texture(Texture *texture) {
|
|
get_global_ptr()->ns_release_texture(texture);
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////
|
|
// Function: TexturePool::release_all_textures
|
|
// Access: Published, Static
|
|
// Description: Releases all textures in the pool and restores the
|
|
// pool to the empty state.
|
|
////////////////////////////////////////////////////////////////////
|
|
INLINE void TexturePool::
|
|
release_all_textures() {
|
|
get_global_ptr()->ns_release_all_textures();
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////
|
|
// Function: TexturePool::garbage_collect
|
|
// Access: Published, Static
|
|
// Description: 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.
|
|
////////////////////////////////////////////////////////////////////
|
|
INLINE int TexturePool::
|
|
garbage_collect() {
|
|
return get_global_ptr()->ns_garbage_collect();
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////
|
|
// Function: TexturePool::list_contents
|
|
// Access: Published, Static
|
|
// Description: Lists the contents of the texture pool to the
|
|
// indicated output stream.
|
|
////////////////////////////////////////////////////////////////////
|
|
INLINE void TexturePool::
|
|
list_contents(ostream &out) {
|
|
get_global_ptr()->ns_list_contents(out);
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////
|
|
// Function: TexturePool::set_fake_texture_image
|
|
// Access: Published, Static
|
|
// Description: Sets a bogus filename that will be loaded in lieu of
|
|
// any textures requested from this point on.
|
|
////////////////////////////////////////////////////////////////////
|
|
INLINE void TexturePool::
|
|
set_fake_texture_image(const string &filename) {
|
|
get_global_ptr()->_fake_texture_image = filename;
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////
|
|
// Function: TexturePool::clear_fake_texture_image
|
|
// Access: Published, Static
|
|
// Description: Restores normal behavior of loading the textures
|
|
// actually requested.
|
|
////////////////////////////////////////////////////////////////////
|
|
INLINE void TexturePool::
|
|
clear_fake_texture_image() {
|
|
set_fake_texture_image(string());
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////
|
|
// Function: TexturePool::has_fake_texture_image
|
|
// Access: Published, Static
|
|
// Description: Returns true if fake_texture_image mode has been
|
|
// enabled, false if we are in the normal mode.
|
|
////////////////////////////////////////////////////////////////////
|
|
INLINE bool TexturePool::
|
|
has_fake_texture_image() {
|
|
return !get_fake_texture_image().empty();
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////
|
|
// Function: TexturePool::get_fake_texture_image
|
|
// Access: Published, Static
|
|
// Description: Returns the filename that was specified with a
|
|
// previous call to set_fake_texture_image().
|
|
////////////////////////////////////////////////////////////////////
|
|
INLINE const string &TexturePool::
|
|
get_fake_texture_image() {
|
|
return get_global_ptr()->_fake_texture_image;
|
|
}
|