version 3.3

VRS::TextureGL Class Reference

Base class for all OpenGL textures. More...

#include <vrs/opengl/texturegl.h>

Inheritance diagram for VRS::TextureGL:

VRS::Texture VRS::MonoAttribute VRS::Attribute VRS::RenderObj VRS::SharedObj VRS::Visitable VRS::CubeMapTextureGL VRS::Texture1DGL VRS::Texture2DGL VRS::Texture3DGL VRS::TextureArray1DGL VRS::TextureArray2DGL VRS::TextureBufferGL VRS::ImageCubeMapTextureGL VRS::ImageTexture1DGL VRS::MipmapTexture1DGL VRS::ImageTexture2DGL VRS::MipmapTexture2DGL VRS::ImageTexture3DGL VRS::MipmapTexture3DGL VRS::ImageTextureArray1DGL VRS::ImageTextureArray2DGL

List of all members.

Public Types

enum  FilterMode {
  NEAREST, LINEAR, TRILINEAR, LINEAR_MIPMAP_LINEAR = TRILINEAR,
  NEAREST_MIPMAP_NEAREST, LINEAR_MIPMAP_NEAREST, NEAREST_MIPMAP_LINEAR
}
enum  WrapMode {
  REPEAT, CLAMP, CLAMP_TO_EDGE, CLAMP_TO_BORDER,
  MIRRORED_REPEAT, MIRROR_CLAMP, MIRROR_CLAMP_TO_EDGE, MIRROR_CLAMP_TO_BORDER
}
enum  ShadowCompareMode {
  DISABLED, LEQUAL, GEQUAL, LESS,
  GREATER, EQUAL, NOT_EQUAL, ALWAYS,
  NEVER
}
enum  ShadowResultMode { SHADOW_LUMINANCE, SHADOW_INTENSITY, SHADOW_ALPHA }
enum  Component { COLOR, ALPHA, DEPTH }

Public Member Functions

 VRS_SERIALIZABLE_CLASS_ENUM (FilterMode)
 VRS_SERIALIZABLE_CLASS_ENUM (WrapMode)
 VRS_SERIALIZABLE_CLASS_ENUM (ShadowCompareMode)
 VRS_SERIALIZABLE_CLASS_ENUM (ShadowResultMode)
 VRS_SERIALIZABLE_CLASS_ENUM (Component)
virtual void setFilter (FilterMode filter)
virtual void setMinFilter (FilterMode filter)
virtual void setMagFilter (FilterMode filter)
virtual FilterMode getMinFilter () const
virtual FilterMode getMagFilter () const
 Get/set the filters.
virtual void setAnisotropic (GLfloat factor)
virtual GLfloat getAnisotropic () const
virtual void setBorderColor (const Color &color)
virtual const ColorgetBorderColor () const
virtual void setMinMipmapLevel (unsigned int newMinMipmapLevel)
virtual unsigned int getMinMipmapLevel () const
virtual void setMaxMipmapLevel (unsigned int newMaxMipmapLevel)
virtual unsigned int getMaxMipmapLevel () const
virtual bool isMipmap () const
virtual void setShadowCompare (ShadowCompareMode)
virtual ShadowCompareMode getShadowCompare () const
virtual void setShadowResult (ShadowResultMode)
virtual ShadowResultMode getShadowResult () const
virtual void setInternalFormat (GLenum format=GL_ZERO)
virtual GLenum getInternalFormat () const
virtual bool definesComponent (Component component) const
virtual ID category () const
 See 'Attribute'.
 VRS_TYPEINFO (TextureGL, Texture)
 VRS_SERIALIZABLE (TextureGL)

Protected Member Functions

 TextureGL (FilterMode minFilter=TextureGL::TRILINEAR, FilterMode magFilter=TextureGL::LINEAR, GLfloat anisotropic=1.0, const Matrix &matrix=Matrix(), const Color &borderColor=Color(0.0f, 0.0f, 0.0f, 0.0f), GLenum internalFormat=GL_ZERO, unsigned int minMipmapLevel=0, unsigned int maxMipmapLevel=1000)
bool operator== (const TextureGL &other) const


Detailed Description

Base class for all OpenGL textures.

Member Enumeration Documentation

Enumerator:
NEAREST 
LINEAR 
TRILINEAR 
LINEAR_MIPMAP_LINEAR 
NEAREST_MIPMAP_NEAREST 
LINEAR_MIPMAP_NEAREST 
NEAREST_MIPMAP_LINEAR 

Enumerator:
REPEAT 
CLAMP 
CLAMP_TO_EDGE 
CLAMP_TO_BORDER 
MIRRORED_REPEAT 
MIRROR_CLAMP 
MIRROR_CLAMP_TO_EDGE 
MIRROR_CLAMP_TO_BORDER 

Enumerator:
DISABLED 
LEQUAL 
GEQUAL 
LESS 
GREATER 
EQUAL 
NOT_EQUAL 
ALWAYS 
NEVER 

Enumerator:
SHADOW_LUMINANCE 
SHADOW_INTENSITY 
SHADOW_ALPHA 

Enumerator:
COLOR 
ALPHA 
DEPTH 


Constructor & Destructor Documentation

VRS::TextureGL::TextureGL ( FilterMode  minFilter = TextureGL::TRILINEAR,
FilterMode  magFilter = TextureGL::LINEAR,
GLfloat  anisotropic = 1.0,
const Matrix matrix = Matrix(),
const Color borderColor = Color(0.0f, 0.0f, 0.0f, 0.0f),
GLenum  internalFormat = GL_ZERO,
unsigned int  minMipmapLevel = 0,
unsigned int  maxMipmapLevel = 1000 
) [protected]

OpenGL texture. By default (if GL_ZERO is specified for 'internalFormat'), the internal texture format is determined by the number of layers: 1: GL_LUMINANCE 2: GL_LUMINANCE_ALPHA 3: GL_RGB 4: GL_RGBA Or GL_RGB for a PaletteImage.


Member Function Documentation

VRS::TextureGL::VRS_SERIALIZABLE_CLASS_ENUM ( FilterMode   ) 

VRS::TextureGL::VRS_SERIALIZABLE_CLASS_ENUM ( WrapMode   ) 

VRS::TextureGL::VRS_SERIALIZABLE_CLASS_ENUM ( ShadowCompareMode   ) 

VRS::TextureGL::VRS_SERIALIZABLE_CLASS_ENUM ( ShadowResultMode   ) 

VRS::TextureGL::VRS_SERIALIZABLE_CLASS_ENUM ( Component   ) 

bool VRS::TextureGL::operator== ( const TextureGL other  )  const [protected]

virtual void VRS::TextureGL::setFilter ( FilterMode  filter  )  [virtual]

virtual void VRS::TextureGL::setMinFilter ( FilterMode  filter  )  [virtual]

virtual void VRS::TextureGL::setMagFilter ( FilterMode  filter  )  [virtual]

virtual FilterMode VRS::TextureGL::getMinFilter (  )  const [virtual]

virtual FilterMode VRS::TextureGL::getMagFilter (  )  const [virtual]

Get/set the filters.

virtual void VRS::TextureGL::setAnisotropic ( GLfloat  factor  )  [virtual]

virtual GLfloat VRS::TextureGL::getAnisotropic (  )  const [virtual]

Get/set the ansiotropic filter level some OpenGL implementations provide as an extension.

virtual void VRS::TextureGL::setBorderColor ( const Color color  )  [virtual]

virtual const Color& VRS::TextureGL::getBorderColor (  )  const [virtual]

Get/set the border color used for during clamping.

virtual void VRS::TextureGL::setMinMipmapLevel ( unsigned int  newMinMipmapLevel  )  [virtual]

virtual unsigned int VRS::TextureGL::getMinMipmapLevel (  )  const [virtual]

Reimplemented in VRS::MipmapTexture2DGL.

virtual void VRS::TextureGL::setMaxMipmapLevel ( unsigned int  newMaxMipmapLevel  )  [virtual]

virtual unsigned int VRS::TextureGL::getMaxMipmapLevel (  )  const [virtual]

Get/set the mimimum/maximum mipmap level that should be addressed during rendering.

Reimplemented in VRS::MipmapTexture1DGL, and VRS::MipmapTexture2DGL.

virtual bool VRS::TextureGL::isMipmap (  )  const [virtual]

Returns if the min filter is one that uses mipmaping.

Reimplemented in VRS::ImageTexture2DGL.

virtual void VRS::TextureGL::setShadowCompare ( ShadowCompareMode   )  [virtual]

virtual ShadowCompareMode VRS::TextureGL::getShadowCompare (  )  const [virtual]

Get/sets the shadow testing mode for depth map shadows. For meaningful results, the internal format of the texture should be set to GL_DEPTH_COMPONENT.

virtual void VRS::TextureGL::setShadowResult ( ShadowResultMode   )  [virtual]

virtual ShadowResultMode VRS::TextureGL::getShadowResult (  )  const [virtual]

Get/sets the shadow result for depth map shadows. The result of a shadow map texture can be used as luminance, intensity, or alpha values.

virtual void VRS::TextureGL::setInternalFormat ( GLenum  format = GL_ZERO  )  [virtual]

virtual GLenum VRS::TextureGL::getInternalFormat (  )  const [virtual]

Sets/gets the internal texture format used by OpenGL for the texture. The internal texture format determines the texture application formula used for each component of the texture. If GL_ZERO is specified the value described for the constructor is set.

Reimplemented in VRS::ImageCubeMapTextureGL, VRS::ImageTexture1DGL, VRS::ImageTexture2DGL, VRS::ImageTexture3DGL, VRS::ImageTextureArray1DGL, VRS::ImageTextureArray2DGL, VRS::MipmapTexture1DGL, VRS::MipmapTexture2DGL, and VRS::MipmapTexture3DGL.

virtual bool VRS::TextureGL::definesComponent ( Component  component  )  const [virtual]

Returns if the texture defines the specified component (COLOR, ALPHA, or DEPTH).

virtual ID VRS::TextureGL::category (  )  const [virtual]

See 'Attribute'.

Reimplemented from VRS::Texture.

VRS::TextureGL::VRS_TYPEINFO ( TextureGL  ,
Texture   
)

VRS::TextureGL::VRS_SERIALIZABLE ( TextureGL   ) 


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

Generated on Tue May 21 06:00:28 2013 by Doxygen 1.5.6
© 2001-2010 Hasso-Plattner-Institut | Impressum | Contact