SoTextureCombine(3)

📦 version 2.5.0, in fedora 43, fedora 44

💖 SoTextureCombine(3) 💖

okay so bestie, welcome to the SoTextureCombine(3) page from the Library Functions Manual ✨ this is the one about setting texture combine functions, and yes it's long, and yes we're doing it together. grab a snack 🍓

✨ NAME ✨

SoTextureCombine — the class that's literally a node for setting texture combine functions. that's the whole vibe. 👑

🦋 SYNOPSIS 🦋

#include <Inventor/nodes/SoTextureCombine.h>
heads up: it Inherits SoNode 💅

🌸 Public Types 🌸

✨ Source ✨

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

✨ Operand ✨

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
}

✨ Operation ✨

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 — with all the values, and yes we're listing every single one because we don't skip:
    • 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

🎀 Public Member Functions 🎀

  • virtual SoType getTypeId(void) const — the classic "what even am i" type check 💅
  • SoTextureCombine(void) — the constructor, your entry point bestie
  • 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=0) 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=0)
  • 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 *in)
  • void get(SbString &fielddata, SoOutput *out)
  • virtual SbBool validateNewFieldValue(SoField *field, void *newval)
  • virtual void addWriteReference(SoOutput *out, SbBool isfromfield=0)
  • SbBool getIsBuiltIn(void) 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 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 *in, SoBase *&base, SoType expectedtype)
  • static void setInstancePrefix(const SbString &c)
  • static void setTraceRefs(SbBool trace)
  • static SbBool getTraceRefs(void)
  • static SbBool connectRoute(SoInput *in, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname)
  • static SbBool readRoute(SoInput *in)

🌸 Public Attributes 🌸

these are the actual fields, the main characters of the whole node fr fr:

  • 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() — the destructor, protected, do not touch unless you're the class itself 💅

🌸 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)
  • ~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 = 0
  • static int nextActionMethodIndex = 0
okay and that's the end of part 1 bestie!! 🫶 the page keeps going, so don't go anywhere — more parts are literally right there. no cap. 💅

✨ 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. no cap, it's literally the spec vibe ✨

Basically this node lets you specify up to three sources, and a function to combine those sources. In addition to the function, it's 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. bestie, remember those names 💅

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 lightmap can look like this: (imagine a cozy glow map, okay?)

The example below just shows how to apply the lightmap 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 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: ✨ imagine the glow-up ✨

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.

References ADD, ADD_SIGNED, CONSTANT, DOT3_RGB, DOT3_RGBA, INTERPOLATE, MODULATE, ONE_MINUS_SRC_ALPHA, ONE_MINUS_SRC_COLOR, PREVIOUS, PRIMARY_COLOR, REPLACE, SoTextureCombine(), SRC_ALPHA, SRC_COLOR, SUBTRACT, and TEXTURE.

Referenced by getClassTypeId(), and SoTextureCombine().

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

Destructor.

✨ Member Function Documentation ✨

okay bestie, this is the part where we go through every single member function. no skipping, no summarizing, we're doing the whole thing 💅

SoType SoTextureCombine::getClassTypeId (void ) [static]

so like, here's the static getClassTypeId signature, and then Doxygen just... dumped all the field docs right underneath it? iconic behavior tbh. anyway, let's roll with it. here are the fields, exactly as they appear:

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.

yes, "Please not" is a typo in the original, and we are keeping it because facts are facts, bestie 💀

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).

References SoTextureCombine().

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

Returns the type identification of an object derived from a class inheriting SoBase. This is used for run-time type checking and "downward" casting.

Usage example:

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

For application programmers wanting to extend the library with new nodes, engines, nodekits, draggers or others: 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 information on writing Coin extensions, see 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 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.

References SoAction::getState(), SbColor4f::getValue(), and SbVec4f::getValue().

Referenced by GLRender().

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.

References SoNode::callback().

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 who wants to throw geometry primitives at OpenGL overrides this method.

Reimplemented from SoNode.

References doAction(), DOT3_RGB, DOT3_RGBA, SoGLRenderAction::getCacheContext(), and SoDebugError::postWarning().

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

Action method for SoPickAction.

Does common processing for SoPickAction action instances.

Reimplemented from SoNode.

References SoNode::pick().

Author

Generated automatically by Doxygen for Coin from the source code.

and that's a wrap, bestie! this whole page is from Coin, version 2.5.0, and it's the SoTextureCombine(3) manpage. mwah 💋✨

📦 where this page comes from