osg::TextureCubeMap Class Reference

TextureCubeMap state class which encapsulates OpenGL texture cubemap functionality. More...

Inheritance diagram for osg::TextureCubeMap:

Inheritance graph
[legend]

List of all members.

Public Types

enum  Face {
  POSITIVE_X = 0, NEGATIVE_X = 1, POSITIVE_Y = 2, NEGATIVE_Y = 3,
  POSITIVE_Z = 4, NEGATIVE_Z = 5
}

Public Member Functions

 TextureCubeMap ()
 TextureCubeMap (const TextureCubeMap &cm, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 Copy constructor using CopyOp to manage deep vs shallow copy.
 META_StateAttribute (osg, TextureCubeMap, TEXTURE)
virtual int compare (const StateAttribute &rhs) const
 Return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs.
virtual GLenum getTextureTarget () const
virtual void setImage (unsigned int face, Image *image)
 Set the texture image for specified face.
virtual ImagegetImage (unsigned int face)
 Get the texture image for specified face.
virtual const ImagegetImage (unsigned int face) const
 Get the const texture image for specified face.
virtual unsigned int getNumImages () const
 Get the number of images that can be assigned to the Texture.
unsigned int & getModifiedCount (unsigned int face, unsigned int contextID) const
void setTextureSize (int width, int height) const
 Set the texture width and height.
void setTextureWidth (int width)
void setTextureHeight (int height)
virtual int getTextureWidth () const
virtual int getTextureHeight () const
virtual int getTextureDepth () const
void setSubloadCallback (SubloadCallback *cb)
SubloadCallbackgetSubloadCallback ()
const SubloadCallbackgetSubloadCallback () const
void setNumMipmapLevels (unsigned int num) const
 Set the number of mip map levels the the texture has been created with.
unsigned int getNumMipmapLevels () const
 Get the number of mip map levels the the texture has been created with.
void copyTexSubImageCubeMap (State &state, int face, int xoffset, int yoffset, int x, int y, int width, int height)
 Copies a two-dimensional texture subimage, as per glCopyTexSubImage2D.
virtual void apply (State &state) const
 On first apply (unless already compiled), create the mipmapped texture and bind it.

Static Public Member Functions

static ExtensionsgetExtensions (unsigned int contextID, bool createIfNotInitalized)
 Function to call to get the extension of a specified context.
static void setExtensions (unsigned int contextID, Extensions *extensions)
 The setExtensions method allows users to override the extensions across graphics contexts.

Protected Types

typedef
buffered_value
< unsigned int > 
ImageModifiedCount

Protected Member Functions

virtual ~TextureCubeMap ()
bool imagesValid () const
virtual void computeInternalFormat () const
void allocateMipmap (State &state) const
 Allocate mipmap levels of the texture by subsequent calling of glTexImage* function.

Protected Attributes

ref_ptr< Image_images [6]
GLsizei _textureWidth
GLsizei _textureHeight
GLsizei _numMipmapLevels
ref_ptr
< SubloadCallback
_subloadCallback
ImageModifiedCount _modifiedCount [6]

Classes

class  Extensions
 Extensions class which encapsulates the querying of extensions and associated function pointers, and provides convinience wrappers to check for the extensions or use the associated functions. More...
class  SubloadCallback


Detailed Description

TextureCubeMap state class which encapsulates OpenGL texture cubemap functionality.


Member Typedef Documentation

typedef buffered_value<unsigned int> osg::TextureCubeMap::ImageModifiedCount [protected]


Member Enumeration Documentation

enum osg::TextureCubeMap::Face

Enumerator:
POSITIVE_X 
NEGATIVE_X 
POSITIVE_Y 
NEGATIVE_Y 
POSITIVE_Z 
NEGATIVE_Z 


Constructor & Destructor Documentation

osg::TextureCubeMap::TextureCubeMap (  ) 

osg::TextureCubeMap::TextureCubeMap ( const TextureCubeMap cm,
const CopyOp copyop = CopyOp::SHALLOW_COPY 
)

Copy constructor using CopyOp to manage deep vs shallow copy.

virtual osg::TextureCubeMap::~TextureCubeMap (  )  [protected, virtual]


Member Function Documentation

osg::TextureCubeMap::META_StateAttribute ( osg  ,
TextureCubeMap  ,
TEXTURE   
)

virtual int osg::TextureCubeMap::compare ( const StateAttribute rhs  )  const [virtual]

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

Implements osg::StateAttribute.

virtual GLenum osg::TextureCubeMap::getTextureTarget (  )  const [inline, virtual]

Implements osg::Texture.

virtual void osg::TextureCubeMap::setImage ( unsigned int  face,
Image image 
) [virtual]

Set the texture image for specified face.

Implements osg::Texture.

virtual Image* osg::TextureCubeMap::getImage ( unsigned int  face  )  [virtual]

Get the texture image for specified face.

Implements osg::Texture.

virtual const Image* osg::TextureCubeMap::getImage ( unsigned int  face  )  const [virtual]

Get the const texture image for specified face.

Implements osg::Texture.

virtual unsigned int osg::TextureCubeMap::getNumImages (  )  const [inline, virtual]

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

Implements osg::Texture.

unsigned int& osg::TextureCubeMap::getModifiedCount ( unsigned int  face,
unsigned int  contextID 
) const [inline]

void osg::TextureCubeMap::setTextureSize ( int  width,
int  height 
) const [inline]

Set the texture width and height.

If width or height are zero then the repsective size value is calculated from the source image sizes.

void osg::TextureCubeMap::setTextureWidth ( int  width  )  [inline]

void osg::TextureCubeMap::setTextureHeight ( int  height  )  [inline]

virtual int osg::TextureCubeMap::getTextureWidth (  )  const [inline, virtual]

Reimplemented from osg::Texture.

virtual int osg::TextureCubeMap::getTextureHeight (  )  const [inline, virtual]

Reimplemented from osg::Texture.

virtual int osg::TextureCubeMap::getTextureDepth (  )  const [inline, virtual]

Reimplemented from osg::Texture.

void osg::TextureCubeMap::setSubloadCallback ( SubloadCallback cb  )  [inline]

SubloadCallback* osg::TextureCubeMap::getSubloadCallback (  )  [inline]

const SubloadCallback* osg::TextureCubeMap::getSubloadCallback (  )  const [inline]

void osg::TextureCubeMap::setNumMipmapLevels ( unsigned int  num  )  const [inline]

Set the number of mip map levels the the texture has been created with.

Should only be called within an osg::Texuture::apply() and custom OpenGL texture load.

unsigned int osg::TextureCubeMap::getNumMipmapLevels (  )  const [inline]

Get the number of mip map levels the the texture has been created with.

void osg::TextureCubeMap::copyTexSubImageCubeMap ( State state,
int  face,
int  xoffset,
int  yoffset,
int  x,
int  y,
int  width,
int  height 
)

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

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 and yoffset. width and height must be powers of two.

virtual void osg::TextureCubeMap::apply ( State state  )  const [virtual]

On first apply (unless already compiled), create the mipmapped texture and bind it.

Subsequent apply will simple bind to texture.

Implements osg::Texture.

static Extensions* osg::TextureCubeMap::getExtensions ( unsigned int  contextID,
bool  createIfNotInitalized 
) [static]

Function to call to get the extension of a specified context.

If the Exentsion object for that context has not yet been created and the 'createIfNotInitalized' flag been set to false then returns NULL. If 'createIfNotInitalized' is true then the Extensions object is automatically created. However, in this case the extension object will only be created with the graphics context associated with ContextID.

Reimplemented from osg::Texture.

static void osg::TextureCubeMap::setExtensions ( unsigned int  contextID,
Extensions extensions 
) [static]

The setExtensions method allows users to override the extensions across graphics contexts.

Typically used when you have different extensions supported across graphics pipes but need to ensure that they all use the same low common denominator extensions.

bool osg::TextureCubeMap::imagesValid (  )  const [protected]

virtual void osg::TextureCubeMap::computeInternalFormat (  )  const [protected, virtual]

Implements osg::Texture.

void osg::TextureCubeMap::allocateMipmap ( State state  )  const [protected, virtual]

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

Implements osg::Texture.


Member Data Documentation

ref_ptr<Image> osg::TextureCubeMap::_images[6] [protected]

GLsizei osg::TextureCubeMap::_textureWidth [mutable, protected]

GLsizei osg::TextureCubeMap::_textureHeight [mutable, protected]

GLsizei osg::TextureCubeMap::_numMipmapLevels [mutable, protected]

ref_ptr<SubloadCallback> osg::TextureCubeMap::_subloadCallback [protected]

ImageModifiedCount osg::TextureCubeMap::_modifiedCount[6] [mutable, protected]


The documentation for this class was generated from the following file:
Generated at Sun Oct 14 02:12:18 2007 for the OpenSceneGraph by doxygen 1.5.3.