Encapsulates OpenGL 3D texture functionality. More...

Inheritance diagram for osg::Texture3D:

Classes
class	SubloadCallback

Public Member Functions
	Texture3D ()

	Texture3D (Image *image)

template<class T >
	Texture3D (const osg::ref_ptr< T > &image)

	Texture3D (const Texture3D &text, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
	Copy constructor using CopyOp to manage deep vs shallow copy. More...

	META_StateAttribute (osg, Texture3D, TEXTURE)

virtual int	compare (const StateAttribute &rhs) const
	Return -1 if this < rhs, 0 if this==rhs, 1 if this>rhs. More...

virtual GLenum	getTextureTarget () const

void	setImage (Image *image)
	Sets the texture image. More...

template<class T >
void	setImage (const ref_ptr< T > &image)

Image *	getImage ()
	Gets the texture image. More...

const Image *	getImage () const
	Gets the const texture image. More...

virtual bool	isDirty (unsigned int contextID) const
	return true if the texture image data has been modified and the associated GL texture object needs to be updated. More...

unsigned int &	getModifiedCount (unsigned int contextID) const

virtual void	setImage (unsigned int, Image *image)
	Sets the texture image, ignoring face. More...

virtual Image *	getImage (unsigned int)
	Gets the texture image, ignoring face. More...

virtual const Image *	getImage (unsigned int) const
	Gets the const texture image, ignoring face. More...

virtual unsigned int	getNumImages () const
	Gets the number of images that can be assigned to the Texture. More...

void	setTextureSize (int width, int height, int depth) const
	Sets the texture width, height, and depth. More...

void	getTextureSize (int &width, int &height, int &depth) const
	Gets the texture subload width. More...

void	setTextureWidth (int width)

void	setTextureHeight (int height)

void	setTextureDepth (int depth)

virtual int	getTextureWidth () const

virtual int	getTextureHeight () const

virtual int	getTextureDepth () const

void	setSubloadCallback (SubloadCallback *cb)

SubloadCallback *	getSubloadCallback ()

const SubloadCallback *	getSubloadCallback () const

void	setNumMipmapLevels (unsigned int num) const
	Helper function. More...

unsigned int	getNumMipmapLevels () const
	Gets the number of mipmap levels created. More...

void	copyTexSubImage3D (State &state, int xoffset, int yoffset, int zoffset, int x, int y, int width, int height)
	Copies a two-dimensional texture subimage, as per glCopyTexSubImage3D. More...

virtual void	apply (State &state) const
	Bind the texture object. More...

Public Member Functions inherited from osg::Texture
	Texture ()

	Texture (const Texture &text, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
	Copy constructor using CopyOp to manage deep vs shallow copy. More...

virtual osg::Object *	cloneType () const =0
	Clone the type of an attribute, with Object* return type. More...

virtual osg::Object *	clone (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 Texture *	asTexture ()
	Fast alternative to dynamic_cast<> for determining if state attribute is a Texture. More...

virtual const Texture *	asTexture () 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...

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 Vec4d &	getBorderColor () 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	setMinLOD (float minlod)
	Sets the minimum level of detail value. More...

float	getMinLOD () const
	Gets the minimum level of detail value. More...

void	setMaxLOD (float maxlod)
	Sets the maximum level of detail value. More...

float	getMaxLOD () const
	Gets the maximum level of detail value. More...

void	setLODBias (float lodbias)
	Gets the level of detail bias value. More...

float	getLODBias () const
	Sets the level of detail bias value. More...

void	setSwizzle (const Vec4i &swizzle)
	Configure the source of texture swizzling for all channels. More...

const Vec4i &	getSwizzle () 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...

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

TextureObject *	getTextureObject (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	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

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

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)

GraphicsContext *	getReadPBuffer ()
	Get the PBuffer graphics context to read from when using PBuffers for RenderToTexture. More...

const GraphicsContext *	getReadPBuffer () const
	Get the const PBuffer graphics context to read from when using PBuffers for RenderToTexture. 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...

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

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

Public Member Functions inherited from osg::TextureAttribute
	TextureAttribute ()

	TextureAttribute (const TextureAttribute &ta, const CopyOp &copyop=CopyOp::SHALLOW_COPY)

virtual unsigned int	getMember () const
	Return the member identifier within the attribute's class type. More...

Public Member Functions inherited from osg::StateAttribute
	StateAttribute ()

	StateAttribute (const StateAttribute &sa, const CopyOp &copyop=CopyOp::SHALLOW_COPY)

virtual StateAttribute *	asStateAttribute ()
	Convert 'this' into a StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...

virtual const StateAttribute *	asStateAttribute () const
	convert 'const this' into a const StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...

TypeMemberPair	getTypeMemberPair () const
	Return the TypeMemberPair that uniquely identifies this type member. More...

bool	operator< (const StateAttribute &rhs) const

bool	operator== (const StateAttribute &rhs) const

bool	operator!= (const StateAttribute &rhs) const

const ParentList &	getParents () const
	Get the parent list of this StateAttribute. More...

StateSet *	getParent (unsigned int i)

const StateSet *	getParent (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)

ShaderComponent *	getShaderComponent ()

const ShaderComponent *	getShaderComponent () const

virtual bool	getModeUsage (ModeUsage &) const
	Return the modes associated with this StateAttribute. More...

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

StateAttributeCallback *	getUpdateCallback ()
	Get the non const UpdateCallback. More...

const StateAttributeCallback *	getUpdateCallback () 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...

StateAttributeCallback *	getEventCallback ()
	Get the non const EventCallback. More...

const StateAttributeCallback *	getEventCallback () 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 Node *	asNode ()
	Convert 'this' into a Node pointer if Object is a Node, otherwise return 0. More...

virtual const Node *	asNode () const
	convert 'const this' into a const Node pointer if Object is a Node, otherwise return 0. More...

virtual NodeVisitor *	asNodeVisitor ()
	Convert 'this' into a NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...

virtual const NodeVisitor *	asNodeVisitor () const
	convert 'const this' into a const NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...

virtual StateSet *	asStateSet ()
	Convert 'this' into a StateSet pointer if Object is a StateSet, otherwise return 0. More...

virtual const StateSet *	asStateSet () const
	convert 'const this' into a const StateSet pointer if Object is a StateSet, otherwise return 0. More...

virtual Uniform *	asUniform ()
	Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0. More...

virtual const UniformBase *	asUniformBase () const
	convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0. More...

virtual UniformBase *	asUniformBase ()
	Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0. More...

virtual const Uniform *	asUniform () const
	convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0. More...

virtual Camera *	asCamera ()
	Convert 'this' into a Camera pointer if Node is a Camera, otherwise return 0. More...

virtual const Camera *	asCamera () const
	convert 'const this' into a const Camera pointer if Node is a Camera, otherwise return 0. More...

virtual Drawable *	asDrawable ()
	Convert 'this' into a Drawable pointer if Object is a Drawable, otherwise return 0. More...

virtual const Drawable *	asDrawable () const
	convert 'const this' into a const Drawable pointer if Object is a Drawable, otherwise return 0. More...

virtual Callback *	asCallback ()
	Convert 'this' into a Callback pointer if Object is a Callback, otherwise return 0. More...

virtual const Callback *	asCallback () const
	convert 'const this' into a const Callback pointer if Object is a Callback, otherwise return 0. More...

virtual CallbackObject *	asCallbackObject ()
	Convert 'this' into a CallbackObject pointer if Object is a CallbackObject, otherwise return 0. More...

virtual const CallbackObject *	asCallbackObject () const
	convert 'const this' into a const CallbackObject pointer if Object is a CallbackObject, otherwise return 0. More...

virtual UserDataContainer *	asUserDataContainer ()
	Convert 'this' into a UserDataContainer pointer if Object is a UserDataContainer, otherwise return 0. More...

virtual const UserDataContainer *	asUserDataContainer () const
	convert 'const this' into a const UserDataContainer pointer if Object is a UserDataContainer, otherwise return 0. More...

virtual ValueObject *	asValueObject ()
	Convert 'this' into a ValueObject pointer if Object is a ValueObject, otherwise return 0. More...

virtual const ValueObject *	asValueObject () const
	Convert 'this' into a ValueObject pointer if Object is a ValueObject, otherwise return 0. More...

virtual Image *	asImage ()
	Convert 'this' into a Image pointer if Object is a Image, otherwise return 0. More...

virtual const Image *	asImage () const
	Convert 'this' into a Image pointer if Object is a Image, 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::UserDataContainer *	getUserDataContainer ()
	get the UserDataContainer attached to this object. More...

const osg::UserDataContainer *	getUserDataContainer () const
	get the const UserDataContainer attached to this object. More...

osg::UserDataContainer *	getOrCreateUserDataContainer ()
	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 Referenced *	getUserData ()
	Get user data. More...

virtual const Referenced *	getUserData () 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)
	Deprecated, Referenced is now always uses thread safe ref/unref, use default Referenced() constructor instead. More...

	Referenced (const Referenced &)

Referenced &	operator= (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...

ObserverSet *	getObserverSet () const
	Get the ObserverSet if one is attached, otherwise return NULL. More...

ObserverSet *	getOrCreateObserverSet () 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...

Protected Types
typedef buffered_value< unsigned int >	ImageModifiedCount

Protected Types inherited from osg::Texture
typedef buffered_value< unsigned int >	TexParameterDirtyList

typedef buffered_object< ref_ptr< TextureObject > >	TextureObjectBuffer

Protected Member Functions
virtual	~Texture3D ()

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

virtual void	computeInternalFormat () const

void	allocateMipmap (State &state) const
	Allocate mipmap levels of the texture by subsequent calling of glTexImage* function. More...

void	applyTexImage3D (GLenum target, Image *image, State &state, GLsizei &inwidth, GLsizei &inheight, GLsizei &indepth, GLsizei &numMipmapLevels) const

Protected Member Functions inherited from osg::Texture
virtual	~Texture ()

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

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::TextureAttribute
virtual	~TextureAttribute ()

virtual void	setTextureUnit (unsigned int unit)

virtual void	configureUniformNames ()

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
ref_ptr< Image >	_image
	It's not ideal that _image is mutable, but it's required since Image::ensureDimensionsArePowerOfTwo() can only be called in a valid OpenGL context, and therefore within Texture::apply, which is const. More...

GLsizei	_textureWidth
	Subloaded images can have different texture and image sizes. More...

GLsizei	_textureHeight

GLsizei	_textureDepth

GLsizei	_numMipmapLevels
	Number of mip map levels the texture has been created with,. More...

ref_ptr< SubloadCallback >	_subloadCallback

ImageModifiedCount	_modifiedCount

Protected Attributes inherited from osg::Texture
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::TextureAttribute
unsigned int	_textureUnit

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

Additional Inherited Members
Public Types inherited from osg::Texture
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) 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 }

Static Public Member Functions inherited from osg::Texture
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< TextureObject >	generateTextureObject (const Texture *texture, unsigned int contextID, GLenum target)

static osg::ref_ptr< TextureObject >	generateTextureObject (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	setDeleteHandler (DeleteHandler *handler)
	Set a DeleteHandler to which deletion of all referenced counted objects will be delegated. More...

static DeleteHandler *	getDeleteHandler ()
	Get a DeleteHandler. More...

Detailed Description

Encapsulates OpenGL 3D texture functionality.

Doesn't support cube maps, so ignore face parameters.

Member Typedef Documentation

◆ ImageModifiedCount

typedef buffered_value<unsigned int> osg::Texture3D::ImageModifiedCount

protected

Constructor & Destructor Documentation

◆ Texture3D() [1/4]

osg::Texture3D::Texture3D ( )

◆ Texture3D() [2/4]

osg::Texture3D::Texture3D ( Image * image )

◆ Texture3D() [3/4]

template<class T >

osg::Texture3D::Texture3D ( const osg::ref_ptr< T > & image )

inline

References osg::ref_ptr< T >::get(), META_StateAttribute, and osg::CopyOp::SHALLOW_COPY.

◆ Texture3D() [4/4]

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

Copy constructor using CopyOp to manage deep vs shallow copy.

◆ ~Texture3D()

virtual osg::Texture3D::~Texture3D ( )

protectedvirtual

Member Function Documentation

◆ allocateMipmap()

void osg::Texture3D::allocateMipmap ( State & state ) const

protectedvirtual

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

Implements osg::Texture.

◆ apply()

virtual void osg::Texture3D::apply ( State & state ) const

virtual

Bind the texture object.

If the texture object hasn't already been compiled, create the texture mipmap levels.

Implements osg::Texture.

◆ applyTexImage3D()

void osg::Texture3D::applyTexImage3D	(	GLenum	target,
		Image *	image,
		State &	state,
		GLsizei &	inwidth,
		GLsizei &	inheight,
		GLsizei &	indepth,
		GLsizei &	numMipmapLevels
	)		const

protected

◆ compare()

virtual int osg::Texture3D::compare ( const StateAttribute & rhs ) const

virtual

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

Implements osg::StateAttribute.

◆ computeInternalFormat()

virtual void osg::Texture3D::computeInternalFormat ( ) const

protectedvirtual

Implements osg::Texture.

◆ computeRequiredTextureDimensions()

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

protected

◆ copyTexSubImage3D()

void osg::Texture3D::copyTexSubImage3D	(	State &	state,
		int	xoffset,
		int	yoffset,
		int	zoffset,
		int	x,
		int	y,
		int	width,
		int	height
	)

Copies a two-dimensional texture subimage, as per glCopyTexSubImage3D.

Updates a portion of an existing OpenGL texture object from the current OpenGL background framebuffer contents at position x, y with width width and height height. Loads framebuffer data into the texture using offsets xoffset, yoffset, and zoffset. width and height must be powers of two.

◆ getImage() [1/4]

Image* osg::Texture3D::getImage ( )

inline

Gets the texture image.

◆ getImage() [2/4]

const Image* osg::Texture3D::getImage ( ) const

inline

Gets the const texture image.

◆ getImage() [3/4]

virtual Image* osg::Texture3D::getImage ( unsigned int )

inlinevirtual

Gets the texture image, ignoring face.

Implements osg::Texture.

◆ getImage() [4/4]

virtual const Image* osg::Texture3D::getImage ( unsigned int ) const

inlinevirtual

Gets the const texture image, ignoring face.

Implements osg::Texture.

◆ getModifiedCount()

unsigned int& osg::Texture3D::getModifiedCount ( unsigned int contextID ) const

inline

◆ getNumImages()

virtual unsigned int osg::Texture3D::getNumImages ( ) const

inlinevirtual

Gets the number of images that can be assigned to the Texture.

Implements osg::Texture.

◆ getNumMipmapLevels()

unsigned int osg::Texture3D::getNumMipmapLevels ( ) const

inline

Gets the number of mipmap levels created.

◆ getSubloadCallback() [1/2]

SubloadCallback* osg::Texture3D::getSubloadCallback ( )

inline

◆ getSubloadCallback() [2/2]

const SubloadCallback* osg::Texture3D::getSubloadCallback ( ) const

inline

◆ getTextureDepth()

virtual int osg::Texture3D::getTextureDepth ( ) const

inlinevirtual

Reimplemented from osg::Texture.

◆ getTextureHeight()

virtual int osg::Texture3D::getTextureHeight ( ) const

inlinevirtual

Reimplemented from osg::Texture.

◆ getTextureSize()

void osg::Texture3D::getTextureSize	(	int &	width,
		int &	height,
		int &	depth
	)		const

inline

Gets the texture subload width.

◆ getTextureTarget()

virtual GLenum osg::Texture3D::getTextureTarget ( ) const

inlinevirtual

Implements osg::Texture.

References GL_TEXTURE_3D.

◆ getTextureWidth()

virtual int osg::Texture3D::getTextureWidth ( ) const

inlinevirtual

Reimplemented from osg::Texture.

◆ isDirty()

virtual bool osg::Texture3D::isDirty ( unsigned int contextID ) const

inlinevirtual

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

Reimplemented from osg::Texture.

◆ META_StateAttribute()

osg::Texture3D::META_StateAttribute	(	osg	,
		Texture3D	,
		TEXTURE
	)

◆ setImage() [1/3]

void osg::Texture3D::setImage ( Image * image )

Sets the texture image.

◆ setImage() [2/3]

template<class T >

void osg::Texture3D::setImage ( const ref_ptr< T > & image )

inline

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

Referenced by setImage().

◆ setImage() [3/3]

virtual void osg::Texture3D::setImage	(	unsigned int	,
		Image *	image
	)

inlinevirtual

Sets the texture image, ignoring face.

Implements osg::Texture.

References setImage().

Referenced by setImage().

◆ setNumMipmapLevels()

void osg::Texture3D::setNumMipmapLevels ( unsigned int num ) const

inline

Helper function.

Sets the number of mipmap levels created for this texture. Should only be called within an osg::Texture::apply(), or during a custom OpenGL texture load.

◆ setSubloadCallback()

void osg::Texture3D::setSubloadCallback ( SubloadCallback * cb )

inline

◆ setTextureDepth()

void osg::Texture3D::setTextureDepth ( int depth )

inline

◆ setTextureHeight()

void osg::Texture3D::setTextureHeight ( int height )

inline

◆ setTextureSize()

void osg::Texture3D::setTextureSize	(	int	width,
		int	height,
		int	depth
	)		const

inline

Sets the texture width, height, and depth.

If width, height, or depth are zero, calculate the respective value from the source image size.

◆ setTextureWidth()

void osg::Texture3D::setTextureWidth ( int width )

inline

Member Data Documentation

◆ _image

ref_ptr<Image> osg::Texture3D::_image

mutableprotected

It's not ideal that _image is mutable, but it's required since Image::ensureDimensionsArePowerOfTwo() can only be called in a valid OpenGL context, and therefore within Texture::apply, which is const.

◆ _modifiedCount

ImageModifiedCount osg::Texture3D::_modifiedCount

mutableprotected

◆ _numMipmapLevels

GLsizei osg::Texture3D::_numMipmapLevels

mutableprotected

Number of mip map levels the texture has been created with,.

◆ _subloadCallback

ref_ptr<SubloadCallback> osg::Texture3D::_subloadCallback

protected

◆ _textureDepth

GLsizei osg::Texture3D::_textureDepth

mutableprotected

◆ _textureHeight

GLsizei osg::Texture3D::_textureHeight

mutableprotected

◆ _textureWidth

GLsizei osg::Texture3D::_textureWidth

mutableprotected

Subloaded images can have different texture and image sizes.

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

osg/Texture3D

Classes

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ImageModifiedCount

Constructor & Destructor Documentation

◆ Texture3D() [1/4]

◆ Texture3D() [2/4]

◆ Texture3D() [3/4]

◆ Texture3D() [4/4]

◆ ~Texture3D()

Member Function Documentation

◆ allocateMipmap()

◆ apply()

◆ applyTexImage3D()

◆ compare()

◆ computeInternalFormat()

◆ computeRequiredTextureDimensions()

◆ copyTexSubImage3D()

◆ getImage() [1/4]

◆ getImage() [2/4]

◆ getImage() [3/4]

◆ getImage() [4/4]

◆ getModifiedCount()

◆ getNumImages()

◆ getNumMipmapLevels()

◆ getSubloadCallback() [1/2]

◆ getSubloadCallback() [2/2]

◆ getTextureDepth()

◆ getTextureHeight()

◆ getTextureSize()

◆ getTextureTarget()

◆ getTextureWidth()

◆ isDirty()

◆ META_StateAttribute()

◆ setImage() [1/3]

◆ setImage() [2/3]

◆ setImage() [3/3]

◆ setNumMipmapLevels()

◆ setSubloadCallback()

◆ setTextureDepth()

◆ setTextureHeight()

◆ setTextureSize()

◆ setTextureWidth()

Member Data Documentation

◆ _image

◆ _modifiedCount

◆ _numMipmapLevels

◆ _subloadCallback

◆ _textureDepth

◆ _textureHeight

◆ _textureWidth