H3D::TextureProperties Class Reference
[X3D node classes.]

TextureProperties allows fine control over a texture's application. More...

#include <H3D/TextureProperties.h>

Inheritance diagram for H3D::TextureProperties:

Inheritance graph

List of all members.

Public Member Functions

 TextureProperties (Inst< SFNode > _metadata=0, Inst< SFFloat > _anisotropicDegree=0, Inst< SFColorRGBA > _borderColor=0, Inst< SFInt32 > _borderWidth=0, Inst< SFString > _boundaryModeS=0, Inst< SFString > _boundaryModeT=0, Inst< SFString > _boundaryModeR=0, Inst< SFString > _magnificationFilter=0, Inst< SFString > _minificationFilter=0, Inst< SFString > _textureCompression=0, Inst< SFFloat > _texturePriority=0, Inst< SFBool > _generateMipMaps=0)
 Constructor.
virtual string defaultXMLContainerField ()
 Returns the default xml containerField attribute value.

Public Attributes

auto_ptr< SFFloatanisotropicDegree
 The anisotropicDegree field describes the minimum degree of anisotropy to account for in texture filtering.
auto_ptr< SFColorRGBAborderColor
 The borderColor field describes the color to use for border pixels.
auto_ptr< SFInt32borderWidth
 The borderWidth field describes the color to use for border pixels.
auto_ptr< SFStringboundaryModeS
 The boundaryModeS field describes the way S texture coordinate boundaries are handled.
auto_ptr< SFStringboundaryModeT
 The boundaryModeT field describes the way T texture coordinate boundaries are handled.
auto_ptr< SFStringboundaryModeR
 The boundaryModeR field describes the way R texture coordinate boundaries are handled.
auto_ptr< SFStringmagnificationFilter
 The magnificationFilter field describes the way textures are filtered when the image is smaller then the screen space representation.
auto_ptr< SFStringminificationFilter
 The minificationFilter field describes the way textures are filtered when the image is larger then the screen space representation.
auto_ptr< SFStringtextureCompression
 The textureCompression fields describes if/how a texture should be compressed.
auto_ptr< SFFloattexturePriority
 The texturePriority field describes the texture residence priority for allocating texture memory.
auto_ptr< SFBoolgenerateMipMaps
 The generateMipMaps field describes whether mipmaps should be generated for the texture.
auto_ptr< FieldpropertyChanged
 Field that gets an event when any of the X3D fields in the TextureProperties generates an event.

Static Public Attributes

static H3DNodeDatabase database
 The H3DNodeDatabase for this node.


Detailed Description

TextureProperties allows fine control over a texture's application.

This node can be used to set the texture properties for a node with a textureProperties field. A texture with a TextureProperties node will ignore the repeatS and repeatT fields on the texture.

The anisotropicDegree field describes the minimum degree of anisotropy to account for in texture filtering. A value of 1 implies no anisotropic filtering. Values above the system's maximum supported value will be clamped to the maximum allowed.

The borderColor field describes the color to use for border pixels.

The borderWidth field describes the number of pixels to use for a texture border.

The boundaryModeS, boundaryModeT nad boundaryModeR fields describe the way texture coordinate boundaries are handled. Valid values are:

The magnificationFilter field describes the way textures are filtered when the image is smaller then the screen space representation. Valid values are:

The minificationFilter field describes the way textures are filtered when the image is larger then the screen space representation. Valid values are:

-"AVG_PIXEL" Select the weighted average of the four texture elements that are closest to the center of the pixel being textured. -"AVG_PIXEL_AVG_MIPMAP" Performs tri-linear filtering. Choose the two mipmaps that most closely match the size of the pixel being textured and use the weighted average of the four texture elements that are closest to the center of the pixel to produce a texture value from each mipmap. The final texture value is a weighted average of those two values. -"AVG_PIXEL_NEAREST_MIPMAP" Choose the mipmap that most closely matches the size of the pixel being textured and use the weighted average of the four texture elements that are closest to the center of the pixel to produce a texture value. -"DEFAULT" Select the browser-specified default minification mode. -"FASTEST" Select the fastest method available. Mipmaps shall be used, if available. -"NEAREST_PIXEL" Select the pixel that is nearest to the center of the pixel being textured. -"NEAREST_PIXEL_AVG_MIPMAP" Choose the two mipmaps that most closely match the size of the pixel being textured and use the texture element nearest to the center of the pixel to produce a texture value from each mipmap. The final texture value is a weighted average of those two values. -"NEAREST_PIXEL_NEAREST_MIPMAP" Choose the mipmap that most closely matches the size of the pixel being textured and use the texture element nearest to the center of the pixel) to produce a texture value.

-"NICEST" Select the highest quality method available. Mipmaps shall be used, if available.

Modes with MIPMAP in the name require mipmaps. If mipmaps are not provided, the mode shall pick the corresponding non-mipmapped mode (e.g., AVG_PIXEL_NEAREST_MIPMAP becomes AVG_PIXEL).

The texturePriority field describes the texture residence priority for allocating texture memory. Zero indicates the lowest priority and 1 indicates the highest priority. Values are clamped to the range [0,1].

The generateMipMaps field describes whether mipmaps should be generated for the texture. Mipmaps are required for filtering modes with MIPMAP in their value.

The textureCompression fields describes if/how a texture should be compressed. Valid values are:

Internal routes:
TextureProperties.dot

Member Function Documentation

virtual string H3D::TextureProperties::defaultXMLContainerField (  )  [inline, virtual]

Returns the default xml containerField attribute value.

For this node it is "textureProperties".

Reimplemented from H3D::Node.


Member Data Documentation

The anisotropicDegree field describes the minimum degree of anisotropy to account for in texture filtering.

A value of 1 implies no anisotropic filtering. Values above the system's maximum supported value will be clamped to the maximum allowed.

Access type: inputOutput
Default value: 1.0

TextureProperties_anisotropicDegree.dot

Referenced by H3D::X3DTexture3DNode::renderTextureProperties(), H3D::X3DTexture2DNode::renderTextureProperties(), and TextureProperties().

The borderColor field describes the color to use for border pixels.

Access type: inputOutput
Default value: 0 0 0 0

TextureProperties_borderColor.dot

Referenced by H3D::X3DTexture3DNode::renderTextureProperties(), H3D::X3DTexture2DNode::renderTextureProperties(), and TextureProperties().

The borderWidth field describes the color to use for border pixels.

Access type: inputOutput
Default value: 0

TextureProperties_borderWidth.dot

Referenced by H3D::X3DTexture3DNode::glTexImage(), H3D::X3DTexture2DNode::glTexImage(), and TextureProperties().

The boundaryModeR field describes the way R texture coordinate boundaries are handled.

Access type: inputOutput
Default value: "REPEAT"

TextureProperties_boundaryModeR.dot

Referenced by H3D::X3DTexture3DNode::renderTextureProperties(), H3D::X3DTexture2DNode::renderTextureProperties(), and TextureProperties().

The boundaryModeS field describes the way S texture coordinate boundaries are handled.

Access type: inputOutput
Default value: "REPEAT"

TextureProperties_boundaryModeS.dot

Referenced by H3D::X3DTexture3DNode::renderTextureProperties(), H3D::X3DTexture2DNode::renderTextureProperties(), and TextureProperties().

The boundaryModeT field describes the way T texture coordinate boundaries are handled.

Access type: inputOutput
Default value: "REPEAT"

TextureProperties_boundaryModeT.dot

Referenced by H3D::X3DTexture3DNode::renderTextureProperties(), H3D::X3DTexture2DNode::renderTextureProperties(), and TextureProperties().

The generateMipMaps field describes whether mipmaps should be generated for the texture.

Mipmaps are required for filtering modes with MIPMAP in their value.

Access type: inputOutput
Default value: false

TextureProperties_generateMipMaps.dot

Referenced by H3D::X3DTexture3DNode::glTexImage(), H3D::X3DTexture2DNode::glTexImage(), and TextureProperties().

The magnificationFilter field describes the way textures are filtered when the image is smaller then the screen space representation.

Access type: inputOutput
Default value: "FASTEST"

TextureProperties_magnificationFilter.dot

Referenced by H3D::X3DTexture3DNode::renderTextureProperties(), H3D::X3DTexture2DNode::renderTextureProperties(), and TextureProperties().

The minificationFilter field describes the way textures are filtered when the image is larger then the screen space representation.

Access type: inputOutput
Default value: "FASTEST"

TextureProperties_minificationFilter.dot

Referenced by H3D::X3DTexture3DNode::renderTextureProperties(), H3D::X3DTexture2DNode::renderTextureProperties(), and TextureProperties().

The textureCompression fields describes if/how a texture should be compressed.

Access type: inputOutput
Default value: "FASTEST"

TextureProperties_textureCompression.dot

Referenced by H3D::X3DTexture3DNode::glInternalFormat(), H3D::X3DTexture2DNode::glInternalFormat(), H3D::X3DTexture3DNode::renderTextureProperties(), H3D::X3DTexture2DNode::renderTextureProperties(), and TextureProperties().

The texturePriority field describes the texture residence priority for allocating texture memory.

Zero indicates the lowest priority and 1 indicates the highest priority. Values are clamped to the range [0,1].

Access type: inputOutput
Default value: 0

TextureProperties_texturePriority.dot

Referenced by H3D::X3DTexture3DNode::renderTextureProperties(), H3D::X3DTexture2DNode::renderTextureProperties(), and TextureProperties().


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

Generated on Fri Nov 7 10:31:14 2008 for H3D API by  doxygen 1.5.7