SoTextureUnitElement.h

/*=======================================================================
 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.),            ***
 ***              AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT.                     ***
 ***                                                                                ***
 ***  REPRODUCTION, DISCLOSURE,  OR USE,  IN WHOLE OR IN PART,  OTHER THAN AS       ***
 ***  SPECIFIED  IN THE LICENSE ARE  NOT TO BE  UNDERTAKEN  EXCEPT WITH PRIOR       ***
 ***  WRITTEN AUTHORIZATION OF FEI S.A.S.                                           ***
 ***                                                                                ***
 ***                        RESTRICTED RIGHTS LEGEND                                ***
 ***  USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS      ***
 ***  WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN      ***
 ***  SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT      ***
 ***  CLAUSE  AT FAR 52.227-19  OR SUBPARAGRAPH  (C)(1)(II)  OF  THE RIGHTS IN      ***
 ***  TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013.             ***
 ***                                                                                ***
 ***                   COPYRIGHT (C) 1996-2020 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : R. ALBOU (May 2002)
**=======================================================================*/
 
#ifndef  _SO_TEXTURE_UNIT_ELEMENT_
#define  _SO_TEXTURE_UNIT_ELEMENT_
 
#include <Inventor/SbPList.h>
#include <Inventor/elements/SoAccumulatedElement.h>
 
#ifdef _MSC_VER
#pragma warning( push )
#pragma warning(disable:4251)
#endif

 
SoEXTENDER_Documented class  SoTextureUnitElement : public SoAccumulatedElement {
  SO_ELEMENT_HEADER(SoTextureUnitElement) ;
 
 public:
  static void set(SoState *state, SoNode *node, int unit) ;

  static SbBool activateTextureUnit(SoState *state, int unit) ;

  virtual void push(SoState *state) ;

  virtual void pop(SoState *, const SoElement *prevTopElement) ;

  static const SbIntList& getTextureUnits(SoState *state) ;

  static int getActiveTextureUnit(SoState *state) ;

  static int getMaxTextureUnit(SoState* state=NULL) ;

  static SbBool isMultiTexturing(SoState *state, SbIntList &imageTexUnitList) ;
 
private:

  virtual void commonInit();

  virtual void init(SoState *state);
 
private:
 
  // Initializes the SoTextureUnitElement class
  static void initClass() ;
  static void exitClass() ;

  static uint32_t getFixedPipelineMaxTextureUnit(SoState* state) ;

  static bool isActiveTextureUnitInFixedPipeline(SoState* state);

  static SbBool isMultitexturingAvailable(SoState* state);
 
 private:
  // Sets the element
  virtual void setElt(SoState* state, SoNode *node, const int unit) ;
  virtual void setUnit(SoState* state, const int unit);
 
  int       m_startIndex ;
  int       m_textureUnit ;
 
  // List of texture units
  SbIntList m_textureUnits ;
 
  virtual ~SoTextureUnitElement() ;
 
  virtual SbBool matches(const SoElement* element) const;
  virtual SoElement* copyMatchInfo() const;
 
private:
  // used to indicate that multitexturing has been disable through OIV_MULTITEXTURING envvar
  static SbBool s_multiTexturingAllowed;
} ;
/*----------------------------------------------------------------------------*/
 
#ifdef _MSC_VER
#pragma warning( pop )
#endif
 
#endif // _SO_TEXTURE_UNIT_ELEMENT_