include/opencascade/Graphic3d_AlphaMode.hxx

0001 // Copyright (c) 2018 OPEN CASCADE SAS
0002 //
0003 // This file is part of Open CASCADE Technology software library.
0004 //
0005 // This library is free software; you can redistribute it and/or modify it under
0006 // the terms of the GNU Lesser General Public License version 2.1 as published
0007 // by the Free Software Foundation, with special exception defined in the file
0008 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0009 // distribution for complete text of the license and disclaimer of any warranty.
0010 //
0011 // Alternatively, this file may be used under the terms of Open CASCADE
0012 // commercial license or contractual agreement.
0013
0014 #ifndef _Graphic3d_AlphaMode_HeaderFile
0015 #define _Graphic3d_AlphaMode_HeaderFile
0016
0017 //! Defines how alpha value of base color / texture should be treated.
0018 enum Graphic3d_AlphaMode
0019 {
0020   Graphic3d_AlphaMode_Opaque = 0, //!< rendered output is fully opaque and alpha value is ignored
0021   Graphic3d_AlphaMode_Mask,       //!< rendered output is either fully opaque or fully transparent
0022                                   //!< depending on the alpha value and the alpha cutoff value
0023   Graphic3d_AlphaMode_Blend,      //!< rendered output is combined with the background
0024   Graphic3d_AlphaMode_MaskBlend,  //!< performs in-place blending (without implicit reordering of
0025                                   //!< opaque objects) with alpha-test
0026
0027   Graphic3d_AlphaMode_BlendAuto =
0028     -1, //!< special value defined for backward compatibility - it is equal to
0029         //!< Graphic3d_AlphaMode_Blend when Material transparency is not zero and
0030         //!< Graphic3d_AlphaMode_Opaque otherwise;
0031         //   since this check ignores possible transparency defined by per-vertex colors and
0032         //   textures - NOT recommended to use!
0033 };
0034
0035 #endif // _Graphic3d_AlphaModeHeaderFile