--- name: "SoTextureCombine" section: "3" platform: "linux" package: "coin" version: "1:4.0.10-1" release: "Arch Linux 2026-11-01" platforms: ["linux"] url: "https://new.carta.tech/SoTextureCombine" --- # SoTextureCombine(3) The SoTextureCombine class is a node for setting texture combine functions. ## NAME SoTextureCombine - The **SoTextureCombine** class is a node for setting texture combine functions. ## SYNOPSIS \#include \ Inherits **SoNode**. ### Public Types enum **Source** { **PRIMARY\_COLOR** = SoTextureCombineElement::PRIMARY\_COLOR, **TEXTURE** = SoTextureCombineElement::TEXTURE, **CONSTANT** = SoTextureCombineElement::CONSTANT, **PREVIOUS** = SoTextureCombineElement::PREVIOUS }\ enum **Operand** { **SRC\_COLOR** = SoTextureCombineElement::SRC\_COLOR, **ONE\_MINUS\_SRC\_COLOR** = SoTextureCombineElement::ONE\_MINUS\_SRC\_COLOR, **SRC\_ALPHA** = SoTextureCombineElement::SRC\_ALPHA, **ONE\_MINUS\_SRC\_ALPHA** = SoTextureCombineElement::ONE\_MINUS\_SRC\_ALPHA }\ enum **Operation** { **REPLACE** = SoTextureCombineElement::REPLACE, **MODULATE** = SoTextureCombineElement::MODULATE, **ADD** = SoTextureCombineElement::ADD, **ADD\_SIGNED** = SoTextureCombineElement::ADD\_SIGNED, **SUBTRACT** = SoTextureCombineElement::SUBTRACT, **INTERPOLATE** = SoTextureCombineElement::INTERPOLATE, **DOT3\_RGB** = SoTextureCombineElement::DOT3\_RGB, **DOT3\_RGBA** = SoTextureCombineElement::DOT3\_RGBA }\ Public Types inherited from **SoNode** enum **NodeType** { **INVENTOR** = 0x0000, **VRML1** = 0x0001, **VRML2** = 0x0002, **INVENTOR\_1** = 0x0004, **INVENTOR\_2\_0** = 0x0008, **INVENTOR\_2\_1** = 0x0010, **INVENTOR\_2\_5** = 0x0020, **INVENTOR\_2\_6** = 0x0040, **COIN\_1\_0** = 0x0080, **COIN\_2\_0** = 0x0100, **EXTENSION** = 0x0200, **COIN\_2\_2** = 0x0400, **COIN\_2\_3** = 0x0800, **COIN\_2\_4** = 0x1000, **INVENTOR\_5\_0** = 0x2000, **COIN\_2\_5** = 0x4000, **COIN\_3\_0** = 0x8000, **INVENTOR\_6\_0** = 0x10000, **COIN\_4\_0** = 0x20000 }\ ### Public Member Functions virtual **SoType** **getTypeId** (void) const\ **SoTextureCombine** (void)\ virtual void **doAction** (**SoAction** \*action)\ virtual void **callback** (**SoCallbackAction** \*action)\ virtual void **GLRender** (**SoGLRenderAction** \*action)\ virtual void **pick** (**SoPickAction** \*action)\ Public Member Functions inherited from **SoNode** void **setOverride** (const SbBool state)\ SbBool **isOverride** (void) const\ void **setNodeType** (const **NodeType** type)\ **NodeType** **getNodeType** (void) const\ virtual **SoNode** \* **copy** (SbBool copyconnections=FALSE) const\ virtual SbBool **affectsState** (void) const\ virtual void **GLRenderBelowPath** (**SoGLRenderAction** \*action)\ virtual void **GLRenderInPath** (**SoGLRenderAction** \*action)\ virtual void **GLRenderOffPath** (**SoGLRenderAction** \*action)\ virtual void **getBoundingBox** (**SoGetBoundingBoxAction** \*action)\ virtual void **getMatrix** (**SoGetMatrixAction** \*action)\ virtual void **handleEvent** (**SoHandleEventAction** \*action)\ virtual void **rayPick** (**SoRayPickAction** \*action)\ virtual void **search** (**SoSearchAction** \*action)\ virtual void **write** (**SoWriteAction** \*action)\ virtual void **audioRender** (**SoAudioRenderAction** \*action)\ virtual void **getPrimitiveCount** (**SoGetPrimitiveCountAction** \*action)\ virtual void **grabEventsSetup** (void)\ virtual void **grabEventsCleanup** (void)\ virtual void **startNotify** (void)\ virtual void **notify** (**SoNotList** \*l)\ SbUniqueId **getNodeId** (void) const\ virtual **SoChildList** \* **getChildren** (void) const\ virtual void **writeInstance** (**SoOutput** \*out)\ virtual **SoNode** \* **addToCopyDict** (void) const\ virtual void **copyContents** (const **SoFieldContainer** \*from, SbBool copyconnections)\ virtual **SoFieldContainer** \* **copyThroughConnection** (void) const\ Public Member Functions inherited from **SoFieldContainer** void **setToDefaults** (void)\ SbBool **hasDefaultValues** (void) const\ SbBool **fieldsAreEqual** (const **SoFieldContainer** \*container) const\ void **copyFieldValues** (const **SoFieldContainer** \*container, SbBool copyconnections=FALSE)\ SbBool **set** (const char \*const fielddata)\ void **get** (**SbString** &fielddata)\ virtual int **getFields** (**SoFieldList** &l) const\ virtual int **getAllFields** (**SoFieldList** &l) const\ virtual **SoField** \* **getField** (const **SbName** &name) const\ virtual **SoField** \* **getEventIn** (const **SbName** &name) const\ virtual **SoField** \* **getEventOut** (const **SbName** &name) const\ SbBool **getFieldName** (const **SoField** \*const field, **SbName** &name) const\ SbBool **enableNotify** (const SbBool flag)\ SbBool **isNotifyEnabled** (void) const\ SbBool **set** (const char \*fielddata, **SoInput** \*input)\ void **get** (**SbString** &fielddata, **SoOutput** \*out)\ virtual SbBool **validateNewFieldValue** (**SoField** \*field, void \*newval)\ virtual void **addWriteReference** (**SoOutput** \*out, SbBool isfromfield=FALSE)\ SbBool **getIsBuiltIn** (void) const\ virtual void **getFieldsMemorySize** (size\_t &managed, size\_t &unmanaged) const\ void **setUserData** (void \*userdata) const\ void \* **getUserData** (void) const\ Public Member Functions inherited from **SoBase** void **ref** (void) const\ void **unref** (void) const\ void **unrefNoDelete** (void) const\ int32\_t **getRefCount** (void) const\ void **touch** (void)\ SbBool **isOfType** (**SoType** type) const\ Returns TRUE if the type of this object is either of the same type or inherited from *type*. virtual **SbName** **getName** (void) const\ virtual void **setName** (const **SbName** &newname)\ void **addAuditor** (void \*const auditor, const **SoNotRec::Type** type)\ void **removeAuditor** (void \*const auditor, const **SoNotRec::Type** type)\ const **SoAuditorList** & **getAuditors** (void) const\ SbBool **shouldWrite** (void)\ void **assertAlive** (void) const\ ### Static Public Member Functions static **SoType** **getClassTypeId** (void)\ static void **initClass** (void)\ Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. Static Public Member Functions inherited from **SoNode** static uint32\_t **getCompatibilityTypes** (const **SoType** &nodetype)\ static **SoType** **getClassTypeId** (void)\ static **SoNode** \* **getByName** (const **SbName** &name)\ static int **getByName** (const **SbName** &name, **SoNodeList** &l)\ static void **initClass** (void)\ Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. static void **initClasses** (void)\ static SbUniqueId **getNextNodeId** (void)\ static int **getActionMethodIndex** (const **SoType** type)\ static void **getBoundingBoxS** (**SoAction** \*action, **SoNode** \*node)\ static void **GLRenderS** (**SoAction** \*action, **SoNode** \*node)\ static void **callbackS** (**SoAction** \*action, **SoNode** \*node)\ static void **getMatrixS** (**SoAction** \*action, **SoNode** \*node)\ static void **handleEventS** (**SoAction** \*action, **SoNode** \*node)\ static void **pickS** (**SoAction** \*action, **SoNode** \*node)\ static void **rayPickS** (**SoAction** \*action, **SoNode** \*node)\ static void **searchS** (**SoAction** \*action, **SoNode** \*node)\ static void **writeS** (**SoAction** \*action, **SoNode** \*node)\ static void **audioRenderS** (**SoAction** \*action, **SoNode** \*node)\ static void **getPrimitiveCountS** (**SoAction** \*action, **SoNode** \*node)\ Static Public Member Functions inherited from **SoFieldContainer** static void **initClass** (void)\ Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. static **SoType** **getClassTypeId** (void)\ This static method returns the **SoType** object associated with objects of this class. static void **cleanupClass** (void)\ static void **initCopyDict** (void)\ static void **addCopy** (const **SoFieldContainer** \*orig, const **SoFieldContainer** \*copy)\ static **SoFieldContainer** \* **checkCopy** (const **SoFieldContainer** \*orig)\ static **SoFieldContainer** \* **findCopy** (const **SoFieldContainer** \*orig, const SbBool copyconnections)\ static void **copyDone** (void)\ Static Public Member Functions inherited from **SoBase** static void **initClass** (void)\ Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. static **SoType** **getClassTypeId** (void)\ This static method returns the **SoType** object associated with objects of this class. static void **addName** (**SoBase** \*const base, const char \*const name)\ static void **removeName** (**SoBase** \*const base, const char \*const name)\ static void **incrementCurrentWriteCounter** (void)\ static void **decrementCurrentWriteCounter** (void)\ static **SoBase** \* **getNamedBase** (const **SbName** &name, **SoType** type)\ static int **getNamedBases** (const **SbName** &name, **SoBaseList** &baselist, **SoType** type)\ static SbBool **read** (**SoInput** \*input, **SoBase** \*&base, **SoType** expectedtype)\ static void **setInstancePrefix** (const **SbString** &c)\ static void **setTraceRefs** (SbBool trace)\ static SbBool **getTraceRefs** (void)\ static SbBool **connectRoute** (**SoInput** \*input, const **SbName** &fromnodename, const **SbName** &fromfieldname, const **SbName** &tonodename, const **SbName** &tofieldname)\ static SbBool **readRoute** (**SoInput** \*input)\ ### Public Attributes **SoMFEnum** **rgbSource**\ **SoMFEnum** **alphaSource**\ **SoMFEnum** **rgbOperand**\ **SoMFEnum** **alphaOperand**\ **SoSFEnum** **rgbOperation**\ **SoSFEnum** **alphaOperation**\ **SoSFFloat** **rgbScale**\ **SoSFFloat** **alphaScale**\ **SoSFVec4f** **constantColor**\ ### Protected Member Functions virtual const **SoFieldData** \* **getFieldData** (void) const\ virtual **~SoTextureCombine** ()\ Protected Member Functions inherited from **SoNode** **SoNode** (void)\ virtual **~SoNode** ()\ virtual SbBool **readInstance** (**SoInput** \*in, unsigned short flags)\ Protected Member Functions inherited from **SoFieldContainer** **SoFieldContainer** (void)\ virtual **~SoFieldContainer** ()\ Protected Member Functions inherited from **SoBase** **SoBase** (void)\ virtual **~SoBase** ()\ virtual void **destroy** (void)\ SbBool **hasMultipleWriteRefs** (void) const\ SbBool **writeHeader** (**SoOutput** \*out, SbBool isgroup, SbBool isengine) const\ void **writeFooter** (**SoOutput** \*out) const\ virtual const char \* **getFileFormatName** (void) const\ virtual **SoNotRec** **createNotRec** (void)\ ### Static Protected Member Functions static const **SoFieldData** \*\* **getFieldDataPtr** (void)\ Static Protected Member Functions inherited from **SoNode** static const **SoFieldData** \*\* **getFieldDataPtr** (void)\ static void **setNextActionMethodIndex** (int index)\ static int **getNextActionMethodIndex** (void)\ static void **incNextActionMethodIndex** (void)\ static void **setCompatibilityTypes** (const **SoType** &nodetype, const uint32\_t bitmask)\ Static Protected Member Functions inherited from **SoBase** static uint32\_t **getCurrentWriteCounter** (void)\ static void **staticDataLock** (void)\ static void **staticDataUnlock** (void)\ ### Additional Inherited Members Protected Types inherited from **SoBase** enum **BaseFlags** { **IS\_ENGINE** = 0x01, **IS\_GROUP** = 0x02 }\ Protected Attributes inherited from **SoNode** SbUniqueId **uniqueId**\ Protected Attributes inherited from **SoFieldContainer** SbBool **isBuiltIn**\ Static Protected Attributes inherited from **SoNode** static SbUniqueId **nextUniqueId** = 1\ static int **nextActionMethodIndex** = 0\ ## Detailed Description The **SoTextureCombine** class is a node for setting texture combine functions. This node is more or less an exact mapping of the OpenGL ARB\_texture\_env\_combine extension (included in OpenGL in OpenGL v1.3). See http://oss.sgi.com/projects/ogl-sample/registry/ARB/texture\_env\_combine.txt for more information about this extension. Basically this node lets you specify up to three sources, and a function to combine those sources. In addition to the function, it is possible to apply simple operands on the sources. In the documentation below, the sources will be called Arg0, Arg1, and Arg2, just like in the ARB\_texture\_env\_mode specification. It's possible to specify both a color and an alpha operation. This node has many fields, but usually it is sufficient to set only one or very few fields. The selected operation decides which values you need to set. One common example is to add a light map to textured geometry. A light map can look like this: The example below just shows how to apply the light map to a cube, with one light source on each side of the cube. Usually the texture coordinates are calculated so that a spot light or a point light is simulated. ``` Texture2 { filename "wood.jpg" } Switch { whichChild -3 # use to toggle light map on/off TextureUnit { unit 1 } TextureCombine { rgbOperation ADD_SIGNED rgbSource [PREVIOUS, TEXTURE] rgbOperand [SRC_COLOR, SRC_COLOR ] alphaOperation REPLACE alphaSource [TEXTURE] alphaOperand [SRC_ALPHA] } Texture2 { filename "lightmap.jpg" } TextureUnit { unit 0 } } Cube { } ``` The scene above in a viewer: In addition to the functions you can set in rgbOperation (or alphaOperation), it's possible to create more complex texture functions by combining two textures that have already been combined. You can use the **SoSceneTexture2** node to create those textures. Below is an example that shows how to implement Arg0\*Arg1 - • Arg2\*Arg0, where Arg0 = texture1 RGB, Arg1 = texture2 RGB, Arg2 = texture 2 alpha: ``` ShapeHints { vertexOrdering COUNTERCLOCKWISE shapeType SOLID } Separator { SceneTexture2 { size 256 256 transparencyFunction NONE scene Separator { OrthographicCamera { height 2 aspectRatio 1 position 0 0 1 viewportMapping LEAVE_ALONE } LightModel { model BASE_COLOR } Coordinate3 { point [ -1 -1 0, 1 -1 0, 1 1 0, -1 1 0 ] } DEF texture1 Texture2 { filename "texture1.png" } TextureUnit { unit 1 } TextureCombine { rgbOperation MODULATE rgbSource [ PREVIOUS, TEXTURE ] rgbOperand [ SRC_COLOR, SRC_COLOR ] alphaOperation REPLACE alphaSource [TEXTURE] alphaOperand [ SRC_ALPHA ] } DEF texture2 Texture2 { filename "texture2_with_alpha.png" } TextureCoordinate2 { point [0 0, 1 0, 1 1, 0 1] } FaceSet { numVertices 4 } } } TextureUnit { unit 1 } TextureCombine { rgbOperation ADD rgbSource [ PREVIOUS, TEXTURE ] rgbOperand [ SRC_COLOR, SRC_COLOR ] alphaOperation REPLACE alphaSource [TEXTURE] alphaOperand [ SRC_ALPHA ] } SceneTexture2 { size 256 256 transparencyFunction NONE scene Separator { OrthographicCamera { height 2 aspectRatio 1 position 0 0 1 viewportMapping LEAVE_ALONE } LightModel { model BASE_COLOR } Coordinate3 { point [ -1 -1 0, 1 -1 0, 1 1 0, -1 1 0 ] } USE texture1 TextureUnit { unit 1 } TextureCombine { rgbOperation MODULATE rgbSource [ PREVIOUS, TEXTURE ] rgbOperand [ SRC_COLOR, SRC_ALPHA ] alphaOperation REPLACE alphaSource [TEXTURE] alphaOperand [ SRC_ALPHA ] } USE texture2 TextureCoordinate2 { point [0 0, 1 0, 1 1, 0 1] } FaceSet { numVertices 4 } } } # map resulting texture onto a Cube Cube { } } ``` It should be possible to create almost any kind of texture function using this scheme, at the cost of extra texture memory usage (the intermediate textures), of course. **FILE FORMAT/DEFAULTS:** ``` TextureCombine { rgbSource [ ] alphaSource [ ] rgbOperand [ ] alphaOperand [ ] rgbOperation MODULATE alphaOperation MODULATE rgbScale 1 alphaScale 1 constantColor 1 1 1 1 } ``` **Since** Coin 2.3 ## Member Enumeration Documentation ### enum SoTextureCombine::Source For enumerating combiner sources. **Enumerator** - ***PRIMARY\_COLOR*** Choose primary color as source. - ***TEXTURE*** Choose texture as source. - ***CONSTANT*** Choose the constantColor field as source. - ***PREVIOUS*** Choose the previous unit's texture as source. ### enum SoTextureCombine::Operand For enumerating source operands. **Enumerator** - ***SRC\_COLOR*** Use the source color as operand. - ***ONE\_MINUS\_SRC\_COLOR*** Use one minus source color as operand. - ***SRC\_ALPHA*** Use the source alpha as operand. - ***ONE\_MINUS\_SRC\_ALPHA*** Use one minus source alpha as operand. ### enum SoTextureCombine::Operation For enumerating combiner operations/functions. **Enumerator** - ***REPLACE*** dst = Arg0 - ***MODULATE*** dst = Arg0 \* Arg1 - ***ADD*** dst = Arg0 + Arg1 - ***ADD\_SIGNED*** dst = Arg0 + Arg1 - 0.5 - ***SUBTRACT*** dst = Arg0 - Arg1 - ***INTERPOLATE*** dst = Arg0 \* (Arg2) + Arg1 \* (1-Arg2) - ***DOT3\_RGB*** Dot product of Arg0 and Arg1 - ***DOT3\_RGBA*** Dot product (including alpha) of Arg0 and Arg1 ## Constructor & Destructor Documentation ### SoTextureCombine::SoTextureCombine (void ) Constructor. ### SoTextureCombine::~SoTextureCombine () \[protected\], \[virtual\] Destructor. ## Member Function Documentation ### SoType SoTextureCombine::getClassTypeId (void ) \[static\] SoTextureCombine::rgbSource The color sources. This field is empty by default, but you can insert up to three values \[Arg0, Arg1, Arg2\]. When the field contains less than three values, the default \[TEXTURE, PREVIOUS, CONSTANT\], will be used for missing values. For texture unit 0, PREVIOUS maps to PRIMARY\_COLOR, SoTextureCombine::alphaSource The alpha sources. This field is empty by default, but you can insert up to three values \[Arg0, Arg1, Arg2\]. When the field contains less than three values, the default \[TEXTURE, PREVIOUS, CONSTANT\], will be used for missing values. For texture unit 0, PREVIOUS maps to PRIMARY\_COLOR, SoTextureCombine::rgbOperand The color operands. This field is empty by default, but you can insert up to three values. When the field contains less than three values, the default \[SRC\_COLOR, SRC\_COLOR, SRC\_COLOR\] will be used for missing values. SoTextureCombine::alphaOperand The alpha operands. This field is empty by default, but you can insert up to three values. When the field contains less than three values, the default \[SRC\_ALPHA, SRC\_ALPHA, SRC\_ALPHA\] will be used for missing values. Please not that only SRC\_ALPHA and ONE\_MINUS\_SRC\_ALPHA are valid operands for alpha operations. SoTextureCombine::rgbOperation The color operation. Default value is MODULATE. SoTextureCombine::alphaOperation The alpha operation. Default value is MODULATE. SoTextureCombine::rgbScale Scale color result by this value. Supported values are 1, 2, and 4. SoTextureCombine::alphaScale Scale alpha result by this value. Supported values are 1, 2, and 4. SoTextureCombine::constantColor The constant color (when CONSTANT is used as source). Default value is (1,1,1,1). This static method returns the **SoType** object associated with objects of this class. ### SoType SoTextureCombine::getTypeId (void ) const \[virtual\] Returns the type identification of an object derived from a class inheriting **SoBase**. This is used for runtime type checking and "downward" casting. Implements **SoBase**. ### const SoFieldData \*\* SoTextureCombine::getFieldDataPtr (void ) \[static\], \[protected\] *This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.*\ Returns the **SoFieldData** class which holds information about fields in this node. ### const SoFieldData \* SoTextureCombine::getFieldData (void ) const \[protected\], \[virtual\] Returns a pointer to the class-wide field data storage object for this instance. If no fields are present, returns NULL. Reimplemented from **SoFieldContainer**. ### void SoTextureCombine::doAction (SoAction \* action) \[virtual\] This function performs the typical operation of a node for any action. Reimplemented from **SoNode**. ### void SoTextureCombine::callback (SoCallbackAction \* action) \[virtual\] Action method for **SoCallbackAction**. Simply updates the state according to how the node behaves for the render action, so the application programmer can use the **SoCallbackAction** for extracting information about the scene graph. Reimplemented from **SoNode**. ### void SoTextureCombine::GLRender (SoGLRenderAction \* action) \[virtual\] Action method for the **SoGLRenderAction**. This is called during rendering traversals. Nodes influencing the rendering state in any way or want to throw geometry primitives at OpenGL override this method. Reimplemented from **SoNode**. ### void SoTextureCombine::pick (SoPickAction \* action) \[virtual\] Action method for **SoPickAction**. Does common processing for **SoPickAction** *action* instances. Reimplemented from **SoNode**. ## Author Generated automatically by Doxygen for Coin from the source code.