#include <Texture.h>

Inheritance diagram for osg::Texture:

Collaboration diagram for osg::Texture:

Classes
struct	ImageAttachment

class	TextureObject

class	TextureObjectManager

class	TextureObjectSet

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 }

enum	ImageAccess { NOT_USED = 0, READ_ONLY = GL_READ_ONLY_ARB, WRITE_ONLY = GL_WRITE_ONLY_ARB, READ_WRITE = GL_READ_WRITE_ARB }

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 }

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 }

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 }

typedef GLenum	GLMode

typedef unsigned int	GLModeValue

typedef unsigned int	OverrideValue

typedef std::pair< Type, unsigned int >	TypeMemberPair

typedef std::vector< StateSet * >	ParentList

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)

virtual osg::Object *	cloneType () const =0

virtual osg::Object *	clone (const CopyOp &copyop) const =0

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

virtual const char *	libraryName () const

virtual const char *	className () const

virtual Texture *	asTexture ()

virtual const Texture *	asTexture () const

virtual Type	getType () const

virtual bool	isTextureAttribute () const

virtual GLenum	getTextureTarget () const =0

virtual bool	getModeUsage (StateAttribute::ModeUsage &usage) const

virtual int	getTextureWidth () const

virtual int	getTextureHeight () const

virtual int	getTextureDepth () const

void	setWrap (WrapParameter which, WrapMode wrap)

WrapMode	getWrap (WrapParameter which) const

void	setBorderColor (const Vec4d &color)

const Vec4d &	getBorderColor () const

void	setBorderWidth (GLint width)

GLint	getBorderWidth () const

void	setFilter (FilterParameter which, FilterMode filter)

FilterMode	getFilter (FilterParameter which) const

void	setMaxAnisotropy (float anis)

float	getMaxAnisotropy () const

void	setSwizzle (const Vec4i &swizzle)

const Vec4i &	getSwizzle () const

void	setUseHardwareMipMapGeneration (bool useHardwareMipMapGeneration)

bool	getUseHardwareMipMapGeneration () const

void	setUnRefImageDataAfterApply (bool flag)

bool	getUnRefImageDataAfterApply () const

void	setClientStorageHint (bool flag)

bool	getClientStorageHint () const

void	setResizeNonPowerOfTwoHint (bool flag)

bool	getResizeNonPowerOfTwoHint () const

void	setInternalFormatMode (InternalFormatMode mode)

InternalFormatMode	getInternalFormatMode () const

void	setInternalFormat (GLint internalFormat)

GLint	getInternalFormat () const

bool	isCompressedInternalFormat () const

void	setSourceFormat (GLenum sourceFormat)

GLenum	getSourceFormat () const

void	setSourceType (GLenum sourceType)

GLenum	getSourceType () const

InternalFormatType	getInternalFormatType () const

TextureObject *	getTextureObject (unsigned int contextID) const

void	setTextureObject (unsigned int contextID, TextureObject *to)

void	dirtyTextureObject ()

bool	areAllTextureObjectsLoaded () const

unsigned int &	getTextureParameterDirty (unsigned int contextID) const

void	dirtyTextureParameters ()

void	allocateMipmapLevels ()

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

ImageAttachment &	getImageAttachment ()

const ImageAttachment &	getImageAttachment () const

void	setShadowComparison (bool flag)

bool	getShadowComparison () const

void	setShadowCompareFunc (ShadowCompareFunc func)

ShadowCompareFunc	getShadowCompareFunc () const

void	setShadowTextureMode (ShadowTextureMode mode)

ShadowTextureMode	getShadowTextureMode () const

void	setShadowAmbient (float shadow_ambient)

float	getShadowAmbient () const

virtual void	setImage (unsigned int face, Image *image)=0

virtual Image *	getImage (unsigned int face)=0

virtual const Image *	getImage (unsigned int face) const =0

virtual unsigned int	getNumImages () const =0

void	setReadPBuffer (GraphicsContext *context)

GraphicsContext *	getReadPBuffer ()

const GraphicsContext *	getReadPBuffer () const

virtual void	apply (State &state) const =0

virtual void	compileGLObjects (State &state) const

virtual void	resizeGLObjectBuffers (unsigned int maxSize)

virtual void	releaseGLObjects (State *state=0) const

void	applyTexImage2D_load (State &state, GLenum target, const Image *image, GLsizei width, GLsizei height, GLsizei numMipmapLevels) const

void	applyTexImage2D_subload (State &state, GLenum target, const Image *image, GLsizei width, GLsizei height, GLint inInternalFormat, GLsizei numMipmapLevels) const

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::StateAttribute
	StateAttribute ()

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

virtual StateAttribute *	asStateAttribute ()

virtual const StateAttribute *	asStateAttribute () const

virtual unsigned int	getMember () const

TypeMemberPair	getTypeMemberPair () const

virtual int	compare (const StateAttribute &sa) const =0

bool	operator< (const StateAttribute &rhs) const

bool	operator== (const StateAttribute &rhs) const

bool	operator!= (const StateAttribute &rhs) const

const ParentList &	getParents () const

StateSet *	getParent (unsigned int i)

const StateSet *	getParent (unsigned int i) const

unsigned int	getNumParents () const

void	setShaderComponent (ShaderComponent *sc)

ShaderComponent *	getShaderComponent ()

const ShaderComponent *	getShaderComponent () const

virtual bool	checkValidityOfAssociatedModes (osg::State &) const

void	setUpdateCallback (StateAttributeCallback *uc)

StateAttributeCallback *	getUpdateCallback ()

const StateAttributeCallback *	getUpdateCallback () const

void	setEventCallback (StateAttributeCallback *ec)

StateAttributeCallback *	getEventCallback ()

const StateAttributeCallback *	getEventCallback () const

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

	Object (bool threadSafeRefUnref)

	Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)

std::string	getCompoundClassName () const

virtual Node *	asNode ()

virtual const Node *	asNode () const

virtual NodeVisitor *	asNodeVisitor ()

virtual const NodeVisitor *	asNodeVisitor () const

virtual Uniform *	asUniform ()

virtual const Uniform *	asUniform () const

virtual void	setThreadSafeRefUnref (bool threadSafe)

virtual void	setName (const std::string &name)

void	setName (const char *name)

const std::string &	getName () const

void	setDataVariance (DataVariance dv)

DataVariance	getDataVariance () const

virtual void	computeDataVariance ()

void	setUserDataContainer (osg::UserDataContainer *udc)

osg::UserDataContainer *	getUserDataContainer ()

const osg::UserDataContainer *	getUserDataContainer () const

osg::UserDataContainer *	getOrCreateUserDataContainer ()

virtual void	setUserData (Referenced *obj)

virtual Referenced *	getUserData ()

virtual const Referenced *	getUserData () const

template<typename T >
bool	getUserValue (const std::string &name, T &value) const

template<typename T >
void	setUserValue (const std::string &name, const T &value)

template<typename T >
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject BoundingBoxdValueObject BoundingSpheredValueObject bool	getUserValue (const std::string &name, T &value) const

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

	Referenced (bool threadSafeRefUnref)

	Referenced (const Referenced &)

Referenced &	operator= (const Referenced &)

bool	getThreadSafeRefUnref () const

OpenThreads::Mutex *	getRefMutex () const

int	ref () const

int	unref () const

int	unref_nodelete () const

int	referenceCount () const

ObserverSet *	getObserverSet () const

ObserverSet *	getOrCreateObserverSet () const

void	addObserver (Observer *observer) const

void	removeObserver (Observer *observer) const

Static Public Member Functions
static bool	isCompressedInternalFormat (GLint internalFormat)

static void	getCompressedSize (GLenum internalFormat, GLint width, GLint height, GLint depth, GLint &blockSize, GLint &size)

static osg::ref_ptr < Texture::TextureObjectManager > &	getTextureObjectManager (unsigned int contextID)

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 void	deleteAllTextureObjects (unsigned int contextID)

static void	discardAllTextureObjects (unsigned int contextID)

static void	flushAllDeletedTextureObjects (unsigned int contextID)

static void	discardAllDeletedTextureObjects (unsigned int contextID)

static void	flushDeletedTextureObjects (unsigned int contextID, double currentTime, double &availableTime)

static void	releaseTextureObject (unsigned int contextID, TextureObject *to)

Static Public Member Functions inherited from osg::Referenced
static OpenThreads::Mutex *	getGlobalReferencedMutex ()

static void	setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)

static bool	getThreadSafeReferenceCounting ()

static void	setDeleteHandler (DeleteHandler *handler)

static DeleteHandler *	getDeleteHandler ()

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

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

void	computeInternalFormatType () const

void	applyTexParameters (GLenum target, State &state) const

bool	isHardwareMipmapGenerationEnabled (const State &state) const

bool	isSafeToUnrefImageData (const State &state) const

GenerateMipmapMode	mipmapBeforeTexImage (const State &state, bool hardwareMipmapOn) const

void	mipmapAfterTexImage (State &state, GenerateMipmapMode beforeResult) const

void	generateMipmap (State &state) const

virtual void	allocateMipmap (State &state) const =0

int	compareTexture (const Texture &rhs) const

int	compareTextureObjects (const Texture &rhs) const

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

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.

Definition at line 414 of file Texture.h.

Member Typedef Documentation

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

protected

Definition at line 851 of file Texture.h.

typedef buffered_object< ref_ptr<TextureObject> > osg::Texture::TextureObjectBuffer

protected

Definition at line 1266 of file Texture.h.

typedef std::list< ref_ptr<TextureObject> > osg::Texture::TextureObjectList

Definition at line 1087 of file Texture.h.

Member Enumeration Documentation

enum osg::Texture::FilterMode

Enumerator
LINEAR
LINEAR_MIPMAP_LINEAR
LINEAR_MIPMAP_NEAREST
NEAREST
NEAREST_MIPMAP_LINEAR
NEAREST_MIPMAP_NEAREST

Definition at line 492 of file Texture.h.

enum osg::Texture::FilterParameter

Enumerator
MIN_FILTER
MAG_FILTER

Definition at line 487 of file Texture.h.

enum osg::Texture::GenerateMipmapMode

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

Enumerator
GENERATE_MIPMAP_NONE
GENERATE_MIPMAP
GENERATE_MIPMAP_TEX_PARAMETER

Definition at line 799 of file Texture.h.

enum osg::Texture::ImageAccess

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

Enumerator
NOT_USED
READ_ONLY
WRITE_ONLY
READ_WRITE

Definition at line 687 of file Texture.h.

enum osg::Texture::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

Definition at line 556 of file Texture.h.

enum osg::Texture::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)

Definition at line 612 of file Texture.h.

enum osg::Texture::ShadowCompareFunc

Enumerator
NEVER
LESS
EQUAL
LEQUAL
GREATER
NOTEQUAL
GEQUAL
ALWAYS

Definition at line 709 of file Texture.h.

enum osg::Texture::ShadowTextureMode

Enumerator
LUMINANCE
INTENSITY
ALPHA

Definition at line 724 of file Texture.h.

enum osg::Texture::WrapMode

Enumerator
CLAMP
CLAMP_TO_EDGE
CLAMP_TO_BORDER
REPEAT
MIRROR

Definition at line 460 of file Texture.h.

enum osg::Texture::WrapParameter

Enumerator
WRAP_S
WRAP_T
WRAP_R

Definition at line 454 of file Texture.h.

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::Texture1D, osg::Texture2DArray, osg::TextureRectangle, 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

Texture is a pure virtual base class, apply must be overridden.

Reimplemented from osg::StateAttribute.

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

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.

Definition at line 431 of file Texture.h.

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.

Definition at line 434 of file Texture.h.

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.

Definition at line 428 of file Texture.h.

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

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

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.

static void osg::Texture::deleteAllTextureObjects ( unsigned int contextID )

static

void osg::Texture::dirtyTextureObject ( )

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

void osg::Texture::dirtyTextureParameters ( )

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

static void osg::Texture::discardAllDeletedTextureObjects ( unsigned int contextID )

static

static void osg::Texture::discardAllTextureObjects ( unsigned int contextID )

static

static void osg::Texture::flushAllDeletedTextureObjects ( unsigned int contextID )

static

static void osg::Texture::flushDeletedTextureObjects	(	unsigned int	contextID,
		double	currentTime,
		double &	availableTime
	)

static

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

Here is the caller graph for this function:

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.

Definition at line 480 of file Texture.h.

GLint osg::Texture::getBorderWidth ( ) const

inline

Definition at line 485 of file Texture.h.

bool osg::Texture::getClientStorageHint ( ) const

inline

Gets whether to use client storage for the texture.

Definition at line 545 of file Texture.h.

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

Gets the texture image for the specified face.

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

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

pure virtual

Gets the const texture image for specified face.

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

ImageAttachment& osg::Texture::getImageAttachment ( )

inline

Definition at line 701 of file Texture.h.

const ImageAttachment& osg::Texture::getImageAttachment ( ) const

inline

Definition at line 702 of file Texture.h.

GLint osg::Texture::getInternalFormat ( ) const

inline

Gets the internal texture format.

Definition at line 594 of file Texture.h.

InternalFormatMode osg::Texture::getInternalFormatMode ( ) const

inline

Gets the internal texture format mode.

Definition at line 580 of file Texture.h.

InternalFormatType osg::Texture::getInternalFormatType ( ) const

inline

Get the internal texture format type.

Definition at line 628 of file Texture.h.

float osg::Texture::getMaxAnisotropy ( ) const

inline

Gets the maximum anisotropy value.

Definition at line 515 of file Texture.h.

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.

Definition at line 442 of file Texture.h.

Here is the call graph for this function:

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

pure virtual

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

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

GraphicsContext* osg::Texture::getReadPBuffer ( )

inline

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

Definition at line 757 of file Texture.h.

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

inline

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

Definition at line 760 of file Texture.h.

bool osg::Texture::getResizeNonPowerOfTwoHint ( ) const

inline

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

Definition at line 554 of file Texture.h.

float osg::Texture::getShadowAmbient ( ) const

inline

Definition at line 737 of file Texture.h.

ShadowCompareFunc osg::Texture::getShadowCompareFunc ( ) const

inline

Definition at line 722 of file Texture.h.

bool osg::Texture::getShadowComparison ( ) const

inline

Definition at line 707 of file Texture.h.

ShadowTextureMode osg::Texture::getShadowTextureMode ( ) const

inline

Definition at line 732 of file Texture.h.

GLenum osg::Texture::getSourceFormat ( ) const

inline

Gets the external source image format.

Definition at line 603 of file Texture.h.

GLenum osg::Texture::getSourceType ( ) const

inline

Gets the external source data type.

Definition at line 609 of file Texture.h.

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

inline

Gets the source of texture swizzling for all channels

Definition at line 521 of file Texture.h.

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

inlinevirtual

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

Definition at line 452 of file Texture.h.

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

inlinevirtual

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

Definition at line 451 of file Texture.h.

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

inline

Returns a pointer to the TextureObject for the current context.

Definition at line 633 of file Texture.h.

static osg::ref_ptr<Texture::TextureObjectManager>& osg::Texture::getTextureObjectManager ( unsigned int contextID )

static

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

inline

Gets the dirty flag for the current contextID.

Definition at line 653 of file Texture.h.

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

pure virtual

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

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

inlinevirtual

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

Definition at line 450 of file Texture.h.

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

inlinevirtual

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

Implements osg::StateAttribute.

Definition at line 436 of file Texture.h.

bool osg::Texture::getUnRefImageDataAfterApply ( ) const

inline

Gets whether or not apply() unreferences image data.

Definition at line 536 of file Texture.h.

bool osg::Texture::getUseHardwareMipMapGeneration ( ) const

inline

Gets the hardware mipmap generation hint.

Definition at line 528 of file Texture.h.

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.

Definition at line 829 of file Texture.h.

Here is the call graph for this function:

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.

Definition at line 426 of file Texture.h.

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.

Definition at line 438 of file Texture.h.

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

inlinevirtual

Return the name of the attribute's library.

Reimplemented from osg::StateAttribute.

Definition at line 427 of file Texture.h.

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.

static void osg::Texture::releaseTextureObject	(	unsigned int	contextID,
		TextureObject *	to
	)

static

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.

Definition at line 477 of file Texture.h.

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

inline

Sets the border width.

Definition at line 483 of file Texture.h.

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.

Definition at line 542 of file Texture.h.

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

Sets the texture filter mode.

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

pure virtual

Sets the texture image for the specified face.

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

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.

Definition at line 585 of file Texture.h.

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.

Definition at line 577 of file Texture.h.

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.

Definition at line 754 of file Texture.h.

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.

Definition at line 551 of file Texture.h.

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.

Definition at line 736 of file Texture.h.

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

inline

Sets shadow texture comparison function.

Definition at line 721 of file Texture.h.

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.

Definition at line 706 of file Texture.h.

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

inline

Sets shadow texture mode after comparison.

Definition at line 731 of file Texture.h.

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.

Definition at line 600 of file Texture.h.

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.

Definition at line 606 of file Texture.h.

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

inline

Configure the source of texture swizzling for all channels

Definition at line 518 of file Texture.h.

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

inline

Definition at line 638 of file Texture.h.

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.

Definition at line 533 of file Texture.h.

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.

Definition at line 525 of file Texture.h.

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

Sets the texture wrap mode.

Member Data Documentation

Vec4d osg::Texture::_borderColor

protected

Definition at line 868 of file Texture.h.

GLint osg::Texture::_borderWidth

protected

Definition at line 869 of file Texture.h.

bool osg::Texture::_clientStorageHint

protected

Definition at line 865 of file Texture.h.

ImageAttachment osg::Texture::_imageAttachment

protected

Definition at line 882 of file Texture.h.

GLint osg::Texture::_internalFormat

mutableprotected

Definition at line 873 of file Texture.h.

InternalFormatMode osg::Texture::_internalFormatMode

protected

Definition at line 871 of file Texture.h.

InternalFormatType osg::Texture::_internalFormatType

mutableprotected

Definition at line 872 of file Texture.h.

FilterMode osg::Texture::_mag_filter

protected

Definition at line 860 of file Texture.h.

float osg::Texture::_maxAnisotropy

protected

Definition at line 861 of file Texture.h.

FilterMode osg::Texture::_min_filter

protected

Definition at line 859 of file Texture.h.

ref_ptr<GraphicsContext> osg::Texture::_readPBuffer

mutableprotected

Definition at line 1268 of file Texture.h.

bool osg::Texture::_resizeNonPowerOfTwoHint

protected

Definition at line 866 of file Texture.h.

float osg::Texture::_shadow_ambient

protected

Definition at line 880 of file Texture.h.

ShadowCompareFunc osg::Texture::_shadow_compare_func

protected

Definition at line 878 of file Texture.h.

ShadowTextureMode osg::Texture::_shadow_texture_mode

protected

Definition at line 879 of file Texture.h.

GLenum osg::Texture::_sourceFormat

mutableprotected

Definition at line 874 of file Texture.h.

GLenum osg::Texture::_sourceType

mutableprotected

Definition at line 875 of file Texture.h.

Vec4i osg::Texture::_swizzle

protected

Definition at line 862 of file Texture.h.

TexParameterDirtyList osg::Texture::_texMipmapGenerationDirtyList

mutableprotected

Definition at line 853 of file Texture.h.

TexParameterDirtyList osg::Texture::_texParametersDirtyList

mutableprotected

Definition at line 852 of file Texture.h.

TextureObjectBuffer osg::Texture::_textureObjectBuffer

mutableprotected

Definition at line 1267 of file Texture.h.

bool osg::Texture::_unrefImageDataAfterApply

protected

Definition at line 864 of file Texture.h.

bool osg::Texture::_use_shadow_comparison

protected

Definition at line 877 of file Texture.h.

bool osg::Texture::_useHardwareMipMapGeneration

protected

Definition at line 863 of file Texture.h.

WrapMode osg::Texture::_wrap_r

protected

Definition at line 857 of file Texture.h.

WrapMode osg::Texture::_wrap_s

protected

Definition at line 855 of file Texture.h.

WrapMode osg::Texture::_wrap_t

protected

Definition at line 856 of file Texture.h.

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

osg_head/include/osg/Texture.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation