Texture pure virtual base class that encapsulates OpenGl texture functionality common to the various types of OSG textures.
typedef buffered_value<unsigned int> osg::Texture::TexParameterDirtyList [protected] |
typedef buffered_object< ref_ptr<TextureObject> > osg::Texture::TextureObjectBuffer [protected] |
typedef std::list< ref_ptr<TextureObject> > osg::Texture::TextureObjectList |
Returned by mipmapBeforeTexImage() to indicate what mipmapAfterTexImage() should do
Texture type determined by the internal texture format
NORMALIZED |
default OpenGL format (clamped values to [0,1) or [0,255]) |
FLOAT |
float values, Shader Model 3.0 (see ARB_texture_float) |
SIGNED_INTEGER |
Signed integer values (see EXT_texture_integer) |
UNSIGNED_INTEGER |
Unsigned integer value (see EXT_texture_integer) |
osg::Texture::Texture | ( | ) |
Copy constructor using CopyOp to manage deep vs shallow copy.
virtual osg::Texture::~Texture | ( | ) | [protected, virtual] |
virtual void osg::Texture::allocateMipmap | ( | State & | state ) | const [protected, pure virtual] |
Allocate mipmap levels of the texture by subsequent calling of glTexImage* function.
Implemented in osg::Texture1D, osg::Texture2D, osg::Texture2DArray, osg::Texture3D, osg::TextureCubeMap, and osg::TextureRectangle.
void osg::Texture::allocateMipmapLevels | ( | ) |
Force a manual allocation of the mipmap levels on the next apply() call. User is responsible for filling the mipmap levels with valid data. The OpenGL's glGenerateMipmapEXT function is used to generate the mipmap levels. If glGenerateMipmapEXT is not supported or texture's internal format is not supported by the glGenerateMipmapEXT, then empty mipmap levels will be allocated manually. The mipmap levels are also allocated if a non-mipmapped min filter is used.
virtual void osg::Texture::apply | ( | State & | state ) | const [pure virtual] |
Texture is a pure virtual base class, apply must be overridden.
Reimplemented from osg::StateAttribute.
Implemented in osg::Texture1D, osg::Texture2D, osg::Texture2DArray, osg::Texture3D, osg::TextureCubeMap, osg::TextureRectangle, and osgText::Font::GlyphTexture.
void osg::Texture::applyTexImage2D_load | ( | State & | state, |
GLenum | target, | ||
const Image * | image, | ||
GLsizei | width, | ||
GLsizei | height, | ||
GLsizei | numMipmapLevels | ||
) | const |
Helper method. Creates the texture, but doesn't set or use a texture binding. Note: Don't call this method directly unless you're implementing a subload callback.
void osg::Texture::applyTexImage2D_subload | ( | State & | state, |
GLenum | target, | ||
const Image * | image, | ||
GLsizei | width, | ||
GLsizei | height, | ||
GLint | inInternalFormat, | ||
GLsizei | numMipmapLevels | ||
) | const |
Helper method. Subloads images into the texture, but doesn't set or use a texture binding. Note: Don't call this method directly unless you're implementing a subload callback.
void osg::Texture::applyTexParameters | ( | GLenum | target, |
State & | state | ||
) | const [protected] |
Helper method. Sets texture parameters.
Reimplemented in osg::TextureRectangle.
bool osg::Texture::areAllTextureObjectsLoaded | ( | ) | const |
Returns true if the texture objects for all the required graphics contexts are loaded.
virtual Texture* osg::Texture::asTexture | ( | ) | [inline, virtual] |
Fast alternative to dynamic_cast<> for determining if state attribute is a Texture.
Reimplemented from osg::StateAttribute.
virtual const Texture* osg::Texture::asTexture | ( | ) | const [inline, virtual] |
Fast alternative to dynamic_cast<> for determining if state attribute is a Texture.
Reimplemented from osg::StateAttribute.
virtual const char* osg::Texture::className | ( | ) | const [inline, virtual] |
Return the name of the attribute's class type.
Reimplemented from osg::StateAttribute.
Reimplemented in osgText::Font::GlyphTexture.
virtual osg::Object* osg::Texture::clone | ( | const CopyOp & | ) | const [pure virtual] |
Clone an attribute, with Object* return type. Must be defined by derived classes.
Implements osg::StateAttribute.
virtual osg::Object* osg::Texture::cloneType | ( | ) | const [pure virtual] |
Clone the type of an attribute, with Object* return type. Must be defined by derived classes.
Implements osg::StateAttribute.
int osg::Texture::compareTexture | ( | const Texture & | rhs ) | const [protected] |
Returns -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs.
int osg::Texture::compareTextureObjects | ( | const Texture & | rhs ) | const [protected] |
Returns -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs.
virtual void osg::Texture::compileGLObjects | ( | State & | state ) | const [virtual] |
Calls apply(state) to compile the texture.
Reimplemented from osg::StateAttribute.
virtual void osg::Texture::computeInternalFormat | ( | ) | const [protected, pure virtual] |
Implemented in osg::Texture1D, osg::Texture2D, osg::Texture2DArray, osg::Texture3D, osg::TextureCubeMap, and osg::TextureRectangle.
void osg::Texture::computeInternalFormatType | ( | ) | const [protected] |
void osg::Texture::computeInternalFormatWithImage | ( | const osg::Image & | image ) | const [protected] |
void osg::Texture::computeRequiredTextureDimensions | ( | State & | state, |
const osg::Image & | image, | ||
GLsizei & | width, | ||
GLsizei & | height, | ||
GLsizei & | numMipmapLevels | ||
) | const [protected] |
void osg::Texture::dirtyTextureObject | ( | ) |
Forces a recompile on next apply() of associated OpenGL texture objects.
void osg::Texture::dirtyTextureParameters | ( | ) |
Force a reset on next apply() of associated OpenGL texture parameters.
static void osg::Texture::discardAllDeletedTextureObjects | ( | unsigned int | contextID ) | [static] |
static void osg::Texture::flushAllDeletedTextureObjects | ( | unsigned int | contextID ) | [static] |
static void osg::Texture::flushDeletedTextureObjects | ( | unsigned int | contextID, |
double | currentTime, | ||
double & | availableTime | ||
) | [static] |
void osg::Texture::generateMipmap | ( | State & | state ) | const [protected] |
Helper method to generate mipmap levels by calling of glGenerateMipmapEXT. If it is not supported, then call the virtual allocateMipmap() method
static TextureObject* osg::Texture::generateTextureObject | ( | unsigned int | contextID, |
GLenum | target | ||
) | [static] |
static TextureObject* osg::Texture::generateTextureObject | ( | unsigned int | contextID, |
GLenum | target, | ||
GLint | numMipmapLevels, | ||
GLenum | internalFormat, | ||
GLsizei | width, | ||
GLsizei | height, | ||
GLsizei | depth, | ||
GLint | border | ||
) | [static] |
const Vec4d& osg::Texture::getBorderColor | ( | ) | const [inline] |
Gets the border color.
GLint osg::Texture::getBorderWidth | ( | ) | const [inline] |
bool osg::Texture::getClientStorageHint | ( | ) | const [inline] |
Gets whether to use client storage for the texture.
static void osg::Texture::getCompressedSize | ( | GLenum | internalFormat, |
GLint | width, | ||
GLint | height, | ||
GLint | depth, | ||
GLint & | blockSize, | ||
GLint & | size | ||
) | [static] |
Determine the size of a compressed image, given the internalFormat, the width, the height, and the depth of the image. The block size and the size are output parameters.
static Extensions* osg::Texture::getExtensions | ( | unsigned int | contextID, |
bool | createIfNotInitalized | ||
) | [static] |
Gets the extension for the specified context. Creates the Extensions object for that context if it doesn't exist. Returns NULL if the Extensions object for the context doesn't exist and the createIfNotInitalized flag is false.
Reimplemented in osg::Texture2DArray, osg::Texture3D, and osg::TextureCubeMap.
FilterMode osg::Texture::getFilter | ( | FilterParameter | which ) | const |
Gets the texture filter mode.
virtual Image* osg::Texture::getImage | ( | unsigned int | face ) | [pure virtual] |
Gets the texture image for the specified face.
Implemented in osg::Texture1D, osg::Texture2D, osg::Texture2DArray, osg::Texture3D, osg::TextureCubeMap, and osg::TextureRectangle.
virtual const Image* osg::Texture::getImage | ( | unsigned int | face ) | const [pure virtual] |
Gets the const texture image for specified face.
Implemented in osg::Texture1D, osg::Texture2D, osg::Texture2DArray, osg::Texture3D, osg::TextureCubeMap, and osg::TextureRectangle.
GLint osg::Texture::getInternalFormat | ( | ) | const [inline] |
Gets the internal texture format.
InternalFormatMode osg::Texture::getInternalFormatMode | ( | ) | const [inline] |
Gets the internal texture format mode.
InternalFormatType osg::Texture::getInternalFormatType | ( | ) | const [inline] |
Get the internal texture format type.
float osg::Texture::getMaxAnisotropy | ( | ) | const [inline] |
Gets the maximum anisotropy value.
static unsigned int osg::Texture::getMinimumNumberOfTextureObjectsToRetainInCache | ( | ) | [static] |
Get the minimum number of display lists to retain in the deleted display list cache.
virtual bool osg::Texture::getModeUsage | ( | StateAttribute::ModeUsage & | ) | const [inline, virtual] |
Return the modes associated with this StateAttribute.
Reimplemented from osg::StateAttribute.
References osg::StateAttribute::ModeUsage::usesTextureMode().
virtual unsigned int osg::Texture::getNumImages | ( | ) | const [pure virtual] |
Gets the number of images that can be assigned to this Texture.
Implemented in osg::Texture1D, osg::Texture2D, osg::Texture2DArray, osg::Texture3D, osg::TextureCubeMap, and osg::TextureRectangle.
GraphicsContext* osg::Texture::getReadPBuffer | ( | ) | [inline] |
Get the PBuffer graphics context to read from when using PBuffers for RenderToTexture.
const GraphicsContext* osg::Texture::getReadPBuffer | ( | ) | const [inline] |
Get the const PBuffer graphics context to read from when using PBuffers for RenderToTexture.
bool osg::Texture::getResizeNonPowerOfTwoHint | ( | ) | const [inline] |
Gets whether texture will force non power to two images to be resized.
float osg::Texture::getShadowAmbient | ( | ) | const [inline] |
ShadowCompareFunc osg::Texture::getShadowCompareFunc | ( | ) | const [inline] |
ShadowTextureMode osg::Texture::getShadowTextureMode | ( | ) | const [inline] |
GLenum osg::Texture::getSourceFormat | ( | ) | const [inline] |
Gets the external source image format.
GLenum osg::Texture::getSourceType | ( | ) | const [inline] |
Gets the external source data type.
virtual int osg::Texture::getTextureDepth | ( | ) | const [inline, virtual] |
Reimplemented in osg::Texture1D, osg::Texture2D, osg::Texture2DArray, osg::Texture3D, osg::TextureCubeMap, and osg::TextureRectangle.
virtual int osg::Texture::getTextureHeight | ( | ) | const [inline, virtual] |
Reimplemented in osg::Texture1D, osg::Texture2D, osg::Texture2DArray, osg::Texture3D, osg::TextureCubeMap, and osg::TextureRectangle.
TextureObject* osg::Texture::getTextureObject | ( | unsigned int | contextID ) | const [inline] |
Returns a pointer to the texture object for the current context.
Referenced by osgDB::DatabasePager::isCompiled().
unsigned int& osg::Texture::getTextureParameterDirty | ( | unsigned int | contextID ) | const [inline] |
Gets the dirty flag for the current contextID.
virtual GLenum osg::Texture::getTextureTarget | ( | ) | const [pure virtual] |
Implemented in osg::Texture1D, osg::Texture2D, osg::Texture2DArray, osg::Texture3D, osg::TextureCubeMap, and osg::TextureRectangle.
virtual int osg::Texture::getTextureWidth | ( | ) | const [inline, virtual] |
Reimplemented in osg::Texture1D, osg::Texture2D, osg::Texture2DArray, osg::Texture3D, osg::TextureCubeMap, and osg::TextureRectangle.
virtual Type osg::Texture::getType | ( | ) | const [inline, virtual] |
Return the Type identifier of the attribute's class type.
Implements osg::StateAttribute.
bool osg::Texture::getUnRefImageDataAfterApply | ( | ) | const [inline] |
Gets whether or not apply() unreferences image data.
bool osg::Texture::getUseHardwareMipMapGeneration | ( | ) | const [inline] |
Gets the hardware mipmap generation hint.
WrapMode osg::Texture::getWrap | ( | WrapParameter | which ) | const |
Gets the texture wrap mode.
static bool osg::Texture::isCompressedInternalFormat | ( | GLint | internalFormat ) | [static] |
Determine whether the given internalFormat is a compressed image format.
bool osg::Texture::isCompressedInternalFormat | ( | ) | const |
Return true if the internal format is one of the compressed formats.
bool osg::Texture::isHardwareMipmapGenerationEnabled | ( | const State & | state ) | const [protected] |
Returns true if _useHardwareMipMapGeneration is true and either glGenerateMipmapEXT() or GL_GENERATE_MIPMAP_SGIS are supported.
virtual bool osg::Texture::isSameKindAs | ( | const osg::Object * | obj ) | const [inline, virtual] |
Return true if this and obj are of the same kind of object.
Reimplemented from osg::StateAttribute.
References NULL.
virtual bool osg::Texture::isTextureAttribute | ( | ) | const [inline, virtual] |
Return true if StateAttribute is a type which controls texturing and needs to be issued w.r.t to specific texture unit.
Reimplemented from osg::StateAttribute.
virtual const char* osg::Texture::libraryName | ( | ) | const [inline, virtual] |
Return the name of the attribute's library.
Reimplemented from osg::StateAttribute.
void osg::Texture::mipmapAfterTexImage | ( | State & | state, |
GenerateMipmapMode | beforeResult | ||
) | const [protected] |
GenerateMipmapMode osg::Texture::mipmapBeforeTexImage | ( | const State & | state, |
bool | hardwareMipmapOn | ||
) | const [protected] |
Helper methods to be called before and after calling gl[Compressed][Copy]Tex[Sub]Image2D to handle generating mipmaps.
virtual void osg::Texture::releaseGLObjects | ( | State * | state = 0 ) |
const [virtual] |
If State is non-zero, this function releases OpenGL objects for the specified graphics context. Otherwise, releases OpenGL objects for all graphics contexts.
Reimplemented from osg::StateAttribute.
virtual void osg::Texture::resizeGLObjectBuffers | ( | unsigned int | maxSize ) | [virtual] |
Resize any per context GLObject buffers to specified size.
Reimplemented from osg::StateAttribute.
Reimplemented in osgText::Font::GlyphTexture.
void osg::Texture::setBorderColor | ( | const Vec4d & | color ) | [inline] |
Sets the border color. Only used when wrap mode is CLAMP_TO_BORDER. The border color will be casted to the appropriate type to match the internal pixel format of the texture.
void osg::Texture::setBorderWidth | ( | GLint | width ) | [inline] |
Sets the border width.
void osg::Texture::setClientStorageHint | ( | bool | flag ) | [inline] |
Sets whether to use client storage for the texture, if supported by the graphics system. Note: If enabled, and the graphics system supports it, the osg::Image(s) associated with this texture cannot be deleted, so the UnRefImageDataAfterApply flag would be ignored.
static void osg::Texture::setExtensions | ( | unsigned int | contextID, |
Extensions * | extensions | ||
) | [static] |
Overrides Extensions objects across graphics contexts. Typically used to ensure the same lowest common denominator of extensions on systems with different graphics pipes.
Reimplemented in osg::Texture2DArray, osg::Texture3D, and osg::TextureCubeMap.
void osg::Texture::setFilter | ( | FilterParameter | which, |
FilterMode | filter | ||
) |
Sets the texture filter mode.
virtual void osg::Texture::setImage | ( | unsigned int | face, |
Image * | image | ||
) | [pure virtual] |
Sets the texture image for the specified face.
Implemented in osg::Texture1D, osg::Texture2D, osg::Texture2DArray, osg::Texture3D, osg::TextureCubeMap, and osg::TextureRectangle.
void osg::Texture::setInternalFormat | ( | GLint | internalFormat ) | [inline] |
Sets the internal texture format. Implicitly sets the internalFormatMode to USE_USER_DEFINED_FORMAT. The corresponding internal format type will be computed.
void osg::Texture::setInternalFormatMode | ( | InternalFormatMode | mode ) | [inline] |
Sets the internal texture format mode. Note: If the texture format is USE_IMAGE_DATA_FORMAT, USE_ARB_COMPRESSION, or USE_S3TC_COMPRESSION, the internal format mode is set automatically and will overwrite the previous _internalFormat.
void osg::Texture::setMaxAnisotropy | ( | float | anis ) |
Sets the maximum anisotropy value, default value is 1.0 for no anisotropic filtering. If hardware does not support anisotropic filtering, use normal filtering (equivalent to a max anisotropy value of 1.0. Valid range is 1.0f upwards. The maximum value depends on the graphics system.
static void osg::Texture::setMinimumNumberOfTextureObjectsToRetainInCache | ( | unsigned int | minimum ) | [static] |
Set the minimum number of texture objects to retain in the deleted display list cache.
void osg::Texture::setReadPBuffer | ( | GraphicsContext * | context ) | [inline] |
Set the PBuffer graphics context to read from when using PBuffers for RenderToTexture.
void osg::Texture::setResizeNonPowerOfTwoHint | ( | bool | flag ) | [inline] |
Sets whether to force the texture to resize images that have dimensions that are not a power of two. If enabled, NPOT images will be resized, whether or not NPOT textures are supported by the hardware. If disabled, NPOT images will not be resized if supported by hardware.
void osg::Texture::setShadowAmbient | ( | float | shadow_ambient ) | [inline] |
Sets the TEXTURE_COMPARE_FAIL_VALUE_ARB texture parameter. See http://oss.sgi.com/projects/ogl-sample/registry/ARB/shadow_ambient.txt.
void osg::Texture::setShadowCompareFunc | ( | ShadowCompareFunc | func ) | [inline] |
Sets shadow texture comparison function.
void osg::Texture::setShadowComparison | ( | bool | flag ) | [inline] |
Sets GL_TEXTURE_COMPARE_MODE_ARB to GL_COMPARE_R_TO_TEXTURE_ARB See http://oss.sgi.com/projects/ogl-sample/registry/ARB/shadow.txt.
void osg::Texture::setShadowTextureMode | ( | ShadowTextureMode | mode ) | [inline] |
Sets shadow texture mode after comparison.
void osg::Texture::setSourceFormat | ( | GLenum | sourceFormat ) | [inline] |
Sets the external source image format, used as a fallback when no osg::Image is attached to provide the source image format.
void osg::Texture::setSourceType | ( | GLenum | sourceType ) | [inline] |
Sets the external source data type, used as a fallback when no osg::Image is attached to provide the source image format.
void osg::Texture::setUnRefImageDataAfterApply | ( | bool | flag ) | [inline] |
void osg::Texture::setUseHardwareMipMapGeneration | ( | bool | useHardwareMipMapGeneration ) | [inline] |
Sets the hardware mipmap generation hint. If enabled, it will only be used if supported in the graphics system.
void osg::Texture::setWrap | ( | WrapParameter | which, |
WrapMode | wrap | ||
) |
Sets the texture wrap mode.
void osg::Texture::takeTextureObjects | ( | TextureObjectListMap & | toblm ) |
Takes the active texture objects from the Texture and places them in the specified TextureObjectListMap.
Vec4d osg::Texture::_borderColor [protected] |
GLint osg::Texture::_borderWidth [protected] |
bool osg::Texture::_clientStorageHint [protected] |
GLint osg::Texture::_internalFormat [mutable, protected] |
InternalFormatMode osg::Texture::_internalFormatMode [protected] |
InternalFormatType osg::Texture::_internalFormatType [mutable, protected] |
FilterMode osg::Texture::_mag_filter [protected] |
float osg::Texture::_maxAnisotropy [protected] |
FilterMode osg::Texture::_min_filter [protected] |
ref_ptr<GraphicsContext> osg::Texture::_readPBuffer [mutable, protected] |
bool osg::Texture::_resizeNonPowerOfTwoHint [protected] |
float osg::Texture::_shadow_ambient [protected] |
ShadowCompareFunc osg::Texture::_shadow_compare_func [protected] |
ShadowTextureMode osg::Texture::_shadow_texture_mode [protected] |
GLenum osg::Texture::_sourceFormat [mutable, protected] |
GLenum osg::Texture::_sourceType [mutable, protected] |
TexParameterDirtyList osg::Texture::_texMipmapGenerationDirtyList [mutable, protected] |
TexParameterDirtyList osg::Texture::_texParametersDirtyList [mutable, protected] |
TextureObjectBuffer osg::Texture::_textureObjectBuffer [mutable, protected] |
bool osg::Texture::_unrefImageDataAfterApply [protected] |
bool osg::Texture::_use_shadow_comparison [protected] |
bool osg::Texture::_useHardwareMipMapGeneration [protected] |
WrapMode osg::Texture::_wrap_r [protected] |
WrapMode osg::Texture::_wrap_s [protected] |
WrapMode osg::Texture::_wrap_t [protected] |
unsigned int osg::Texture::s_numberDeletedTextureInLastFrame [static] |
unsigned int osg::Texture::s_numberNewTextureInLastFrame [static] |
unsigned int osg::Texture::s_numberTextureReusedLastInLastFrame [static] |