SoTextureCombiner Class Reference
[Textures]

VSG extension Texture combiner node. More...

#include <Inventor/nodes/SoTextureCombiner.h>

Inheritance diagram for SoTextureCombiner:
SoNode SoFieldContainer SoBase SoRefCounter SoTypedObject

List of all members.

Public Types

enum  CombineFunction {
  REPLACE = SbEnums::TEX_MODEL_REPLACE,
  MODULATE = SbEnums::TEX_MODEL_MODULATE,
  ADD = SbEnums::TEX_MODEL_ADD,
  ADD_SIGNED = SbEnums::TEX_MODEL_ADD_SIGNED,
  INTERPOLATE = SbEnums::TEX_MODEL_INTERPOLATE,
  SUBTRACT = SbEnums::TEX_MODEL_SUBTRACT,
  DOT3_RGB = SbEnums::TEX_MODEL_DOT3_RGB,
  DOT3_RGBA = SbEnums::TEX_MODEL_DOT3_RGBA
}
enum  SourceParameter {
  CONSTANT = SbEnums::SRC_PARAM_CONSTANT,
  PRIMARY_COLOR = SbEnums::SRC_PARAM_PRIMARY_COLOR,
  PREVIOUS = SbEnums::SRC_PARAM_PREVIOUS,
  TEXTURE = SbEnums::SRC_PARAM_TEXTURE,
  TEXTURE0,
  TEXTURE1,
  TEXTURE2,
  TEXTURE3,
  TEXTURE4,
  TEXTURE5,
  TEXTURE6,
  TEXTURE7
}
enum  OperandRGBA {
  SRC_COLOR = SbEnums::SRC_COLOR,
  ONE_MINUS_SRC_COLOR = SbEnums::ONE_MINUS_SRC_COLOR,
  SRC_ALPHA = SbEnums::SRC_ALPHA,
  ONE_MINUS_SRC_ALPHA = SbEnums::ONE_MINUS_SRC_ALPHA
}

Public Member Functions

virtual SoType getTypeId () const
 SoTextureCombiner ()

Static Public Member Functions

static SoType getClassTypeId ()

Public Attributes

SoSFEnum combineRGB
SoSFEnum combineAlpha
SoSFEnum source0RGB
SoSFEnum source1RGB
SoSFEnum source2RGB
SoSFEnum source0Alpha
SoSFEnum source1Alpha
SoSFEnum source2Alpha
SoSFEnum operand0RGB
SoSFEnum operand1RGB
SoSFEnum operand2RGB
SoSFEnum operand0Alpha
SoSFEnum operand1Alpha
SoSFEnum operand2Alpha
SoSFFloat scaleRGB
SoSFFloat scaleAlpha
SoSFVec4f constantColor

Detailed Description

VSG extension Texture combiner node.

The Texture Combine Environment Mode is a texture environment function that provides a wide range of programmable combiner functions using the incoming fragment color, texture source color, texture constant color, and the result of the previous texture environment stage as possible parameters. Texture Dot3 Environment offers new combiner function to Texture Combine Environment Mode. Texture Crossbar Environment Mode extends the Texture Combine Environment Mode by allowing use of the texture color from different texture units as sources to the texture combine function.

FILE FORMAT/DEFAULT

ACTION BEHAVIOR

SEE ALSO

SoComplexity, SoExtTexture2, SoMaterial, SoTexture, SoTexture2, SoTexture2Transform, SoTexture3, SoTextureCoordinate2, SoTextureCoordinateBinding, SoTextureCoordinateFunction, SoTextureCubeMap, SoTextureUnit


Member Enumeration Documentation

Texture Combiner Functions.

Enumerator:
REPLACE 

Output fragment is source0.

MODULATE 

Output fragment is source0 * source1.

ADD 

Output fragment is source0 + source1.

ADD_SIGNED 

Output fragment is source0 + source1 - 0.5.

INTERPOLATE 

Output fragment is source0 * source2 + source1 * (1 - source2).

SUBTRACT 

Output fragment is source0 - source1.

DOT3_RGB 

Output fragment R = G = B =
4*((source0r - 0.5) * (source1r -0.5) +
(source0g - 0.5) * (source1g -0.5) +
(source0b - 0.5) * (source1b -0.5) )
.

DOT3_RGBA 

Output fragment R = G = B = A =
4*((source0r - 0.5) * (source1r -0.5) +
(source0g - 0.5) * (source1g -0.5) +
(source0b - 0.5) * (source1b -0.5) )
.

Specifies the input mapping for the RGB and alpha portions of operand n.

See OpenGL documentation for details.

Enumerator:
SRC_COLOR 

(Cred, Cgreen, Cblue).


Not accepted for alpha operands.

ONE_MINUS_SRC_COLOR 

(1 - Cred, 1 - Cgreen, 1 - Cblue).


Not accepted for alpha operands.

SRC_ALPHA 

(Calpha, Calpha, Calpha).

ONE_MINUS_SRC_ALPHA 

(1 - Calpha, 1 - Calpha, 1 - Calpha).

Source Parameter enumeration values.

Enumerator:
CONSTANT 

Texture environment constant color.


Use the constantColor field to specify the color.

PRIMARY_COLOR 

Primary color of the incoming fragment.

PREVIOUS 

Result of previous texture combiner.


On texture unit 0, corresponds to PRIMARY_COLOR.

TEXTURE 

Texture color of the current texture unit.

TEXTURE0 

Texture color of texture unit 0.


Requires GL_ARB_texture_env_crossbar.

TEXTURE1 

Texture color of texture unit 1.


Requires GL_ARB_texture_env_crossbar.

TEXTURE2 

Texture color of texture unit 2.


Requires GL_ARB_texture_env_crossbar.

TEXTURE3 

Texture color of texture unit 3.


Requires GL_ARB_texture_env_crossbar.

TEXTURE4 

Texture color of texture unit 4.


Requires GL_ARB_texture_env_crossbar.

TEXTURE5 

Texture color of texture unit 5.


Requires GL_ARB_texture_env_crossbar.

TEXTURE6 

Texture color of texture unit 6.


Requires GL_ARB_texture_env_crossbar.

TEXTURE7 

Texture color of texture unit 7.


Requires GL_ARB_texture_env_crossbar.


Constructor & Destructor Documentation

SoTextureCombiner::SoTextureCombiner (  ) 

Constructor.


Member Function Documentation

static SoType SoTextureCombiner::getClassTypeId (  )  [static]

Returns the type identifier for this class.

Reimplemented from SoNode.

virtual SoType SoTextureCombiner::getTypeId (  )  const [virtual]

Returns the type identifier for this specific instance.

Reimplemented from SoNode.


Member Data Documentation

Specifies the texture combiner function to apply on the source<n>Alpha transformed by the operand<n>Alpha.

Use enum CombineFunction. Default is MODULATE.

Specifies the texture combiner function to apply on the source<n>RGB transformed by the operand<n>RGB.

Use enum CombineFunction. Default is MODULATE.

Specifies a constant color.

Used when SourceParameter enum is CONSTANT.

Specifies an operand to be applied on the source0Alpha before applying the combiner.

Use enum OperandRGBA but only the two last values: SRC_ALPHA or ONE_MINUS_SRC_ALPHA. Default is SRC_ALPHA.

Specifies an operand to be applied on the source0RGB before applying the combiner.

Use enum OperandRGBA. Default is SRC_COLOR.

Specifies an operand to be applied on the source1Alpha before applying the combiner.

Use enum OperandRGBA but only the two last values: SRC_ALPHA or ONE_MINUS_SRC_ALPHA. Default is SRC_ALPHA.

Specifies an operand to be applied on the source1RGB before applying the combiner.

Use enum OperandRGBA. Default is SRC_COLOR.

Specifies an operand to be applied on the source2Alpha before applying the combiner.

Use enum OperandRGBA but only the two last values: SRC_ALPHA or ONE_MINUS_SRC_ALPHA. Default is SRC_ALPHA.

Specifies an operand to be applied on the source2RGB before applying the combiner.

Use enum OperandRGBA. Default is SRC_ALPHA.

Specifies the alpha scale for the entire texture operation and may be 1.0, 2.0, or 4.0.

Specifies the RGB scale for the entire texture operation and may be 1.0, 2.0, or 4.0.

Specifies one of the three sources for the alpha components.

Use enum SourceParameter. Default is TEXTURE.

Specifies one of the three sources for the RGB components.

Use enum SourceParameter. Default is TEXTURE.

Specifies one of the three sources for the alpha components.

Use enum SourceParameter. Default is PREVIOUS .

Specifies one of the three sources for the RGB components.

Use enum SourceParameter. Default is PREVIOUS .

Specifies one of the three sources for the alpha components.

Use enum SourceParameter. Default is CONSTANT.

Specifies one of the three sources for the RGB components.

Use enum SourceParameter. Default is CONSTANT.


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

Open Inventor Toolkit reference manual, generated on 4 Sep 2023
Copyright © Thermo Fisher Scientific All rights reserved.
https://www.openinventor.com/