BlendFunc type refactor, GLenum -> backend::BlendFactor (cocos2d#167)

* BlendFunc use backend::BlendFactor as inner field

* update comments

* use int to replace GLenum

* update xcode project fiel

* rename to GLBlendConst

* add ccConstants.h

* update xcode project file

* update copyright

Author: PatriceJiang

.gitignore

@@ -169,3 +169,4 @@ cmake-build-*/
 .vs
 cmake_build*
 metal-support*.zip
+**/.project

build/cocos2d_libs.xcodeproj/project.pbxproj

@@ -2090,6 +2090,9 @@
 		ED682BC1213F63CB001BF6CB /* libuv_a.a in Frameworks */ = {isa = PBXBuildFile; fileRef = ED682BC0213F63CB001BF6CB /* libuv_a.a */; };
 		ED682BC3213F6C7A001BF6CB /* libwebsockets.a in Frameworks */ = {isa = PBXBuildFile; fileRef = ED682BC2213F6C7A001BF6CB /* libwebsockets.a */; };
 		ED682BC5213F6CBF001BF6CB /* libuv_a.a in Frameworks */ = {isa = PBXBuildFile; fileRef = ED682BC4213F6CBE001BF6CB /* libuv_a.a */; };
+		ED75D42021E3030E0052B87E /* ccConstants.h in Headers */ = {isa = PBXBuildFile; fileRef = ED75D41F21E3030E0052B87E /* ccConstants.h */; };
+		ED75D42121E303160052B87E /* ccConstants.h in Headers */ = {isa = PBXBuildFile; fileRef = ED75D41F21E3030E0052B87E /* ccConstants.h */; };
+		ED75D42221E303160052B87E /* ccConstants.h in Headers */ = {isa = PBXBuildFile; fileRef = ED75D41F21E3030E0052B87E /* ccConstants.h */; };
 		ED9C6A9418599AD8000A5232 /* CCNodeGrid.cpp in Sources */ = {isa = PBXBuildFile; fileRef = ED9C6A9218599AD8000A5232 /* CCNodeGrid.cpp */; };
 		ED9C6A9518599AD8000A5232 /* CCNodeGrid.cpp in Sources */ = {isa = PBXBuildFile; fileRef = ED9C6A9218599AD8000A5232 /* CCNodeGrid.cpp */; };
 		ED9C6A9618599AD8000A5232 /* CCNodeGrid.h in Headers */ = {isa = PBXBuildFile; fileRef = ED9C6A9318599AD8000A5232 /* CCNodeGrid.h */; };
@@ -3340,6 +3343,7 @@
 		ED682BC0213F63CB001BF6CB /* libuv_a.a */ = {isa = PBXFileReference; lastKnownFileType = archive.ar; name = libuv_a.a; path = ../external/uv/prebuilt/ios/libuv_a.a; sourceTree = "<group>"; };
 		ED682BC2213F6C7A001BF6CB /* libwebsockets.a */ = {isa = PBXFileReference; lastKnownFileType = archive.ar; name = libwebsockets.a; path = ../external/websockets/prebuilt/tvos/libwebsockets.a; sourceTree = "<group>"; };
 		ED682BC4213F6CBE001BF6CB /* libuv_a.a */ = {isa = PBXFileReference; lastKnownFileType = archive.ar; name = libuv_a.a; path = ../external/uv/prebuilt/tvos/libuv_a.a; sourceTree = "<group>"; };
+		ED75D41F21E3030E0052B87E /* ccConstants.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = ccConstants.h; path = ../base/ccConstants.h; sourceTree = "<group>"; };
 		ED9C6A9218599AD8000A5232 /* CCNodeGrid.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; lineEnding = 0; path = CCNodeGrid.cpp; sourceTree = "<group>"; xcLanguageSpecificationIdentifier = xcode.lang.cpp; };
 		ED9C6A9318599AD8000A5232 /* CCNodeGrid.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = CCNodeGrid.h; sourceTree = "<group>"; };
 		EDC789E021CA19FA00E1863C /* CCComAudio.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; path = CCComAudio.cpp; sourceTree = "<group>"; };
@@ -3841,6 +3845,7 @@
 		1A5700A2180BC5E60088DEC7 /* base */ = {
 			isa = PBXGroup;
 			children = (
+				ED75D41F21E3030E0052B87E /* ccConstants.h */,
 				461FE08321C34EEB00E5378F /* CCEnumClass.h */,
 				291901411B05895600F8B4BA /* CCNinePatchImageParser.h */,
 				291901421B05895600F8B4BA /* CCNinePatchImageParser.cpp */,
@@ -6282,6 +6287,7 @@
 				B24AA987195A675C007B4522 /* CCFastTMXLayer.h in Headers */,
 				1A40D16C1E8E56C7002E363A /* stream.h in Headers */,
 				EDC78C5821CA19FC00E1863C /* CCActionFrameEasing.h in Headers */,
+				ED75D42021E3030E0052B87E /* ccConstants.h in Headers */,
 				4631CBD121AFD9FA0000D408 /* UIScale9Sprite.h in Headers */,
 				50ABBEBD1925AB6F00A911A9 /* ccUtils.h in Headers */,
 				A0534A651B872FFD006B03E5 /* CCDownloader-apple.h in Headers */,
@@ -6597,6 +6603,7 @@
 				507B3F691C31BDD30067B53E /* CCAnimationCache.h in Headers */,
 				50864CC31C7BC1B100B3BAB1 /* cpPolyline.h in Headers */,
 				507B3F6E1C31BDD30067B53E /* CCTouch.h in Headers */,
+				ED75D42221E303160052B87E /* ccConstants.h in Headers */,
 				50864C961C7BC1B000B3BAB1 /* chipmunk_types.h in Headers */,
 				507B3F7A1C31BDD30067B53E /* CCEventListenerMouse.h in Headers */,
 				1A40D13E1E8E56C7002E363A /* regex.h in Headers */,
@@ -6759,6 +6766,7 @@
 				EDC78BEB21CA19FB00E1863C /* CCDisplayManager.h in Headers */,
 				460D4CD421A5666E0075726E /* CCRenderer.h in Headers */,
 				50ABBDB41925AB4100A911A9 /* ccShaders.h in Headers */,
+				ED75D42121E303160052B87E /* ccConstants.h in Headers */,
 				50ABBE861925AB6F00A911A9 /* ccFPSImages.h in Headers */,
 				50ABBE2E1925AB6F00A911A9 /* ccCArray.h in Headers */,
 				1A40D10D1E8E56C7002E363A /* document-wrapper.h in Headers */,

cocos/2d/CCParticleBatchNode.cpp

@@ -437,8 +437,8 @@ void ParticleBatchNode::draw(Renderer* renderer, const Mat4 & transform, uint32_
     //TODO: minggo: don't set blend factor every frame.
     auto& blendDescriptor = _customCommand.getPipelineDescriptor().blendDescriptor;
     blendDescriptor.blendEnabled = true;
-    blendDescriptor.sourceRGBBlendFactor = blendDescriptor.sourceAlphaBlendFactor = utils::toBackendBlendFactor(_blendFunc.src);
-    blendDescriptor.destinationRGBBlendFactor = blendDescriptor.destinationAlphaBlendFactor = utils::toBackendBlendFactor(_blendFunc.dst);
+    blendDescriptor.sourceRGBBlendFactor = blendDescriptor.sourceAlphaBlendFactor =_blendFunc.src;
+    blendDescriptor.destinationRGBBlendFactor = blendDescriptor.destinationAlphaBlendFactor =_blendFunc.dst;
 
     if (_textureAtlas->isDirty())
     {

cocos/2d/CCParticleSystem.cpp

@@ -54,6 +54,7 @@ THE SOFTWARE.
 #include "base/CCDirector.h"
 #include "base/CCProfiling.h"
 #include "base/ccUTF8.h"
+#include "base/ccUtils.h"
 #include "renderer/CCTextureCache.h"
 #include "platform/CCFileUtils.h"
 
@@ -336,13 +337,13 @@ bool ParticleSystem::initWithDictionary(ValueMap& dictionary, const std::string&
             // blend function 
             if (!_configName.empty())
             {
-                _blendFunc.src = dictionary["blendFuncSource"].asFloat();
+                _blendFunc.src = utils::toBackendBlendFactor((int)dictionary["blendFuncSource"].asFloat());
             }
             else
             {
-                _blendFunc.src = dictionary["blendFuncSource"].asInt();
+                _blendFunc.src = utils::toBackendBlendFactor(dictionary["blendFuncSource"].asInt());
             }
-            _blendFunc.dst = dictionary["blendFuncDestination"].asInt();
+            _blendFunc.dst = utils::toBackendBlendFactor(dictionary["blendFuncDestination"].asInt());
 
             // color
             _startColor.r = dictionary["startColorRed"].asFloat();
@@ -1112,7 +1113,7 @@ void ParticleSystem::setBlendAdditive(bool additive)
 
 bool ParticleSystem::isBlendAdditive() const
 {
-    return( _blendFunc.src == GL_SRC_ALPHA && _blendFunc.dst == GL_ONE);
+    return( _blendFunc.src == backend::BlendFactor::SRC_ALPHA && _blendFunc.dst == backend::BlendFactor::ONE);
 }
 
 // ParticleSystem - Properties of Gravity Mode 

cocos/2d/CCParticleSystem.h

@@ -833,8 +833,8 @@ class CC_DLL ParticleSystem : public Node, public TextureProtocol, public Playab
     /** whether or not the particles are using blend additive.
      If enabled, the following blending function will be used.
      @code
-     source blend function = GL_SRC_ALPHA;
-     dest blend function = GL_ONE;
+     source blend function = BlendFactor::SRC_ALPHA;
+     dest blend function = BlendFactor::ONE;
      @endcode
      */
     bool _isBlendAdditive;

cocos/2d/CCRenderTexture.h

@@ -346,9 +346,9 @@ class CC_DLL RenderTexture : public Node
     ClearFlag _clearFlags;
 
     /** The Sprite being used.
-     The sprite, by default, will use the following blending function: GL_ONE, GL_ONE_MINUS_SRC_ALPHA.
+     The sprite, by default, will use the following blending function: BlendFactor::ONE, BlendFactor::ONE_MINUS_SRC_ALPHA.
      The blending function can be changed in runtime by calling:
-     - renderTexture->getSprite()->setBlendFunc((BlendFunc){GL_ONE, GL_ONE_MINUS_SRC_ALPHA});
+     - renderTexture->getSprite()->setBlendFunc((BlendFunc){BlendFactor::ONE, BlendFactor::ONE_MINUS_SRC_ALPHA});
      */
     Sprite* _sprite = nullptr;
 

cocos/base/CCDirector.cpp

@@ -720,7 +720,7 @@ void Director::setAlphaBlending(bool on)
 //    }
 //    else
 //    {
-//        utils::setBlending(GL_ONE, GL_ZERO);
+//        utils::setBlending(BlendFactor::ONE, BlendFactor::ZERO);
 //    }
 //
 //    CHECK_GL_ERROR_DEBUG();

cocos/base/CCProtocols.h

@@ -177,7 +177,7 @@ class CC_DLL BlendProtocol
      * Sets the source blending function.
      *
      * @param blendFunc A structure with source and destination factor to specify pixel arithmetic, 
-     *                  e.g. {GL_ONE, GL_ONE}, {GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA}.
+     *                  e.g. {BlendFactor::ONE, BlendFactor::ONE}, {BlendFactor::SRC_ALPHA, BlendFactor::ONE_MINUS_SRC_ALPHA}.
      * @js NA
      * @lua NA
      */
@@ -197,9 +197,9 @@ class CC_DLL BlendProtocol
  * Node objects that uses a Texture2D to render the images.
  * The texture can have a blending function.
  * If the texture has alpha premultiplied the default blending function is:
- *   src=GL_ONE dst= GL_ONE_MINUS_SRC_ALPHA
+ *   src=BlendFactor::ONE dst= BlendFactor::ONE_MINUS_SRC_ALPHA
  * else
- *   src=GL_SRC_ALPHA dst= GL_ONE_MINUS_SRC_ALPHA
+ *   src=BlendFactor::SRC_ALPHA dst= BlendFactor::ONE_MINUS_SRC_ALPHA
  * But you can change the blending function at any time.
  */
 class CC_DLL TextureProtocol : public BlendProtocol

cocos/base/CMakeLists.txt

@@ -35,6 +35,7 @@ set(COCOS_BASE_HEADER
     base/etc1.h
     base/CCGameController.h
     base/CCConsole.h
+    base/ccConstants.h
     base/CCEvent.h
     base/ccTypes.h
     base/CCAsyncTaskPool.h

cocos/base/ccConstants.h

@@ -0,0 +1,48 @@
+/****************************************************************************
+ Copyright (c) 2019 Xiamen Yaji Software Co., Ltd.
+ http://www.cocos2d-x.org
+
+ Permission is hereby granted, free of charge, to any person obtaining a copy
+ of this software and associated documentation files (the "Software"), to deal
+ in the Software without restriction, including without limitation the rights
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ copies of the Software, and to permit persons to whom the Software is
+ furnished to do so, subject to the following conditions:
+
+ The above copyright notice and this permission notice shall be included in
+ all copies or substantial portions of the Software.
+
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ THE SOFTWARE.
+ ****************************************************************************/
+
+#pragma once
+
+#include "base/ccMacros.h"
+
+NS_CC_BEGIN
+
+namespace GLBlendConst {
+    const int ZERO                    = 0;        //GL_ZERO;
+    const int ONE                     = 1;        //GL_ONE;
+    const int SRC_COLOR               = 0x0300;   //GL_SRC_COLOR;
+    const int ONE_MINUS_SRC_COLOR     = 0x0301;   //GL_ONE_MINUS_SRC_COLOR;
+    const int DST_COLOR               = 0x0306;   //GL_DST_COLOR;
+    const int ONE_MINUS_DST_COLOR     = 0x0307;   //GL_ONE_MINUS_DST_COLOR;
+    const int SRC_ALPHA               = 0x0302;   //GL_SRC_ALPHA;
+    const int ONE_MINUS_SRC_ALPHA     = 0x0303;   //GL_ONE_MINUS_SRC_ALPHA;
+    const int DST_ALPHA               = 0x0304;   //GL_DST_ALPHA;
+    const int ONE_MINUS_DST_ALPHA     = 0x0305;   //GL_ONE_MINUS_DST_ALPHA;
+    const int CONSTANT_ALPHA          = 0x8003;   //GL_CONSTANT_ALPHA;
+    const int ONE_MINUS_CONSTANT_ALPHA = 0x8004;  //GL_ONE_MINUS_CONSTANT_ALPHA;
+    const int SRC_ALPHA_SATURATE      = 0x0308;   //GL_SRC_ALPHA_SATURATE;
+    const int BLEND_COLOR             = 0x8005;   //GL_BLEND_COLOR
+}
+
+
+NS_CC_END

cocos/base/ccMacros.h

@@ -99,8 +99,8 @@ simple macro that swaps 2 variables
 /** @def CC_BLEND_SRC
 default gl blend src function. Compatible with premultiplied alpha images.
 */
-#define CC_BLEND_SRC GL_ONE
-#define CC_BLEND_DST GL_ONE_MINUS_SRC_ALPHA
+#define CC_BLEND_SRC cocos2d::backend::BlendFactor::ONE
+#define CC_BLEND_DST cocos2d::backend::BlendFactor::ONE_MINUS_SRC_ALPHA
 
 
 /** @def CC_NODE_DRAW_SETUP

cocos/base/ccTypes.cpp

@@ -27,6 +27,7 @@ Copyright (c) 2017-2018 Xiamen Yaji Software Co., Ltd.
  ****************************************************************************/
 
 #include "base/ccTypes.h"
+#include "renderer/backend/Types.h"
 
 NS_CC_BEGIN
 
@@ -303,9 +304,9 @@ const Color4F Color4F::BLACK  (    0,     0,     0, 1);
 const Color4F Color4F::ORANGE (    1,  0.5f,     0, 1);
 const Color4F Color4F::GRAY   (0.65f, 0.65f, 0.65f, 1);
 
-const BlendFunc BlendFunc::DISABLE = {GL_ONE, GL_ZERO};
-const BlendFunc BlendFunc::ALPHA_PREMULTIPLIED = {GL_ONE, GL_ONE_MINUS_SRC_ALPHA};
-const BlendFunc BlendFunc::ALPHA_NON_PREMULTIPLIED = {GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA};
-const BlendFunc BlendFunc::ADDITIVE = {GL_SRC_ALPHA, GL_ONE};
+const BlendFunc BlendFunc::DISABLE = {backend::BlendFactor::ONE, backend::BlendFactor::ZERO};
+const BlendFunc BlendFunc::ALPHA_PREMULTIPLIED = { backend::BlendFactor::ONE, backend::BlendFactor::ONE_MINUS_SRC_ALPHA};
+const BlendFunc BlendFunc::ALPHA_NON_PREMULTIPLIED = { backend::BlendFactor::SRC_ALPHA, backend::BlendFactor::ONE_MINUS_SRC_ALPHA};
+const BlendFunc BlendFunc::ADDITIVE = { backend::BlendFactor::SRC_ALPHA, backend::BlendFactor::ONE};
 
 NS_CC_END

cocos/base/ccTypes.h

@@ -404,23 +404,28 @@ struct CC_DLL V3F_T2F_Quad
     V3F_T2F    tr;
 };
 
+
+namespace backend {
+    enum class BlendFactor: uint32_t;
+}
+
 /** @struct BlendFunc
  * Blend Function used for textures.
  */
 struct CC_DLL BlendFunc
 {
     /** source blend function */
-    GLenum src;
+    backend::BlendFactor src;
     /** destination blend function */
-    GLenum dst;
+    backend::BlendFactor dst;
 
-    /** Blending disabled. Uses {GL_ONE, GL_ZERO} */
+    /** Blending disabled. Uses {BlendFactor::ONE, BlendFactor::ZERO} */
     static const BlendFunc DISABLE;
-    /** Blending enabled for textures with Alpha premultiplied. Uses {GL_ONE, GL_ONE_MINUS_SRC_ALPHA} */
+    /** Blending enabled for textures with Alpha premultiplied. Uses {BlendFactor::ONE, BlendFactor::ONE_MINUS_SRC_ALPHA} */
     static const BlendFunc ALPHA_PREMULTIPLIED;
-    /** Blending enabled for textures with Alpha NON premultiplied. Uses {GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA} */
+    /** Blending enabled for textures with Alpha NON premultiplied. Uses {BlendFactor::SRC_ALPHA, BlendFactor::ONE_MINUS_SRC_ALPHA} */
     static const BlendFunc ALPHA_NON_PREMULTIPLIED;
-    /** Enables Additive blending. Uses {GL_SRC_ALPHA, GL_ONE} */
+    /** Enables Additive blending. Uses {BlendFactor::SRC_ALPHA, BlendFactor::ONE} */
     static const BlendFunc ADDITIVE;
 
     bool operator==(const BlendFunc &a) const