src/Graphic3d/Graphic3d_AlphaMode.hxx

   1 // Copyright (c) 2018 OPEN CASCADE SAS
   2 //
   3 // This file is part of Open CASCADE Technology software library.
   4 //
   5 // This library is free software; you can redistribute it and/or modify it under
   6 // the terms of the GNU Lesser General Public License version 2.1 as published
   7 // by the Free Software Foundation, with special exception defined in the file
   8 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
   9 // distribution for complete text of the license and disclaimer of any warranty.
  10 //
  11 // Alternatively, this file may be used under the terms of Open CASCADE
  12 // commercial license or contractual agreement.
  13
  14 #ifndef _Graphic3d_AlphaMode_HeaderFile
  15 #define _Graphic3d_AlphaMode_HeaderFile
  16
  17 //! Defines how alpha value of base color / texture should be treated.
  18 enum Graphic3d_AlphaMode
  19 {
  20   Graphic3d_AlphaMode_Opaque = 0,     //!< rendered output is fully opaque and alpha value is ignored
  21   Graphic3d_AlphaMode_Mask,           //!< rendered output is either fully opaque or fully transparent depending on the alpha value and the alpha cutoff value
  22   Graphic3d_AlphaMode_Blend,          //!< rendered output is combined with the background
  23   Graphic3d_AlphaMode_MaskBlend,      //!< performs in-place blending (without implicit reordering of opaque objects) with alpha-test
  24
  25   Graphic3d_AlphaMode_BlendAuto = -1, //!< special value defined for backward compatibility - it is equal to Graphic3d_AlphaMode_Blend when Material transparency is not zero and Graphic3d_AlphaMode_Opaque otherwise;
  26                                       //   since this check ignores possible transparency defined by per-vertex colors and textures - NOT recommended to use!
  27 };
  28
  29 #endif // _Graphic3d_AlphaModeHeaderFile