SoTextureCombine(3)

📦 version 3.1.3, in fedora 43, fedora 44

🌸 NAME 🌸

SoTextureCombine — bestie, this is the node for setting texture combine functions. That's it, that's the whole job. She's a node. She combines. She serves. 💅

✨ Heads up, this page is long so it comes in 2 parts and this is part 1. More coming, don't go anywhere. 🫶

✨ SYNOPSIS ✨

#include <Inventor/nodes/SoTextureCombine.h>

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 }

🌈 Public Member Functions 🌈

The main character methods, right here. 👑

  • virtual SoType getTypeId (void) const — grab the type id, iconic.
  • SoTextureCombine (void) — the constructor, your entry point fr fr.
  • virtual void doAction (SoAction *action) — do the action thing.
  • virtual void callback (SoCallbackAction *action) — callback behaviour, slay.
  • virtual void GLRender (SoGLRenderAction *action) — the render moment ✨
  • virtual void pick (SoPickAction *action) — picking, as one does.

🧚 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)
  • uint32_t 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
  • 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)

💫 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)
  • static void initClasses (void)
  • static uint32_t 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)
  • static SoType getClassTypeId (void)
  • 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)
  • static SoType getClassTypeId (void)
  • 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 👑

These are the fields, bestie. The actual data. Periodt.

  • 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

✨ 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

  • uint32_t uniqueId

Protected Attributes inherited from SoFieldContainer

  • SbBool isBuiltIn

Static Protected Attributes inherited from SoNode

  • static uint32_t nextUniqueId = 1
  • static int nextActionMethodIndex = 0
💀 Okay bestie that was a LOT of inherited stuff, but we got through it. Part 2 has more, so keep scrolling, don't leave me hanging. 🧚

✨ DETAILED DESCRIPTION ✨

okay so bestie, SoTextureCombine is the node that sets your texture combine functions. that's it, that's the whole vibe. 💅

this node is basically a one-to-one mapping of the OpenGL ARB_texture_env_combine extension — the one that got folded into core OpenGL at OpenGL v1.3. if you want the receipts, they're at http://oss.sgi.com/projects/ogl-sample/registry/ARB/texture_env_combine.txt. go read it, it's giving lore. 📜

so the tl;dr: this node lets you pick up to three sources, plus a function that combines them. and on top of the function, you can slap simple operands onto each source. in the docs below the sources are called Arg0, Arg1 and Arg2, exactly like in the ARB_texture_env_mode spec — no cap, same names. 🫶

you can set a color operation and an alpha operation. both. independently. iconic.

this node has so many fields but honestly? usually you set like one field, or barely any. the operation you pick decides which values actually matter. the classic example is adding a lightmap to textured geometry — a lightmap can look like this:

and the example below shows how to apply that lightmap to a cube, with one light source on each side of the cube. normally the texture coordinates are calculated so a spot light or a point light is simulated. ✨

Texture2 { filename "wood.jpg" }

Switch {
  whichChild -3   # use to toggle lightmap 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 hey — beyond the functions you can set in rgbOperation (or alphaOperation), you can build more complex texture functions by combining two textures that have already been combined. for that you 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 { }
}

you can lowkey create almost any kind of texture function with this scheme — the price tag being extra texture memory usage from all those intermediate textures, obviously. 💀

🌸 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, bestie. ✨

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

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

destructor. she's protected, she's virtual, she's leaving. 😭

👑 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 holds fewer than three values, the default [TEXTURE, PREVIOUS, CONSTANT] gets used for the missing ones. 💖

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 holds fewer than three values, the default [TEXTURE, PREVIOUS, CONSTANT] gets used for the missing ones. 💖

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 holds fewer than three values, the default [SRC_COLOR, SRC_COLOR, SRC_COLOR] gets used for the missing ones.

SoTextureCombine::alphaOperand

the alpha operands. this field is empty by default, but you can insert up to three values. when the field holds fewer than three values, the default [SRC_ALPHA, SRC_ALPHA, SRC_ALPHA] gets used for the missing ones. please note 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).

SoType SoTextureCombine::getTypeId (void ) const [virtual]

returns the type identification of an object derived from a class inheriting SoBase. this is what you use for run-time type checking and "downward" casting. iykyk. 🧚

usage example:

void foo(SoNode * node)
{
  if (node->getTypeId() == SoFile::getClassTypeId()) {
    SoFile * filenode = (SoFile *)node;  // safe downward cast, knows the type
  }
}

for the application programmers out there who wanna extend the library with new nodes, engines, nodekits, draggers or whatever: this method needs to be overridden in all subclasses. this is typically done as part of setting up the full type system for extension classes, which is usually accomplished by using the pre-defined macros available through, for instance, Inventor/nodes/SoSubNode.h (SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine.h (for engine classes) and so on.

for more info on writing Coin extensions, go look at the class documentation of the toplevel superclasses for the various class groups. 📚

implements SoBase.

const SoFieldData * SoTextureCombine::getFieldData (void ) const [protected], [virtual]

returns a pointer to the class-wide field data storage object for this instance. if there are no fields present, it returns NULL. simple as that. ✨

reimplemented from SoFieldContainer.

void SoTextureCombine::doAction (SoAction * action) [virtual]

this function performs the typical operation of a node for any action. any action. periodt.

reimplemented from SoNode.

void SoTextureCombine::callback (SoCallbackAction * action) [virtual]

action method for SoCallbackAction. 🌈

it 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 gets called during rendering traversals. nodes that influence the rendering state in any way, or that wanna throw geometry primitives at OpenGL, override this method.

reimplemented from SoNode.

void SoTextureCombine::pick (SoPickAction * action) [virtual]

action method for SoPickAction. 👑

does the common processing for SoPickAction action instances.

reimplemented from SoNode.

💜 AUTHOR 💜

generated automatically by Doxygen for Coin from the source code.

and that's the whole page bestie, we ate and left no crumbs 🍓 this was Doxygen-generated for Coin from the source code, it's Coin Version 3.1.3, and the page you're reading is SoTextureCombine(3). mwah, go forth and combine those textures 💖✨

📦 where this page comes from