OpenSceneGraph  3.5.1
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
osg::Texture Class Referenceabstract

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

Inheritance diagram for osg::Texture:
Inheritance graph
[legend]

Classes

struct  ImageAttachment
 Encapsulates texture image load/store attributes. More...
 
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  ImageAccess { NOT_USED = 0, READ_ONLY = GL_READ_ONLY_ARB, WRITE_ONLY = GL_WRITE_ONLY_ARB, READ_WRITE = GL_READ_WRITE_ARB }
 Type of access that will be performed on the texture image. 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 }
 
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, CAPABILITY = 100
}
 Type identifier to differentiate between different state types. More...
 
typedef GLenum GLMode
 GLMode is the value used in glEnable/glDisable(mode) More...
 
typedef unsigned int GLModeValue
 GLModeValue is used to specify whether a mode is enabled (ON) or disabled (OFF). More...
 
typedef unsigned int OverrideValue
 Override is used to specify the override behavior of StateAttributes from parent to children. More...
 
typedef std::pair< Type, unsigned int > TypeMemberPair
 Simple pairing between an attribute type and the member within that attribute type group. More...
 
typedef std::vector< StateSet * > ParentList
 A vector of osg::StateSet pointers which is used to store the parent(s) of this StateAttribute. More...
 
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. More...
 
virtual osg::ObjectcloneType () const =0
 Clone the type of an attribute, with Object* return type. More...
 
virtual osg::Objectclone (const CopyOp &copyop) const =0
 Clone an attribute, with Object* return type. More...
 
virtual bool isSameKindAs (const osg::Object *obj) const
 Return true if this and obj are of the same kind of object. More...
 
virtual const char * libraryName () const
 Return the name of the attribute's library. More...
 
virtual const char * className () const
 Return the name of the attribute's class type. More...
 
virtual TextureasTexture ()
 Fast alternative to dynamic_cast<> for determining if state attribute is a Texture. More...
 
virtual const TextureasTexture () const
 Fast alternative to dynamic_cast<> for determining if state attribute is a Texture. More...
 
virtual Type getType () const
 Return the Type identifier of the attribute's class type. More...
 
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. More...
 
virtual GLenum getTextureTarget () const =0
 
virtual bool getModeUsage (StateAttribute::ModeUsage &usage) const
 Return the modes associated with this StateAttribute. More...
 
virtual int getTextureWidth () const
 
virtual int getTextureHeight () const
 
virtual int getTextureDepth () const
 
void setWrap (WrapParameter which, WrapMode wrap)
 Sets the texture wrap mode. More...
 
WrapMode getWrap (WrapParameter which) const
 Gets the texture wrap mode. More...
 
void setBorderColor (const Vec4d &color)
 Sets the border color. More...
 
const Vec4dgetBorderColor () const
 Gets the border color. More...
 
void setBorderWidth (GLint width)
 Sets the border width. More...
 
GLint getBorderWidth () const
 
void setFilter (FilterParameter which, FilterMode filter)
 Sets the texture filter mode. More...
 
FilterMode getFilter (FilterParameter which) const
 Gets the texture filter mode. More...
 
void setMaxAnisotropy (float anis)
 Sets the maximum anisotropy value, default value is 1.0 for no anisotropic filtering. More...
 
float getMaxAnisotropy () const
 Gets the maximum anisotropy value. More...
 
void setSwizzle (const Vec4i &swizzle)
 Configure the source of texture swizzling for all channels. More...
 
const Vec4igetSwizzle () const
 Gets the source of texture swizzling for all channels. More...
 
void setUseHardwareMipMapGeneration (bool useHardwareMipMapGeneration)
 Sets the hardware mipmap generation hint. More...
 
bool getUseHardwareMipMapGeneration () const
 Gets the hardware mipmap generation hint. More...
 
void setUnRefImageDataAfterApply (bool flag)
 Sets whether or not the apply() function will unreference the image data. More...
 
bool getUnRefImageDataAfterApply () const
 Gets whether or not apply() unreferences image data. More...
 
void setClientStorageHint (bool flag)
 Sets whether to use client storage for the texture, if supported by the graphics system. More...
 
bool getClientStorageHint () const
 Gets whether to use client storage for the texture. More...
 
void setResizeNonPowerOfTwoHint (bool flag)
 Sets whether to force the texture to resize images that have dimensions that are not a power of two. More...
 
bool getResizeNonPowerOfTwoHint () const
 Gets whether texture will force non power to two images to be resized. More...
 
void setInternalFormatMode (InternalFormatMode mode)
 Sets the internal texture format mode. More...
 
InternalFormatMode getInternalFormatMode () const
 Gets the internal texture format mode. More...
 
void setInternalFormat (GLint internalFormat)
 Sets the internal texture format. More...
 
GLint getInternalFormat () const
 Gets the internal texture format. More...
 
bool isCompressedInternalFormat () const
 Return true if the internal format is one of the compressed formats. More...
 
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. More...
 
GLenum getSourceFormat () const
 Gets the external source image format. More...
 
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. More...
 
GLenum getSourceType () const
 Gets the external source data type. More...
 
InternalFormatType getInternalFormatType () const
 Get the internal texture format type. More...
 
TextureObjectgetTextureObject (unsigned int contextID) const
 Returns a pointer to the TextureObject for the current context. More...
 
void setTextureObject (unsigned int contextID, TextureObject *to)
 
void dirtyTextureObject ()
 Forces a recompile on next apply() of associated OpenGL texture objects. More...
 
bool areAllTextureObjectsLoaded () const
 Returns true if the texture objects for all the required graphics contexts are loaded. More...
 
unsigned int & getTextureParameterDirty (unsigned int contextID) const
 Gets the dirty flag for the current contextID. More...
 
void dirtyTextureParameters ()
 Force a reset on next apply() of associated OpenGL texture parameters. More...
 
void allocateMipmapLevels ()
 Force a manual allocation of the mipmap levels on the next apply() call. More...
 
void bindToImageUnit (unsigned int unit, GLenum access, GLenum format=0, int level=0, bool layered=false, int layer=0)
 Bind texture to an image unit (available only if GL version is 4.2 or greater) The format parameter for the image unit need not exactly match the texture internal format, but if it is set to 0, the texture internal format will be used. More...
 
ImageAttachmentgetImageAttachment ()
 
const ImageAttachmentgetImageAttachment () const
 
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. More...
 
bool getShadowComparison () const
 
void setShadowCompareFunc (ShadowCompareFunc func)
 Sets shadow texture comparison function. More...
 
ShadowCompareFunc getShadowCompareFunc () const
 
void setShadowTextureMode (ShadowTextureMode mode)
 Sets shadow texture mode after comparison. More...
 
ShadowTextureMode getShadowTextureMode () const
 
void setShadowAmbient (float shadow_ambient)
 Sets the TEXTURE_COMPARE_FAIL_VALUE_ARB texture parameter. More...
 
float getShadowAmbient () const
 
virtual void setImage (unsigned int face, Image *image)=0
 Sets the texture image for the specified face. More...
 
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. More...
 
virtual const ImagegetImage (unsigned int face) const =0
 Gets the const texture image for specified face. More...
 
virtual unsigned int getNumImages () const =0
 Gets the number of images that can be assigned to this Texture. More...
 
void setReadPBuffer (GraphicsContext *context)
 Set the PBuffer graphics context to read from when using PBuffers for RenderToTexture. More...
 
template<class T >
void setReadPBuffer (const ref_ptr< T > &context)
 
GraphicsContextgetReadPBuffer ()
 Get the PBuffer graphics context to read from when using PBuffers for RenderToTexture. More...
 
const GraphicsContextgetReadPBuffer () const
 Get the const PBuffer graphics context to read from when using PBuffers for RenderToTexture. More...
 
virtual void apply (State &state) const =0
 Texture is a pure virtual base class, apply must be overridden. More...
 
virtual void compileGLObjects (State &state) const
 Calls apply(state) to compile the texture. More...
 
virtual void resizeGLObjectBuffers (unsigned int maxSize)
 Resize any per context GLObject buffers to specified size. More...
 
virtual void releaseGLObjects (State *state=0) const
 If State is non-zero, this function releases OpenGL objects for the specified graphics context. More...
 
void applyTexImage2D_load (State &state, GLenum target, const Image *image, GLsizei width, GLsizei height, GLsizei numMipmapLevels) const
 Helper method. More...
 
void applyTexImage2D_subload (State &state, GLenum target, const Image *image, GLsizei width, GLsizei height, GLint inInternalFormat, GLsizei numMipmapLevels) const
 Helper method. More...
 
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. More...
 
virtual const StateAttributeasStateAttribute () const
 convert 'const this' into a const StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...
 
virtual unsigned int getMember () const
 Return the member identifier within the attribute's class type. More...
 
TypeMemberPair getTypeMemberPair () const
 Return the TypeMemberPair that uniquely identifies this type member. More...
 
virtual int compare (const StateAttribute &sa) const =0
 Return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs. More...
 
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. More...
 
StateSetgetParent (unsigned int i)
 
const StateSetgetParent (unsigned int i) const
 Get a single const parent of this StateAttribute. More...
 
unsigned int getNumParents () const
 Get the number of parents of this StateAttribute. More...
 
void setShaderComponent (ShaderComponent *sc)
 
ShaderComponentgetShaderComponent ()
 
const ShaderComponentgetShaderComponent () const
 
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. More...
 
void setUpdateCallback (StateAttributeCallback *uc)
 Set the UpdateCallback which allows users to attach customize the updating of an object during the update traversal. More...
 
StateAttributeCallbackgetUpdateCallback ()
 Get the non const UpdateCallback. More...
 
const StateAttributeCallbackgetUpdateCallback () const
 Get the const UpdateCallback. More...
 
void setEventCallback (StateAttributeCallback *ec)
 Set the EventCallback which allows users to attach customize the updating of an object during the Event traversal. More...
 
StateAttributeCallbackgetEventCallback ()
 Get the non const EventCallback. More...
 
const StateAttributeCallbackgetEventCallback () const
 Get the const EventCallback. More...
 
- Public Member Functions inherited from osg::Object
 Object ()
 Construct an object. More...
 
 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. More...
 
std::string getCompoundClassName () const
 return the compound class name that combines the library name and class name. More...
 
virtual NodeasNode ()
 Convert 'this' into a Node pointer if Object is a Node, otherwise return 0. More...
 
virtual const NodeasNode () const
 convert 'const this' into a const Node pointer if Object is a Node, otherwise return 0. More...
 
virtual NodeVisitorasNodeVisitor ()
 Convert 'this' into a NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...
 
virtual const NodeVisitorasNodeVisitor () const
 convert 'const this' into a const NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...
 
virtual UniformasUniform ()
 Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0. More...
 
virtual const UniformasUniform () const
 convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0. More...
 
virtual void setThreadSafeRefUnref (bool threadSafe)
 Set whether to use a mutex to ensure ref() and unref() are thread safe. More...
 
virtual void setName (const std::string &name)
 Set the name of object using C++ style string. More...
 
void setName (const char *name)
 Set the name of object using a C style string. More...
 
const std::string & getName () const
 Get the name of object. More...
 
void setDataVariance (DataVariance dv)
 Set the data variance of this object. More...
 
DataVariance getDataVariance () const
 Get the data variance of this object. More...
 
virtual void computeDataVariance ()
 Compute the DataVariance based on an assessment of callback etc. More...
 
void setUserDataContainer (osg::UserDataContainer *udc)
 set the UserDataContainer object. More...
 
template<class T >
void setUserDataContainer (const ref_ptr< T > &udc)
 
osg::UserDataContainergetUserDataContainer ()
 get the UserDataContainer attached to this object. More...
 
const osg::UserDataContainergetUserDataContainer () const
 get the const UserDataContainer attached to this object. More...
 
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. More...
 
virtual void setUserData (Referenced *obj)
 Set user data, data must be subclassed from Referenced to allow automatic memory handling. More...
 
template<class T >
void setUserData (const ref_ptr< T > &ud)
 
virtual ReferencedgetUserData ()
 Get user data. More...
 
virtual const ReferencedgetUserData () const
 Get const user data. More...
 
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. More...
 
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. More...
 
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 More...
 
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 
 Referenced (bool threadSafeRefUnref)
 
 Referenced (const Referenced &)
 
Referencedoperator= (const Referenced &)
 
bool getThreadSafeRefUnref () const
 Get whether a mutex is used to ensure ref() and unref() are thread safe. More...
 
OpenThreads::Mutex * getRefMutex () const
 Get the mutex used to ensure thread safety of ref()/unref(). More...
 
int ref () const
 Increment the reference count by one, indicating that this object has another pointer which is referencing it. More...
 
int unref () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...
 
int unref_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...
 
int referenceCount () const
 Return the number of pointers currently referencing this object. More...
 
ObserverSetgetObserverSet () const
 Get the ObserverSet if one is attached, otherwise return NULL. More...
 
ObserverSetgetOrCreateObserverSet () const
 Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet. More...
 
void addObserver (Observer *observer) const
 Add a Observer that is observing this object, notify the Observer when this object gets deleted. More...
 
void removeObserver (Observer *observer) const
 Remove Observer that is observing this object. More...
 

Static Public Member Functions

static bool isCompressedInternalFormat (GLint internalFormat)
 Determine whether the given internalFormat is a compressed image format. More...
 
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. More...
 
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. More...
 
static void setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
 Set whether reference counting should use a mutex for thread safe reference counting. More...
 
static bool getThreadSafeReferenceCounting ()
 Get whether reference counting is active. More...
 
static void setDeleteHandler (DeleteHandler *handler)
 Set a DeleteHandler to which deletion of all referenced counted objects will be delegated. More...
 
static DeleteHandlergetDeleteHandler ()
 Get a DeleteHandler. More...
 

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. More...
 
void computeRequiredTextureDimensions (State &state, const osg::Image &image, GLsizei &width, GLsizei &height, GLsizei &numMipmapLevels) const
 Computes the texture dimension for the given Image. More...
 
void computeInternalFormatType () const
 Computes the internal format type. More...
 
void applyTexParameters (GLenum target, State &state) const
 Helper method. More...
 
bool isHardwareMipmapGenerationEnabled (const State &state) const
 Returns true if _useHardwareMipMapGeneration is true and either glGenerateMipmapEXT() or GL_GENERATE_MIPMAP_SGIS are supported. More...
 
bool isSafeToUnrefImageData (const State &state) const
 Returns true if the associated Image should be released and it's safe to do so. More...
 
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. More...
 
void mipmapAfterTexImage (State &state, GenerateMipmapMode beforeResult) const
 
void generateMipmap (State &state) const
 Helper method to generate mipmap levels by calling of glGenerateMipmapEXT. More...
 
virtual void allocateMipmap (State &state) const =0
 Allocate mipmap levels of the texture by subsequent calling of glTexImage* function. More...
 
int compareTexture (const Texture &rhs) const
 Returns -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs. More...
 
int compareTextureObjects (const Texture &rhs) const
 Returns -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs. More...
 
- 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. More...
 
- 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
 
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
 
ImageAttachment _imageAttachment
 
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

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

Member Enumeration Documentation

Enumerator
LINEAR 
LINEAR_MIPMAP_LINEAR 
LINEAR_MIPMAP_NEAREST 
NEAREST 
NEAREST_MIPMAP_LINEAR 
NEAREST_MIPMAP_NEAREST 
Enumerator
MIN_FILTER 
MAG_FILTER 

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

Enumerator
GENERATE_MIPMAP_NONE 
GENERATE_MIPMAP 
GENERATE_MIPMAP_TEX_PARAMETER 

Type of access that will be performed on the texture image.

Enumerator
NOT_USED 
READ_ONLY 
WRITE_ONLY 
READ_WRITE 
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 

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)

Enumerator
NEVER 
LESS 
EQUAL 
LEQUAL 
GREATER 
NOTEQUAL 
GEQUAL 
ALWAYS 
Enumerator
LUMINANCE 
INTENSITY 
ALPHA 
Enumerator
CLAMP 
CLAMP_TO_EDGE 
CLAMP_TO_BORDER 
REPEAT 
MIRROR 
Enumerator
WRAP_S 
WRAP_T 
WRAP_R 

Constructor & Destructor Documentation

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

Copy constructor using CopyOp to manage deep vs shallow copy.

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

Member Function Documentation

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

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

bool osg::Texture::areAllTextureObjectsLoaded ( ) const

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

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

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

Reimplemented from osg::StateAttribute.

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.

void osg::Texture::bindToImageUnit ( unsigned int  unit,
GLenum  access,
GLenum  format = 0,
int  level = 0,
bool  layered = false,
int  layer = 0 
)

Bind texture to an image unit (available only if GL version is 4.2 or greater) The format parameter for the image unit need not exactly match the texture internal format, but if it is set to 0, the texture internal format will be used.

See http://www.opengl.org/registry/specs/ARB/shader_image_load_store.txt

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.

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
protectedpure virtual
void osg::Texture::computeInternalFormatType ( ) const
protected

Computes the internal format type.

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

Computes the internal format from Image parameters.

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.

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.

TextureObject* osg::Texture::generateAndAssignTextureObject ( unsigned int  contextID,
GLenum  target 
) const
TextureObject* osg::Texture::generateAndAssignTextureObject ( unsigned int  contextID,
GLenum  target,
GLint  numMipmapLevels,
GLenum  internalFormat,
GLsizei  width,
GLsizei  height,
GLsizei  depth,
GLint  border 
) const
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 osg::ref_ptr<TextureObject> osg::Texture::generateTextureObject ( const Texture texture,
unsigned int  contextID,
GLenum  target 
)
static
static 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
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.

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

Gets the texture filter mode.

virtual Image* osg::Texture::getImage ( unsigned int  face)
pure virtual
virtual const Image* osg::Texture::getImage ( unsigned int  face) const
pure virtual
ImageAttachment& osg::Texture::getImageAttachment ( )
inline
const ImageAttachment& osg::Texture::getImageAttachment ( ) const
inline
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.

virtual bool osg::Texture::getModeUsage ( StateAttribute::ModeUsage ) const
inlinevirtual

Return the modes associated with this StateAttribute.

Reimplemented from osg::StateAttribute.

Reimplemented in osg::Texture2DMultisample, and osg::Texture2DArray.

virtual unsigned int osg::Texture::getNumImages ( ) const
pure virtual
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
bool osg::Texture::getShadowComparison ( ) 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.

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

Gets the source of texture swizzling for all channels.

virtual int osg::Texture::getTextureDepth ( ) const
inlinevirtual
virtual int osg::Texture::getTextureHeight ( ) const
inlinevirtual
TextureObject* osg::Texture::getTextureObject ( unsigned int  contextID) const
inline

Returns a pointer to the TextureObject for the current context.

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
virtual int osg::Texture::getTextureWidth ( ) const
inlinevirtual
virtual Type osg::Texture::getType ( ) const
inlinevirtual

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.

bool osg::Texture::isCompressedInternalFormat ( ) const

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

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

Determine whether the given internalFormat is a compressed image format.

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.

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.

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.

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.

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

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

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
template<class T >
void osg::Texture::setImage ( unsigned int  face,
const ref_ptr< T > &  image 
)
inline
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.

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

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

template<class T >
void osg::Texture::setReadPBuffer ( const ref_ptr< T > &  context)
inline
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::setSwizzle ( const Vec4i swizzle)
inline

Configure the source of texture swizzling for all channels.

void osg::Texture::setTextureObject ( unsigned int  contextID,
TextureObject to 
)
inline
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.

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.

Member Data Documentation

Vec4d osg::Texture::_borderColor
protected
GLint osg::Texture::_borderWidth
protected
bool osg::Texture::_clientStorageHint
protected
ImageAttachment osg::Texture::_imageAttachment
protected
GLint osg::Texture::_internalFormat
mutableprotected
InternalFormatMode osg::Texture::_internalFormatMode
protected
InternalFormatType osg::Texture::_internalFormatType
mutableprotected
FilterMode osg::Texture::_mag_filter
protected
float osg::Texture::_maxAnisotropy
protected
FilterMode osg::Texture::_min_filter
protected
ref_ptr<GraphicsContext> osg::Texture::_readPBuffer
mutableprotected
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
mutableprotected
GLenum osg::Texture::_sourceType
mutableprotected
Vec4i osg::Texture::_swizzle
protected
TexParameterDirtyList osg::Texture::_texMipmapGenerationDirtyList
mutableprotected
TexParameterDirtyList osg::Texture::_texParametersDirtyList
mutableprotected
TextureObjectBuffer osg::Texture::_textureObjectBuffer
mutableprotected
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

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

osg logo
Generated at Wed Nov 11 2015 22:14:44 for the OpenSceneGraph by doxygen 1.8.10.