SoTextureCombine(3)

📦
version 4.0.10 · 4 versions
, in fedora 43, fedora 44

💖 NAME 💖

SoTextureCombine — the node for setting texture combine functions. that's the whole job description bestie, and she ate 💅

🦋 SYNOPSIS 🦋

first things first, you gotta invite her in:

#include <Inventor/nodes/SoTextureCombine.h>

and she Inherits SoNode, so everything SoNode can do, she can do too. nepotism but make it class hierarchy ✨

🌸 Public Types 🌸

three enums, all absolute icons. no notes.

enum Source — where the colour is coming from:

enum Source {
  PRIMARY_COLOR = SoTextureCombineElement::PRIMARY_COLOR,
  TEXTURE = SoTextureCombineElement::TEXTURE,
  CONSTANT = SoTextureCombineElement::CONSTANT,
  PREVIOUS = SoTextureCombineElement::PREVIOUS
}

enum Operand — how we're using that colour:

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 — the actual math, the main character moment:

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

she also got handed this whole enum from SoNode, look at it, it's giving ✨legacy✨:

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 🎀

her own personal menu:

  • virtual SoType getTypeId (void) const — her ID card, virtual edition
  • SoTextureCombine (void) — the constructor, no arguments, no drama
  • virtual void doAction (SoAction *action) — do the thing when an action rolls up
  • virtual void callback (SoCallbackAction *action) — callback time
  • virtual void GLRender (SoGLRenderAction *action) — the render, the moment, the serve 🔥
  • virtual void pick (SoPickAction *action) — picking, for when someone's clicking on stuff

Public Member Functions inherited from SoNode

everything she got from SoNode, all of it, no skipping:

  • 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

the field-container side of the family:

  • 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

and the OG base class, the grandmother of them all:

  • 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 👑

her actual settings, the knobs and dials bestie:

  • SoMFEnum rgbSource
  • SoMFEnum alphaSource
  • SoMFEnum rgbOperand
  • SoMFEnum alphaOperand
  • SoSFEnum rgbOperation
  • SoSFEnum alphaOperation
  • SoSFFloat rgbScale
  • SoSFFloat alphaScale
  • SoSFVec4f constantColor

🔒 Protected Member Functions 🔒

for the class's own business, not yours (no offence):

  • virtual const SoFieldData * getFieldData (void) const
  • virtual ~SoTextureCombine () — the destructor, protected, she goes out quietly

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 🌈

the bonus content, the deluxe edition, the little extras she got in the will 🎀

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 💖

okay so bestie, the SoTextureCombine class is a node for setting texture combine functions. that's the whole vibe. ✨

this node is more or less an exact mapping of the OpenGL ARB_texture_env_combine extension (which got folded into OpenGL in OpenGL v1.3, so it's giving legacy-but-iconic). if you want the full lore, the extension spec lives at http://oss.sgi.com/projects/ogl-sample/registry/ARB/texture_env_combine.txt 🦋

basically? this node lets you specify up to three sources, plus a function that combines them. and on top of the function you can also slap simple operands on the sources. in the docs below the sources get called Arg0, Arg1, and Arg2 — same naming as the ARB_texture_env_mode specification, iykyk.

you can specify both a color operation and an alpha operation. both. at once. slay.

this node has SO many fields, but honestly? usually it's enough to set one or very few of them. the operation you pick decides which values you actually need to set. one super common example is adding 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:

and here's the tea — besides the functions you can set in rgbOperation (or alphaOperation), you can build more complex texture functions by combining two textures that have <em>already</em> been combined. use the SoSceneTexture2 node to make those textures. below is an example showing 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 from the intermediate textures, of course. nothing in this life is free bestie 😭

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. (yes, it's exactly what it sounds like 💅)

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. this is the math part, stay with me 🧚

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. the birth. the origin story. 🌱

SoTextureCombine::~SoTextureCombine () [protected], [virtual]

destructor. rip bestie 🫡

✨ 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] gets used for the missing values. no cap.

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] gets used for the 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 the 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 the 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. (mind your business basically 🙈)

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 that 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. yes, the docs wrote themselves, main character energy fr fr 💅

and that's a wrap on SoTextureCombine(3) bestie!! this page was Version 4.0.10, dated Thu Jun 25 2026 00:00:00, straight from the Coin source code. go forth and combine those textures, you absolute icon 🎀✨🦋💖

📦 where this page comes from