OpenSceneGraph 3.6.5
osg::Texture Class Referenceabstract

Texture pure virtual base class that encapsulates OpenGL texture functionality common to the various types of OSG textures. More...

#include <Texture>

Inheritance diagram for osg::Texture:

Classes

class  TextureObject
struct  TextureProfile

Public Types

enum  WrapParameter { WRAP_S , WRAP_T , WRAP_R }
enum  WrapMode {
  CLAMP = GL_CLAMP , CLAMP_TO_EDGE = GL_CLAMP_TO_EDGE , CLAMP_TO_BORDER = GL_CLAMP_TO_BORDER_ARB , REPEAT = GL_REPEAT ,
  MIRROR = GL_MIRRORED_REPEAT_IBM
}
enum  FilterParameter { MIN_FILTER , MAG_FILTER }
enum  FilterMode {
  LINEAR = GL_LINEAR , LINEAR_MIPMAP_LINEAR = GL_LINEAR_MIPMAP_LINEAR , LINEAR_MIPMAP_NEAREST = GL_LINEAR_MIPMAP_NEAREST , NEAREST = GL_NEAREST ,
  NEAREST_MIPMAP_LINEAR = GL_NEAREST_MIPMAP_LINEAR , NEAREST_MIPMAP_NEAREST = GL_NEAREST_MIPMAP_NEAREST
}
enum  InternalFormatMode {
  USE_IMAGE_DATA_FORMAT , USE_USER_DEFINED_FORMAT , USE_ARB_COMPRESSION , USE_S3TC_DXT1_COMPRESSION ,
  USE_S3TC_DXT3_COMPRESSION , USE_S3TC_DXT5_COMPRESSION , USE_PVRTC_2BPP_COMPRESSION , USE_PVRTC_4BPP_COMPRESSION ,
  USE_ETC_COMPRESSION , USE_ETC2_COMPRESSION , USE_RGTC1_COMPRESSION , USE_RGTC2_COMPRESSION ,
  USE_S3TC_DXT1c_COMPRESSION , USE_S3TC_DXT1a_COMPRESSION
}
enum  InternalFormatType { NORMALIZED = 0x0 , FLOAT = 0x1 , SIGNED_INTEGER = 0x2 , UNSIGNED_INTEGER = 0x4 }
 Texture type determined by the internal texture format. More...
enum  ShadowCompareFunc {
  NEVER = GL_NEVER , LESS = GL_LESS , EQUAL = GL_EQUAL , LEQUAL = GL_LEQUAL ,
  GREATER = GL_GREATER , NOTEQUAL = GL_NOTEQUAL , GEQUAL = GL_GEQUAL , ALWAYS = GL_ALWAYS
}
enum  ShadowTextureMode { LUMINANCE = GL_LUMINANCE , INTENSITY = GL_INTENSITY , ALPHA = GL_ALPHA , NONE = GL_NONE }
enum  GenerateMipmapMode { GENERATE_MIPMAP_NONE , GENERATE_MIPMAP , GENERATE_MIPMAP_TEX_PARAMETER }
 Returned by mipmapBeforeTexImage() to indicate what mipmapAfterTexImage() should do. More...
typedef std::list< ref_ptr< TextureObject > > TextureObjectList
Public Types inherited from osg::StateAttribute
enum  Values {
  OFF = 0x0 , ON = 0x1 , OVERRIDE = 0x2 , PROTECTED = 0x4 ,
  INHERIT = 0x8
}
 list values which can be used to set either GLModeValues or OverrideValues. More...
enum  Type {
  TEXTURE , POLYGONMODE , POLYGONOFFSET , MATERIAL ,
  ALPHAFUNC , ANTIALIAS , COLORTABLE , CULLFACE ,
  FOG , FRONTFACE , LIGHT , POINT ,
  LINEWIDTH , LINESTIPPLE , POLYGONSTIPPLE , SHADEMODEL ,
  TEXENV , TEXENVFILTER , TEXGEN , TEXMAT ,
  LIGHTMODEL , BLENDFUNC , BLENDEQUATION , LOGICOP ,
  STENCIL , COLORMASK , DEPTH , VIEWPORT ,
  SCISSOR , BLENDCOLOR , MULTISAMPLE , CLIPPLANE ,
  COLORMATRIX , VERTEXPROGRAM , FRAGMENTPROGRAM , POINTSPRITE ,
  PROGRAM , CLAMPCOLOR , HINT , SAMPLEMASKI ,
  PRIMITIVERESTARTINDEX , CLIPCONTROL , VALIDATOR , VIEWMATRIXEXTRACTOR ,
  OSGNV_PARAMETER_BLOCK , OSGNVEXT_TEXTURE_SHADER , OSGNVEXT_VERTEX_PROGRAM , OSGNVEXT_REGISTER_COMBINERS ,
  OSGNVCG_PROGRAM , OSGNVSLANG_PROGRAM , OSGNVPARSE_PROGRAM_PARSER , UNIFORMBUFFERBINDING ,
  TRANSFORMFEEDBACKBUFFERBINDING , ATOMICCOUNTERBUFFERBINDING , PATCH_PARAMETER , FRAME_BUFFER_OBJECT ,
  VERTEX_ATTRIB_DIVISOR , SHADERSTORAGEBUFFERBINDING , INDIRECTDRAWBUFFERBINDING , VIEWPORTINDEXED ,
  DEPTHRANGEINDEXED , SCISSORINDEXED , BINDIMAGETEXTURE , SAMPLER ,
  CAPABILITY = 100
}
 Type identifier to differentiate between different state types. More...
typedef GLenum GLMode
 GLMode is the value used in glEnable/glDisable(mode)
typedef unsigned int GLModeValue
 GLModeValue is used to specify whether a mode is enabled (ON) or disabled (OFF).
typedef unsigned int OverrideValue
 Override is used to specify the override behavior of StateAttributes from parent to children.
typedef std::pair< Type, unsigned int > TypeMemberPair
 Simple pairing between an attribute type and the member within that attribute type group.
typedef std::vector< StateSet * > ParentList
 A vector of osg::StateSet pointers which is used to store the parent(s) of this StateAttribute.
typedef osg::StateAttributeCallback Callback
Public Types inherited from osg::Object
enum  DataVariance { DYNAMIC , STATIC , UNSPECIFIED }

Public Member Functions

 Texture ()
 Texture (const Texture &text, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 Copy constructor using CopyOp to manage deep vs shallow copy.
virtual osg::ObjectcloneType () const =0
 Clone the type of an attribute, with Object* return type.
virtual osg::Objectclone (const CopyOp &copyop) const =0
 Clone an attribute, with Object* return type.
virtual bool isSameKindAs (const osg::Object *obj) const
 Return true if this and obj are of the same kind of object.
virtual const char * libraryName () const
 Return the name of the attribute's library.
virtual const char * className () const
 Return the name of the attribute's class type.
virtual TextureasTexture ()
 Fast alternative to dynamic_cast<> for determining if state attribute is a Texture.
virtual const TextureasTexture () const
 Fast alternative to dynamic_cast<> for determining if state attribute is a Texture.
virtual Type getType () const
 Return the Type identifier of the attribute's class type.
virtual bool isTextureAttribute () const
 Return true if StateAttribute is a type which controls texturing and needs to be issued w.r.t to specific texture unit.
virtual GLenum getTextureTarget () const =0
virtual int getTextureWidth () const
virtual int getTextureHeight () const
virtual int getTextureDepth () const
void setWrap (WrapParameter which, WrapMode wrap)
 Sets the texture wrap mode.
WrapMode getWrap (WrapParameter which) const
 Gets the texture wrap mode.
void setBorderColor (const Vec4d &color)
 Sets the border color.
const Vec4dgetBorderColor () const
 Gets the border color.
void setBorderWidth (GLint width)
 Sets the border width.
GLint getBorderWidth () const
void setFilter (FilterParameter which, FilterMode filter)
 Sets the texture filter mode.
FilterMode getFilter (FilterParameter which) const
 Gets the texture filter mode.
void setMaxAnisotropy (float anis)
 Sets the maximum anisotropy value, default value is 1.0 for no anisotropic filtering.
float getMaxAnisotropy () const
 Gets the maximum anisotropy value.
void setMinLOD (float minlod)
 Sets the minimum level of detail value.
float getMinLOD () const
 Gets the minimum level of detail value.
void setMaxLOD (float maxlod)
 Sets the maximum level of detail value.
float getMaxLOD () const
 Gets the maximum level of detail value.
void setLODBias (float lodbias)
 Gets the level of detail bias value.
float getLODBias () const
 Sets the level of detail bias value.
void setSwizzle (const Vec4i &swizzle)
 Configure the source of texture swizzling for all channels.
const Vec4igetSwizzle () const
 Gets the source of texture swizzling for all channels.
void setUseHardwareMipMapGeneration (bool useHardwareMipMapGeneration)
 Sets the hardware mipmap generation hint.
bool getUseHardwareMipMapGeneration () const
 Gets the hardware mipmap generation hint.
void setUnRefImageDataAfterApply (bool flag)
 Sets whether or not the apply() function will unreference the image data.
bool getUnRefImageDataAfterApply () const
 Gets whether or not apply() unreferences image data.
void setClientStorageHint (bool flag)
 Sets whether to use client storage for the texture, if supported by the graphics system.
bool getClientStorageHint () const
 Gets whether to use client storage for the texture.
void setResizeNonPowerOfTwoHint (bool flag)
 Sets whether to force the texture to resize images that have dimensions that are not a power of two.
bool getResizeNonPowerOfTwoHint () const
 Gets whether texture will force non power to two images to be resized.
void setInternalFormatMode (InternalFormatMode mode)
 Sets the internal texture format mode.
InternalFormatMode getInternalFormatMode () const
 Gets the internal texture format mode.
void setInternalFormat (GLint internalFormat)
 Sets the internal texture format.
GLint getInternalFormat () const
 Gets the internal texture format.
bool isCompressedInternalFormat () const
 Return true if the internal format is one of the compressed formats.
void setSourceFormat (GLenum sourceFormat)
 Sets the external source image format, used as a fallback when no osg::Image is attached to provide the source image format.
GLenum getSourceFormat () const
 Gets the external source image format.
void setSourceType (GLenum sourceType)
 Sets the external source data type, used as a fallback when no osg::Image is attached to provide the source image format.
GLenum getSourceType () const
 Gets the external source data type.
InternalFormatType getInternalFormatType () const
 Get the internal texture format type.
GLenum selectSizedInternalFormat (const osg::Image *image=0) const
virtual bool isDirty (unsigned int) const
 return true if the texture image data has been modified and the associated GL texture object needs to be updated.
TextureObjectgetTextureObject (unsigned int contextID) const
 Returns a pointer to the TextureObject for the current context.
void setTextureObject (unsigned int contextID, TextureObject *to)
void dirtyTextureObject ()
 Forces a recompile on next apply() of associated OpenGL texture objects.
bool areAllTextureObjectsLoaded () const
 Returns true if the texture objects for all the required graphics contexts are loaded.
unsigned int & getTextureParameterDirty (unsigned int contextID) const
 Gets the dirty flag for the current contextID.
void dirtyTextureParameters ()
 Force a reset on next apply() of associated OpenGL texture parameters.
void allocateMipmapLevels ()
 Force a manual allocation of the mipmap levels on the next apply() call.
void setShadowComparison (bool flag)
 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.
bool getShadowComparison () const
void setShadowCompareFunc (ShadowCompareFunc func)
 Sets shadow texture comparison function.
ShadowCompareFunc getShadowCompareFunc () const
void setShadowTextureMode (ShadowTextureMode mode)
 Sets shadow texture mode after comparison.
ShadowTextureMode getShadowTextureMode () const
void setShadowAmbient (float shadow_ambient)
 Sets the TEXTURE_COMPARE_FAIL_VALUE_ARB texture parameter.
float getShadowAmbient () const
virtual void setImage (unsigned int face, Image *image)=0
 Sets the texture image for the specified face.
template<class T>
void setImage (unsigned int face, const ref_ptr< T > &image)
virtual ImagegetImage (unsigned int face)=0
 Gets the texture image for the specified face.
virtual const ImagegetImage (unsigned int face) const =0
 Gets the const texture image for specified face.
virtual unsigned int getNumImages () const =0
 Gets the number of images that can be assigned to this Texture.
void setReadPBuffer (GraphicsContext *context)
 Set the PBuffer graphics context to read from when using PBuffers for RenderToTexture.
template<class T>
void setReadPBuffer (const ref_ptr< T > &context)
GraphicsContextgetReadPBuffer ()
 Get the PBuffer graphics context to read from when using PBuffers for RenderToTexture.
const GraphicsContextgetReadPBuffer () const
 Get the const PBuffer graphics context to read from when using PBuffers for RenderToTexture.
virtual void apply (State &state) const =0
 Texture is a pure virtual base class, apply must be overridden.
virtual void compileGLObjects (State &state) const
 Calls apply(state) to compile the texture.
virtual void resizeGLObjectBuffers (unsigned int maxSize)
 Resize any per context GLObject buffers to specified size.
virtual void releaseGLObjects (State *state=0) const
 If State is non-zero, this function releases OpenGL objects for the specified graphics context.
void applyTexImage2D_load (State &state, GLenum target, const Image *image, GLsizei width, GLsizei height, GLsizei numMipmapLevels) const
 Helper method.
void applyTexImage2D_subload (State &state, GLenum target, const Image *image, GLsizei width, GLsizei height, GLint inInternalFormat, GLsizei numMipmapLevels) const
 Helper method.
TextureObjectgenerateAndAssignTextureObject (unsigned int contextID, GLenum target) const
TextureObjectgenerateAndAssignTextureObject (unsigned int contextID, GLenum target, GLint numMipmapLevels, GLenum internalFormat, GLsizei width, GLsizei height, GLsizei depth, GLint border) const
Public Member Functions inherited from osg::StateAttribute
 StateAttribute ()
 StateAttribute (const StateAttribute &sa, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
virtual StateAttributeasStateAttribute ()
 Convert 'this' into a StateAttribute pointer if Object is a StateAttribute, otherwise return 0.
virtual const StateAttributeasStateAttribute () const
 convert 'const this' into a const StateAttribute pointer if Object is a StateAttribute, otherwise return 0.
virtual unsigned int getMember () const
 Return the member identifier within the attribute's class type.
TypeMemberPair getTypeMemberPair () const
 Return the TypeMemberPair that uniquely identifies this type member.
virtual int compare (const StateAttribute &sa) const =0
 Return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs.
bool operator< (const StateAttribute &rhs) const
bool operator== (const StateAttribute &rhs) const
bool operator!= (const StateAttribute &rhs) const
const ParentListgetParents () const
 Get the parent list of this StateAttribute.
StateSetgetParent (unsigned int i)
const StateSetgetParent (unsigned int i) const
 Get a single const parent of this StateAttribute.
unsigned int getNumParents () const
 Get the number of parents of this StateAttribute.
void setShaderComponent (ShaderComponent *sc)
ShaderComponentgetShaderComponent ()
const ShaderComponentgetShaderComponent () const
virtual bool getModeUsage (ModeUsage &) const
 Return the modes associated with this StateAttribute.
virtual bool checkValidityOfAssociatedModes (osg::State &) const
 Check the modes associated with this StateAttribute are supported by current OpenGL drivers, and if not set the associated mode in osg::State to be black listed/invalid.
void setUpdateCallback (StateAttributeCallback *uc)
 Set the UpdateCallback which allows users to attach customize the updating of an object during the update traversal.
StateAttributeCallbackgetUpdateCallback ()
 Get the non const UpdateCallback.
const StateAttributeCallbackgetUpdateCallback () const
 Get the const UpdateCallback.
void setEventCallback (StateAttributeCallback *ec)
 Set the EventCallback which allows users to attach customize the updating of an object during the Event traversal.
StateAttributeCallbackgetEventCallback ()
 Get the non const EventCallback.
const StateAttributeCallbackgetEventCallback () const
 Get the const EventCallback.
Public Member Functions inherited from osg::Object
 Object ()
 Construct an object.
 Object (bool threadSafeRefUnref)
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 Copy constructor, optional CopyOp object can be used to control shallow vs deep copying of dynamic data.
std::string getCompoundClassName () const
 return the compound class name that combines the library name and class name.
virtual NodeasNode ()
 Convert 'this' into a Node pointer if Object is a Node, otherwise return 0.
virtual const NodeasNode () const
 convert 'const this' into a const Node pointer if Object is a Node, otherwise return 0.
virtual NodeVisitorasNodeVisitor ()
 Convert 'this' into a NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0.
virtual const NodeVisitorasNodeVisitor () const
 convert 'const this' into a const NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0.
virtual StateSetasStateSet ()
 Convert 'this' into a StateSet pointer if Object is a StateSet, otherwise return 0.
virtual const StateSetasStateSet () const
 convert 'const this' into a const StateSet pointer if Object is a StateSet, otherwise return 0.
virtual UniformasUniform ()
 Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0.
virtual const UniformasUniform () const
 convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0.
virtual CameraasCamera ()
 Convert 'this' into a Camera pointer if Node is a Camera, otherwise return 0.
virtual const CameraasCamera () const
 convert 'const this' into a const Camera pointer if Node is a Camera, otherwise return 0.
virtual DrawableasDrawable ()
 Convert 'this' into a Drawable pointer if Object is a Drawable, otherwise return 0.
virtual const DrawableasDrawable () const
 convert 'const this' into a const Drawable pointer if Object is a Drawable, otherwise return 0.
virtual CallbackasCallback ()
 Convert 'this' into a Callback pointer if Object is a Callback, otherwise return 0.
virtual const CallbackasCallback () const
 convert 'const this' into a const Callback pointer if Object is a Callback, otherwise return 0.
virtual CallbackObjectasCallbackObject ()
 Convert 'this' into a CallbackObject pointer if Object is a CallbackObject, otherwise return 0.
virtual const CallbackObjectasCallbackObject () const
 convert 'const this' into a const CallbackObject pointer if Object is a CallbackObject, otherwise return 0.
virtual UserDataContainerasUserDataContainer ()
 Convert 'this' into a UserDataContainer pointer if Object is a UserDataContainer, otherwise return 0.
virtual const UserDataContainerasUserDataContainer () const
 convert 'const this' into a const UserDataContainer pointer if Object is a UserDataContainer, otherwise return 0.
virtual ValueObjectasValueObject ()
 Convert 'this' into a ValueObject pointer if Object is a ValueObject, otherwise return 0.
virtual const ValueObjectasValueObject () const
 Convert 'this' into a ValueObject pointer if Object is a ValueObject, otherwise return 0.
virtual ImageasImage ()
 Convert 'this' into a Image pointer if Object is a Image, otherwise return 0.
virtual const ImageasImage () const
 Convert 'this' into a Image pointer if Object is a Image, otherwise return 0.
virtual void setThreadSafeRefUnref (bool threadSafe)
 Set whether to use a mutex to ensure ref() and unref() are thread safe.
virtual void setName (const std::string &name)
 Set the name of object using C++ style string.
void setName (const char *name)
 Set the name of object using a C style string.
const std::string & getName () const
 Get the name of object.
void setDataVariance (DataVariance dv)
 Set the data variance of this object.
DataVariance getDataVariance () const
 Get the data variance of this object.
virtual void computeDataVariance ()
 Compute the DataVariance based on an assessment of callback etc.
void setUserDataContainer (osg::UserDataContainer *udc)
 set the UserDataContainer object.
template<class T>
void setUserDataContainer (const ref_ptr< T > &udc)
osg::UserDataContainergetUserDataContainer ()
 get the UserDataContainer attached to this object.
const osg::UserDataContainergetUserDataContainer () const
 get the const UserDataContainer attached to this object.
osg::UserDataContainergetOrCreateUserDataContainer ()
 Convenience method that returns the UserDataContainer, and if one doesn't already exist creates and assigns a DefaultUserDataContainer to the Object and then return this new UserDataContainer.
virtual void setUserData (Referenced *obj)
 Set user data, data must be subclassed from Referenced to allow automatic memory handling.
template<class T>
void setUserData (const ref_ptr< T > &ud)
virtual ReferencedgetUserData ()
 Get user data.
virtual const ReferencedgetUserData () const
 Get const user data.
template<typename T>
bool getUserValue (const std::string &name, T &value) const
 Convenience method that casts the named UserObject to osg::TemplateValueObject<T> and gets the value.
template<typename T>
void setUserValue (const std::string &name, const T &value)
 Convenience method that creates the osg::TemplateValueObject<T> to store the specified value and adds it as a named UserObject.
template<typename T>
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject BoundingBoxdValueObject BoundingSpheredValueObject bool getUserValue (const std::string &name, T &value) const
 provide implementation of osg::Object::getUserValue(..) template
Public Member Functions inherited from osg::Referenced
 Referenced ()
 Referenced (bool threadSafeRefUnref)
 Deprecated, Referenced is now always uses thread safe ref/unref, use default Referenced() constructor instead.
 Referenced (const Referenced &)
Referencedoperator= (const Referenced &)
bool getThreadSafeRefUnref () const
 Get whether a mutex is used to ensure ref() and unref() are thread safe.
OpenThreads::Mutex * getRefMutex () const
 Get the mutex used to ensure thread safety of ref()/unref().
int ref () const
 Increment the reference count by one, indicating that this object has another pointer which is referencing it.
int unref () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it.
int unref_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it.
int referenceCount () const
 Return the number of pointers currently referencing this object.
ObserverSetgetObserverSet () const
 Get the ObserverSet if one is attached, otherwise return NULL.
ObserverSetgetOrCreateObserverSet () const
 Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet.
void addObserver (Observer *observer) const
 Add a Observer that is observing this object, notify the Observer when this object gets deleted.
void removeObserver (Observer *observer) const
 Remove Observer that is observing this object.

Static Public Member Functions

static bool isCompressedInternalFormat (GLint internalFormat)
 Determine whether the given internalFormat is a compressed image format.
static void getCompressedSize (GLenum internalFormat, GLint width, GLint height, GLint depth, GLint &blockSize, GLint &size)
 Determine the size of a compressed image, given the internalFormat, the width, the height, and the depth of the image.
static osg::ref_ptr< TextureObjectgenerateTextureObject (const Texture *texture, unsigned int contextID, GLenum target)
static osg::ref_ptr< TextureObjectgenerateTextureObject (const Texture *texture, unsigned int contextID, GLenum target, GLint numMipmapLevels, GLenum internalFormat, GLsizei width, GLsizei height, GLsizei depth, GLint border)
Static Public Member Functions inherited from osg::Referenced
static OpenThreads::Mutex * getGlobalReferencedMutex ()
 Get the optional global Referenced mutex, this can be shared between all osg::Referenced.
static void setDeleteHandler (DeleteHandler *handler)
 Set a DeleteHandler to which deletion of all referenced counted objects will be delegated.
static DeleteHandlergetDeleteHandler ()
 Get a DeleteHandler.

Protected Types

typedef buffered_value< unsigned int > TexParameterDirtyList
typedef buffered_object< ref_ptr< TextureObject > > TextureObjectBuffer

Protected Member Functions

virtual ~Texture ()
virtual void computeInternalFormat () const =0
void computeInternalFormatWithImage (const osg::Image &image) const
 Computes the internal format from Image parameters.
void computeRequiredTextureDimensions (State &state, const osg::Image &image, GLsizei &width, GLsizei &height, GLsizei &numMipmapLevels) const
 Computes the texture dimension for the given Image.
void computeInternalFormatType () const
 Computes the internal format type.
void applyTexParameters (GLenum target, State &state) const
 Helper method.
bool isHardwareMipmapGenerationEnabled (const State &state) const
 Returns true if _useHardwareMipMapGeneration is true and either glGenerateMipmapEXT() or GL_GENERATE_MIPMAP_SGIS are supported.
bool isSafeToUnrefImageData (const State &state) const
 Returns true if the associated Image should be released and it's safe to do so.
GenerateMipmapMode mipmapBeforeTexImage (const State &state, bool hardwareMipmapOn) const
 Helper methods to be called before and after calling gl[Compressed][Copy]Tex[Sub]Image2D to handle generating mipmaps.
void mipmapAfterTexImage (State &state, GenerateMipmapMode beforeResult) const
void generateMipmap (State &state) const
 Helper method to generate mipmap levels by calling of glGenerateMipmapEXT.
virtual void allocateMipmap (State &state) const =0
 Allocate mipmap levels of the texture by subsequent calling of glTexImage* function.
int compareTexture (const Texture &rhs) const
 Returns -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs.
int compareTextureObjects (const Texture &rhs) const
 Returns -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs.
Protected Member Functions inherited from osg::StateAttribute
virtual ~StateAttribute ()
void addParent (osg::StateSet *object)
void removeParent (osg::StateSet *object)
Protected Member Functions inherited from osg::Object
virtual ~Object ()
 Object destructor.
Protected Member Functions inherited from osg::Referenced
virtual ~Referenced ()
void signalObserversAndDelete (bool signalDelete, bool doDelete) const
void deleteUsingDeleteHandler () const

Protected Attributes

TexParameterDirtyList _texParametersDirtyList
TexParameterDirtyList _texMipmapGenerationDirtyList
WrapMode _wrap_s
WrapMode _wrap_t
WrapMode _wrap_r
FilterMode _min_filter
FilterMode _mag_filter
float _maxAnisotropy
float _minlod
float _maxlod
float _lodbias
Vec4i _swizzle
bool _useHardwareMipMapGeneration
bool _unrefImageDataAfterApply
bool _clientStorageHint
bool _resizeNonPowerOfTwoHint
Vec4d _borderColor
GLint _borderWidth
InternalFormatMode _internalFormatMode
InternalFormatType _internalFormatType
GLint _internalFormat
GLenum _sourceFormat
GLenum _sourceType
bool _use_shadow_comparison
ShadowCompareFunc _shadow_compare_func
ShadowTextureMode _shadow_texture_mode
float _shadow_ambient
TextureObjectBuffer _textureObjectBuffer
ref_ptr< GraphicsContext_readPBuffer
Protected Attributes inherited from osg::StateAttribute
ParentList _parents
ref_ptr< ShaderComponent_shaderComponent
ref_ptr< StateAttributeCallback_updateCallback
ref_ptr< StateAttributeCallback_eventCallback
Protected Attributes inherited from osg::Object
std::string _name
DataVariance _dataVariance
osg::UserDataContainer_userDataContainer
Protected Attributes inherited from osg::Referenced
OpenThreads::AtomicPtr _observerSet
OpenThreads::Atomic _refCount

Detailed Description

Texture pure virtual base class that encapsulates OpenGL texture functionality common to the various types of OSG textures.

Member Typedef Documentation

◆ TexParameterDirtyList

typedef buffered_value<unsigned int> osg::Texture::TexParameterDirtyList
protected

◆ TextureObjectBuffer

◆ TextureObjectList

Member Enumeration Documentation

◆ FilterMode

Enumerator
LINEAR 
LINEAR_MIPMAP_LINEAR 
LINEAR_MIPMAP_NEAREST 
NEAREST 
NEAREST_MIPMAP_LINEAR 
NEAREST_MIPMAP_NEAREST 

◆ FilterParameter

Enumerator
MIN_FILTER 
MAG_FILTER 

◆ GenerateMipmapMode

Returned by mipmapBeforeTexImage() to indicate what mipmapAfterTexImage() should do.

Enumerator
GENERATE_MIPMAP_NONE 
GENERATE_MIPMAP 
GENERATE_MIPMAP_TEX_PARAMETER 

◆ InternalFormatMode

Enumerator
USE_IMAGE_DATA_FORMAT 
USE_USER_DEFINED_FORMAT 
USE_ARB_COMPRESSION 
USE_S3TC_DXT1_COMPRESSION 
USE_S3TC_DXT3_COMPRESSION 
USE_S3TC_DXT5_COMPRESSION 
USE_PVRTC_2BPP_COMPRESSION 
USE_PVRTC_4BPP_COMPRESSION 
USE_ETC_COMPRESSION 
USE_ETC2_COMPRESSION 
USE_RGTC1_COMPRESSION 
USE_RGTC2_COMPRESSION 
USE_S3TC_DXT1c_COMPRESSION 
USE_S3TC_DXT1a_COMPRESSION 

◆ InternalFormatType

Texture type determined by the internal texture format.

Enumerator
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)

◆ ShadowCompareFunc

Enumerator
NEVER 
LESS 
EQUAL 
LEQUAL 
GREATER 
NOTEQUAL 
GEQUAL 
ALWAYS 

◆ ShadowTextureMode

Enumerator
LUMINANCE 
INTENSITY 
ALPHA 
NONE 

◆ WrapMode

Enumerator
CLAMP 
CLAMP_TO_EDGE 
CLAMP_TO_BORDER 
REPEAT 
MIRROR 

◆ WrapParameter

Enumerator
WRAP_S 
WRAP_T 
WRAP_R 

Constructor & Destructor Documentation

◆ Texture() [1/2]

◆ Texture() [2/2]

osg::Texture::Texture ( const Texture & text,
const CopyOp & copyop = CopyOp::SHALLOW_COPY )

Copy constructor using CopyOp to manage deep vs shallow copy.

References osg::CopyOp::SHALLOW_COPY, and Texture().

◆ ~Texture()

virtual osg::Texture::~Texture ( )
protectedvirtual

Member Function Documentation

◆ allocateMipmap()

virtual void osg::Texture::allocateMipmap ( State & state) const
protectedpure virtual

Allocate mipmap levels of the texture by subsequent calling of glTexImage* function.

Implemented in osg::Texture1D, osg::Texture2D, osg::Texture2DArray, osg::Texture2DMultisample, osg::Texture3D, osg::TextureBuffer, osg::TextureCubeMap, and osg::TextureRectangle.

◆ allocateMipmapLevels()

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.

◆ apply()

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::Texture2DMultisample, osg::Texture3D, osg::TextureBuffer, osg::TextureCubeMap, and osg::TextureRectangle.

◆ applyTexImage2D_load()

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.

◆ applyTexImage2D_subload()

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.

◆ applyTexParameters()

void osg::Texture::applyTexParameters ( GLenum target,
State & state ) const
protected

Helper method.

Sets texture parameters.

◆ areAllTextureObjectsLoaded()

bool osg::Texture::areAllTextureObjectsLoaded ( ) const

Returns true if the texture objects for all the required graphics contexts are loaded.

Referenced by isSafeToUnrefImageData().

◆ asTexture() [1/2]

virtual Texture * osg::Texture::asTexture ( )
inlinevirtual

Fast alternative to dynamic_cast<> for determining if state attribute is a Texture.

Reimplemented from osg::StateAttribute.

References Texture().

◆ asTexture() [2/2]

virtual const Texture * osg::Texture::asTexture ( ) const
inlinevirtual

Fast alternative to dynamic_cast<> for determining if state attribute is a Texture.

Reimplemented from osg::StateAttribute.

References Texture().

◆ className()

virtual const char * osg::Texture::className ( ) const
inlinevirtual

Return the name of the attribute's class type.

Reimplemented from osg::StateAttribute.

Reimplemented in osgText::GlyphTexture.

◆ clone()

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.

◆ cloneType()

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.

◆ compareTexture()

int osg::Texture::compareTexture ( const Texture & rhs) const
protected

Returns -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs.

References Texture().

◆ compareTextureObjects()

int osg::Texture::compareTextureObjects ( const Texture & rhs) const
protected

Returns -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs.

References Texture().

◆ compileGLObjects()

virtual void osg::Texture::compileGLObjects ( State & state) const
virtual

Calls apply(state) to compile the texture.

Reimplemented from osg::StateAttribute.

◆ computeInternalFormat()

virtual void osg::Texture::computeInternalFormat ( ) const
protectedpure virtual

◆ computeInternalFormatType()

void osg::Texture::computeInternalFormatType ( ) const
protected

Computes the internal format type.

Referenced by setInternalFormat().

◆ computeInternalFormatWithImage()

void osg::Texture::computeInternalFormatWithImage ( const osg::Image & image) const
protected

Computes the internal format from Image parameters.

◆ computeRequiredTextureDimensions()

void osg::Texture::computeRequiredTextureDimensions ( State & state,
const osg::Image & image,
GLsizei & width,
GLsizei & height,
GLsizei & numMipmapLevels ) const
protected

Computes the texture dimension for the given Image.

◆ dirtyTextureObject()

void osg::Texture::dirtyTextureObject ( )

Forces a recompile on next apply() of associated OpenGL texture objects.

◆ dirtyTextureParameters()

void osg::Texture::dirtyTextureParameters ( )

Force a reset on next apply() of associated OpenGL texture parameters.

Referenced by setBorderColor(), setBorderWidth(), and setSwizzle().

◆ generateAndAssignTextureObject() [1/2]

TextureObject * osg::Texture::generateAndAssignTextureObject ( unsigned int contextID,
GLenum target ) const

◆ generateAndAssignTextureObject() [2/2]

TextureObject * osg::Texture::generateAndAssignTextureObject ( unsigned int contextID,
GLenum target,
GLint numMipmapLevels,
GLenum internalFormat,
GLsizei width,
GLsizei height,
GLsizei depth,
GLint border ) const

◆ generateMipmap()

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

◆ generateTextureObject() [1/2]

osg::ref_ptr< TextureObject > osg::Texture::generateTextureObject ( const Texture * texture,
unsigned int contextID,
GLenum target )
static

◆ generateTextureObject() [2/2]

osg::ref_ptr< TextureObject > osg::Texture::generateTextureObject ( const Texture * texture,
unsigned int contextID,
GLenum target,
GLint numMipmapLevels,
GLenum internalFormat,
GLsizei width,
GLsizei height,
GLsizei depth,
GLint border )
static

References Texture().

◆ getBorderColor()

const Vec4d & osg::Texture::getBorderColor ( ) const
inline

Gets the border color.

References _borderColor.

◆ getBorderWidth()

GLint osg::Texture::getBorderWidth ( ) const
inline

References _borderWidth.

◆ getClientStorageHint()

bool osg::Texture::getClientStorageHint ( ) const
inline

Gets whether to use client storage for the texture.

References _clientStorageHint.

◆ getCompressedSize()

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.

◆ getFilter()

FilterMode osg::Texture::getFilter ( FilterParameter which) const

Gets the texture filter mode.

◆ getImage() [1/2]

virtual const Image * osg::Texture::getImage ( unsigned int face) const
pure virtual

◆ getImage() [2/2]

virtual Image * osg::Texture::getImage ( unsigned int face)
pure virtual

◆ getInternalFormat()

GLint osg::Texture::getInternalFormat ( ) const
inline

Gets the internal texture format.

References _internalFormat, and computeInternalFormat().

◆ getInternalFormatMode()

InternalFormatMode osg::Texture::getInternalFormatMode ( ) const
inline

Gets the internal texture format mode.

References _internalFormatMode.

◆ getInternalFormatType()

InternalFormatType osg::Texture::getInternalFormatType ( ) const
inline

Get the internal texture format type.

References _internalFormatType.

◆ getLODBias()

float osg::Texture::getLODBias ( ) const
inline

Sets the level of detail bias value.

References _lodbias.

◆ getMaxAnisotropy()

float osg::Texture::getMaxAnisotropy ( ) const
inline

Gets the maximum anisotropy value.

References _maxAnisotropy.

◆ getMaxLOD()

float osg::Texture::getMaxLOD ( ) const
inline

Gets the maximum level of detail value.

References _maxlod.

◆ getMinLOD()

float osg::Texture::getMinLOD ( ) const
inline

Gets the minimum level of detail value.

References _minlod.

◆ getNumImages()

virtual unsigned int osg::Texture::getNumImages ( ) const
pure virtual

◆ getReadPBuffer() [1/2]

GraphicsContext * osg::Texture::getReadPBuffer ( )
inline

Get the PBuffer graphics context to read from when using PBuffers for RenderToTexture.

References _readPBuffer.

◆ getReadPBuffer() [2/2]

const GraphicsContext * osg::Texture::getReadPBuffer ( ) const
inline

Get the const PBuffer graphics context to read from when using PBuffers for RenderToTexture.

References _readPBuffer.

◆ getResizeNonPowerOfTwoHint()

bool osg::Texture::getResizeNonPowerOfTwoHint ( ) const
inline

Gets whether texture will force non power to two images to be resized.

References _resizeNonPowerOfTwoHint.

◆ getShadowAmbient()

float osg::Texture::getShadowAmbient ( ) const
inline

References _shadow_ambient.

◆ getShadowCompareFunc()

ShadowCompareFunc osg::Texture::getShadowCompareFunc ( ) const
inline

References _shadow_compare_func.

◆ getShadowComparison()

bool osg::Texture::getShadowComparison ( ) const
inline

◆ getShadowTextureMode()

ShadowTextureMode osg::Texture::getShadowTextureMode ( ) const
inline

References _shadow_texture_mode.

◆ getSourceFormat()

GLenum osg::Texture::getSourceFormat ( ) const
inline

Gets the external source image format.

References _sourceFormat.

◆ getSourceType()

GLenum osg::Texture::getSourceType ( ) const
inline

Gets the external source data type.

References _sourceType.

◆ getSwizzle()

const Vec4i & osg::Texture::getSwizzle ( ) const
inline

Gets the source of texture swizzling for all channels.

References _swizzle.

◆ getTextureDepth()

virtual int osg::Texture::getTextureDepth ( ) const
inlinevirtual

◆ getTextureHeight()

virtual int osg::Texture::getTextureHeight ( ) const
inlinevirtual

◆ getTextureObject()

TextureObject * osg::Texture::getTextureObject ( unsigned int contextID) const
inline

Returns a pointer to the TextureObject for the current context.

References _textureObjectBuffer.

◆ getTextureParameterDirty()

unsigned int & osg::Texture::getTextureParameterDirty ( unsigned int contextID) const
inline

Gets the dirty flag for the current contextID.

References _texParametersDirtyList.

◆ getTextureTarget()

◆ getTextureWidth()

virtual int osg::Texture::getTextureWidth ( ) const
inlinevirtual

◆ getType()

virtual Type osg::Texture::getType ( ) const
inlinevirtual

Return the Type identifier of the attribute's class type.

Implements osg::StateAttribute.

References osg::StateAttribute::TEXTURE.

◆ getUnRefImageDataAfterApply()

bool osg::Texture::getUnRefImageDataAfterApply ( ) const
inline

Gets whether or not apply() unreferences image data.

References _unrefImageDataAfterApply.

◆ getUseHardwareMipMapGeneration()

bool osg::Texture::getUseHardwareMipMapGeneration ( ) const
inline

Gets the hardware mipmap generation hint.

References _useHardwareMipMapGeneration.

◆ getWrap()

WrapMode osg::Texture::getWrap ( WrapParameter which) const

Gets the texture wrap mode.

◆ isCompressedInternalFormat() [1/2]

bool osg::Texture::isCompressedInternalFormat ( ) const

Return true if the internal format is one of the compressed formats.

◆ isCompressedInternalFormat() [2/2]

bool osg::Texture::isCompressedInternalFormat ( GLint internalFormat)
static

Determine whether the given internalFormat is a compressed image format.

◆ isDirty()

virtual bool osg::Texture::isDirty ( unsigned int ) const
inlinevirtual

return true if the texture image data has been modified and the associated GL texture object needs to be updated.

Reimplemented in osg::Texture1D, osg::Texture2D, osg::Texture2DArray, osg::Texture3D, osg::TextureBuffer, osg::TextureCubeMap, and osg::TextureRectangle.

◆ isHardwareMipmapGenerationEnabled()

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.

◆ isSafeToUnrefImageData()

bool osg::Texture::isSafeToUnrefImageData ( const State & state) const
inlineprotected

Returns true if the associated Image should be released and it's safe to do so.

References _unrefImageDataAfterApply, areAllTextureObjectsLoaded(), and osg::State::getMaxTexturePoolSize().

◆ isSameKindAs()

virtual bool osg::Texture::isSameKindAs ( const osg::Object * obj) const
inlinevirtual

Return true if this and obj are of the same kind of object.

Reimplemented from osg::StateAttribute.

References NULL, and Texture().

◆ isTextureAttribute()

virtual bool osg::Texture::isTextureAttribute ( ) const
inlinevirtual

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.

◆ libraryName()

virtual const char * osg::Texture::libraryName ( ) const
inlinevirtual

Return the name of the attribute's library.

Reimplemented from osg::StateAttribute.

◆ mipmapAfterTexImage()

void osg::Texture::mipmapAfterTexImage ( State & state,
GenerateMipmapMode beforeResult ) const
protected

◆ mipmapBeforeTexImage()

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.

◆ releaseGLObjects()

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.

◆ resizeGLObjectBuffers()

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::GlyphTexture.

◆ selectSizedInternalFormat()

GLenum osg::Texture::selectSizedInternalFormat ( const osg::Image * image = 0) const

◆ setBorderColor()

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.

References _borderColor, and dirtyTextureParameters().

◆ setBorderWidth()

void osg::Texture::setBorderWidth ( GLint width)
inline

Sets the border width.

References _borderWidth, and dirtyTextureParameters().

◆ setClientStorageHint()

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.

References _clientStorageHint.

◆ setFilter()

void osg::Texture::setFilter ( FilterParameter which,
FilterMode filter )

Sets the texture filter mode.

Referenced by osg::TextureRectangle::TextureRectangle().

◆ setImage() [1/2]

template<class T>
void osg::Texture::setImage ( unsigned int face,
const ref_ptr< T > & image )
inline

References osg::ref_ptr< T >::get(), and setImage().

Referenced by setImage().

◆ setImage() [2/2]

virtual void osg::Texture::setImage ( unsigned int face,
Image * image )
pure virtual

◆ setInternalFormat()

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.

References _internalFormat, _internalFormatMode, computeInternalFormatType(), and USE_USER_DEFINED_FORMAT.

◆ setInternalFormatMode()

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.

References _internalFormatMode.

◆ setLODBias()

void osg::Texture::setLODBias ( float lodbias)

Gets the level of detail bias value.

◆ setMaxAnisotropy()

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.

◆ setMaxLOD()

void osg::Texture::setMaxLOD ( float maxlod)

Sets the maximum level of detail value.

◆ setMinLOD()

void osg::Texture::setMinLOD ( float minlod)

Sets the minimum level of detail value.

◆ setReadPBuffer() [1/2]

template<class T>
void osg::Texture::setReadPBuffer ( const ref_ptr< T > & context)
inline

◆ setReadPBuffer() [2/2]

void osg::Texture::setReadPBuffer ( GraphicsContext * context)
inline

Set the PBuffer graphics context to read from when using PBuffers for RenderToTexture.

References _readPBuffer.

◆ setResizeNonPowerOfTwoHint()

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.

References _resizeNonPowerOfTwoHint.

◆ setShadowAmbient()

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.

References _shadow_ambient.

◆ setShadowCompareFunc()

void osg::Texture::setShadowCompareFunc ( ShadowCompareFunc func)
inline

Sets shadow texture comparison function.

References _shadow_compare_func.

◆ setShadowComparison()

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.

References _use_shadow_comparison.

◆ setShadowTextureMode()

void osg::Texture::setShadowTextureMode ( ShadowTextureMode mode)
inline

Sets shadow texture mode after comparison.

References _shadow_texture_mode.

◆ setSourceFormat()

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.

References _sourceFormat.

◆ setSourceType()

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.

References _sourceType.

◆ setSwizzle()

void osg::Texture::setSwizzle ( const Vec4i & swizzle)
inline

Configure the source of texture swizzling for all channels.

References _swizzle, and dirtyTextureParameters().

◆ setTextureObject()

void osg::Texture::setTextureObject ( unsigned int contextID,
TextureObject * to )
inline

References _textureObjectBuffer.

◆ setUnRefImageDataAfterApply()

void osg::Texture::setUnRefImageDataAfterApply ( bool flag)
inline

Sets whether or not the apply() function will unreference the image data.

If enabled, and the image data is only referenced by this Texture, apply() will delete the image data.

References _unrefImageDataAfterApply.

◆ setUseHardwareMipMapGeneration()

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.

References _useHardwareMipMapGeneration.

Referenced by osg::Texture2D::Texture2D().

◆ setWrap()

void osg::Texture::setWrap ( WrapParameter which,
WrapMode wrap )

Sets the texture wrap mode.

Referenced by osg::TextureRectangle::TextureRectangle().

Member Data Documentation

◆ _borderColor

Vec4d osg::Texture::_borderColor
protected

Referenced by getBorderColor(), and setBorderColor().

◆ _borderWidth

GLint osg::Texture::_borderWidth
protected

Referenced by getBorderWidth(), and setBorderWidth().

◆ _clientStorageHint

bool osg::Texture::_clientStorageHint
protected

◆ _internalFormat

GLint osg::Texture::_internalFormat
mutableprotected

◆ _internalFormatMode

InternalFormatMode osg::Texture::_internalFormatMode
protected

◆ _internalFormatType

InternalFormatType osg::Texture::_internalFormatType
mutableprotected

Referenced by getInternalFormatType().

◆ _lodbias

float osg::Texture::_lodbias
protected

Referenced by getLODBias().

◆ _mag_filter

FilterMode osg::Texture::_mag_filter
protected

◆ _maxAnisotropy

float osg::Texture::_maxAnisotropy
protected

Referenced by getMaxAnisotropy().

◆ _maxlod

float osg::Texture::_maxlod
protected

Referenced by getMaxLOD().

◆ _min_filter

FilterMode osg::Texture::_min_filter
protected

◆ _minlod

float osg::Texture::_minlod
protected

Referenced by getMinLOD().

◆ _readPBuffer

ref_ptr<GraphicsContext> osg::Texture::_readPBuffer
mutableprotected

◆ _resizeNonPowerOfTwoHint

bool osg::Texture::_resizeNonPowerOfTwoHint
protected

◆ _shadow_ambient

float osg::Texture::_shadow_ambient
protected

◆ _shadow_compare_func

ShadowCompareFunc osg::Texture::_shadow_compare_func
protected

◆ _shadow_texture_mode

ShadowTextureMode osg::Texture::_shadow_texture_mode
protected

◆ _sourceFormat

GLenum osg::Texture::_sourceFormat
mutableprotected

Referenced by getSourceFormat(), and setSourceFormat().

◆ _sourceType

GLenum osg::Texture::_sourceType
mutableprotected

Referenced by getSourceType(), and setSourceType().

◆ _swizzle

Vec4i osg::Texture::_swizzle
protected

Referenced by getSwizzle(), and setSwizzle().

◆ _texMipmapGenerationDirtyList

TexParameterDirtyList osg::Texture::_texMipmapGenerationDirtyList
mutableprotected

◆ _texParametersDirtyList

TexParameterDirtyList osg::Texture::_texParametersDirtyList
mutableprotected

◆ _textureObjectBuffer

TextureObjectBuffer osg::Texture::_textureObjectBuffer
mutableprotected

◆ _unrefImageDataAfterApply

bool osg::Texture::_unrefImageDataAfterApply
protected

◆ _use_shadow_comparison

bool osg::Texture::_use_shadow_comparison
protected

◆ _useHardwareMipMapGeneration

bool osg::Texture::_useHardwareMipMapGeneration
protected

◆ _wrap_r

WrapMode osg::Texture::_wrap_r
protected

◆ _wrap_s

WrapMode osg::Texture::_wrap_s
protected

◆ _wrap_t

WrapMode osg::Texture::_wrap_t
protected

The documentation for this class was generated from the following file:

osg logo
Generated at Sun Jul 27 2025 00:00:00 for the OpenSceneGraph by doxygen 1.14.0.