前言
本文介绍了cocos2d-x中自带的shader代码,及其在引擎中的使用情况。作者的引擎版本是2.2.3,在这个版本的cocos中有9种自带的shader,详情请见下文。
自带的shaders
cocos2d-x自带的shaders定义在cocos2dx\shaders\ccShaders.h
和cocos2dx\shaders\ccShaders.cpp
这对文件中,下面是ccShaders.h
的内容:
每个自带的shader源代码都被定义成一个字符串: const GLchar*类型的变量,如下:
@H_404_17@/**************************************************************************** Copyright (c) 2010-2012 cocos2d-x.org Copyright (c) 2011 Zynga Inc. http://www.cocos2d-x.org ****************************************************************************/
#ifndef __CCSHADER_H__
#define __CCSHADER_H__
#include "CCGL.h"
#include "platform/CCPlatformMacros.h"
NS_CC_BEGIN
/** * @addtogroup shaders * @{ */
// 第1对shader : 含有一个uniform color变量
extern CC_DLL const GLchar * ccPosition_uColor_frag;
extern CC_DLL const GLchar * ccPosition_uColor_vert;
// 第2对shader
extern CC_DLL const GLchar * ccPositionColor_frag;
extern CC_DLL const GLchar * ccPositionColor_vert;
// 第3对shader
extern CC_DLL const GLchar * ccPositionTexture_frag;
extern CC_DLL const GLchar * ccPositionTexture_vert;
// 第4对shader
extern CC_DLL const GLchar * ccPositionTextureA8Color_frag;
extern CC_DLL const GLchar * ccPositionTextureA8Color_vert;
// 第5对shader
extern CC_DLL const GLchar * ccPositionTextureColor_frag;
extern CC_DLL const GLchar * ccPositionTextureColor_vert;
// 第6对shader
extern CC_DLL const GLchar * ccPositionTextureColorAlphaTest_frag;
// 第7对shader
extern CC_DLL const GLchar * ccPositionTexture_uColor_frag;
extern CC_DLL const GLchar * ccPositionTexture_uColor_vert;
// 第8对shader
extern CC_DLL const GLchar * ccPositionColorLengthTexture_frag;
extern CC_DLL const GLchar * ccPositionColorLengthTexture_vert;
// 第9对shader
extern CC_DLL const GLchar * ccExSwitchMask_frag;
// end of shaders group
/// @}
NS_CC_END
#endif /* __CCSHADER_H__ */
shader具体内容的定义在对应的源文件ccShaders.cpp
中:
/**************************************************************************** Copyright (c) 2010-2012 cocos2d-x.org Copyright (c) 2011 Zynga Inc. http://www.cocos2d-x.org ****************************************************************************/
#include "ccShaders.h"
NS_CC_BEGIN
//
const GLchar * ccPosition_uColor_frag =
#include "ccShader_Position_uColor_frag.h"
const GLchar * ccPosition_uColor_vert =
#include "ccShader_Position_uColor_vert.h"
//
const GLchar * ccPositionColor_frag =
#include "ccShader_PositionColor_frag.h"
const GLchar * ccPositionColor_vert =
#include "ccShader_PositionColor_vert.h"
//
const GLchar * ccPositionTexture_frag =
#include "ccShader_PositionTexture_frag.h"
const GLchar * ccPositionTexture_vert =
#include "ccShader_PositionTexture_vert.h"
//
const GLchar * ccPositionTextureA8Color_frag =
#include "ccShader_PositionTextureA8Color_frag.h"
const GLchar * ccPositionTextureA8Color_vert =
#include "ccShader_PositionTextureA8Color_vert.h"
//
const GLchar * ccPositionTextureColor_frag =
#include "ccShader_PositionTextureColor_frag.h"
const GLchar * ccPositionTextureColor_vert =
#include "ccShader_PositionTextureColor_vert.h"
//
const GLchar * ccPositionTextureColorAlphaTest_frag =
#include "ccShader_PositionTextureColorAlphaTest_frag.h"
//
const GLchar * ccPositionTexture_uColor_frag =
#include "ccShader_PositionTexture_uColor_frag.h"
const GLchar * ccPositionTexture_uColor_vert =
#include "ccShader_PositionTexture_uColor_vert.h"
const GLchar * ccExSwitchMask_frag =
#include "ccShaderEx_SwitchMask_frag.h"
const GLchar * ccPositionColorLengthTexture_frag =
#include "ccShader_PositionColorLengthTexture_frag.h"
const GLchar * ccPositionColorLengthTexture_vert =
#include "ccShader_PositionColorLengthTexture_vert.h"
NS_CC_END
从cpp文件中可以看到,shader的具体内容是通过#include
包含进来的,因此具体的shader源码需要去对应的头文件中查看,以第一个顶点着色器ccPosition_uColor_vert
为例,查看它的源码所在文件:
ccShader_Position_uColor_vert.h
/*
* cocos2d for iPhone: http://www.cocos2d-iphone.org
*
* Copyright (c) 2011 Ricardo Quesada
* Copyright (c) 2012 Zynga Inc.
*/
" \n\ attribute vec4 a_position; \n\ uniform vec4 u_color; \n\ uniform float u_pointSize; \n\ \n\ #ifdef GL_ES \n\ varying lowp vec4 v_fragmentColor; \n\ #else \n\ varying vec4 v_fragmentColor; \n\ #endif \n\ \n\ void main() \n\ { \n\ gl_Position = CC_MVPMatrix * a_position; \n\ gl_PointSize = u_pointSize; \n\ v_fragmentColor = u_color; \n\ } \n\ ";
其对应的片段着色器ccPosition_uColor_frag
内容如下:
ccShader_Position_uColor_frag.h
/*
* cocos2d for iPhone: http://www.cocos2d-iphone.org
*
* Copyright (c) 2011 Ricardo Quesada
* Copyright (c) 2012 Zynga Inc.
*
*/
" \n\ #ifdef GL_ES \n\ precision lowp float; \n\ #endif \n\ \n\ varying vec4 v_fragmentColor; \n\ \n\ void main() \n\ { \n\ gl_FragColor = v_fragmentColor; \n\ } \n\ ";
可以看到这个片段着色器只有一个varying类型的v_fragmentColor
变量,它是从顶点着色器中传递过来的颜色向量。
自带shaders有什么用
还是以第一对shader为例,想知道它在哪里用了,可以这么做:
在visual studio中全局搜索(默认快捷键为ctrl+shift+h): ccPosition_uColor_frag
.
在搜索结果中可以看到除了它自身的定义外,它是在CCShaderCache.cpp
中被引用,CCShaderCache
创建一些default shaders,供引擎中的渲染系统来使用。ccPosition_uColor_frag
是在创建kCCShaderType_Position_uColor
类型的default shader时候被使用,我再搜索: kCCShaderType_Position_uColor
,可以看到创建这个类型的program(shader)时候,代码如下:
.
可以看到,在创建完shader program之后,以键值对的形式保存在一个字典里。外部代码将通过key来获取其中的program。所以我继续搜索这里使用的key:kCCShader_Position_uColor
就可以知道哪里使用了这个shader program,也就是使用了ccPosition_uColor_frag
那对shader。
通过搜索发现,在CCDrawingPrimitives的lazy_init
方法中使用了这个着色器
.
因此我了解到ccPosition_uColor_frag
这对着色器在cocos2d-x中是被用来处理一些基本的图元绘制任务的.
除了这个,还有一个典型的使用自带shader的例子,那就是CCSprite的绘制,在CCSprite的初始化中,其默认的shader正是自带的shader中的ccPositionTextureColor_frag
着色器。
其中的关键代码是这一句:
CCShaderCache::sharedShaderCache()->programForKey(kCCShader_PositionTextureColor);
这是cocos中使用自带shader的典型用法,programForKey这个方法返回一个CCGLProgram类的对象,这个类是对OpenGL ES中program的封装,同时还包括一些对shader中变量的绑定、赋值等操作,后面的文章会对这个类进行介绍。
与上面描述的ccPosition_uColor_frag
和ccPositionTextureColor_frag
这两个自带shader类似,可以使用同样的搜索方法来确认其它自带shader的使用情况:通过到CCShaderCache.cpp中查看它们所对应的key,再全局搜索这个key就能够看到是谁在使用这些内置的shaders了。
cocos2d-x shader 代码里的潜规则
在 ccShader_Position_uColor_vert.h 中的顶点着色器源代码中会看到一个变量叫 : CC_MVPMatrix
attribute vec4 a_position; \n\ uniform vec4 u_color; \n\ uniform float u_pointSize; \n\ \n\ #ifdef GL_ES \n\ varying lowp vec4 v_fragmentColor; \n\ #else \n\ varying vec4 v_fragmentColor; \n\ #endif \n\ \n\ void main() \n\ { \n\ gl_Position = CC_MVPMatrix * a_position; \n\ gl_PointSize = u_pointSize; \n\ v_fragmentColor = u_color; \n\ } \n\
如果直接编译这个shader肯定编译不过,因为其中出现一个莫名其妙的CC_MVPMatrix
. 那引擎中使用这个shader为什么没有报错呢?
这就是cocos里的潜规则,它会在编译shader的时候加上一个头。这个编译过程发生在CCGLProgram.cpp中,如下所示:
bool CCGLProgram::compileShader(GLuint * shader,GLenum type,const GLchar* source)
{
GLint status;
if (!source)
{
return false;
}
// 在source前面加上了一些uniform,可以看到刚才提到的CC_MVPMatrix就是在这里加上的.
const GLchar *sources[] = {
#if (CC_TARGET_PLATFORM != CC_PLATFORM_WIN32 && CC_TARGET_PLATFORM != CC_PLATFORM_LINUX && CC_TARGET_PLATFORM != CC_PLATFORM_MAC)
(type == GL_VERTEX_SHADER ? "precision highp float;\n" : "precision mediump float;\n"),#endif
"uniform mat4 CC_PMatrix;\n"
"uniform mat4 CC_MVMatrix;\n"
"uniform mat4 CC_MVPMatrix;\n"
"uniform vec4 CC_Time;\n"
"uniform vec4 CC_SinTime;\n"
"uniform vec4 CC_CosTime;\n"
"uniform vec4 CC_Random01;\n"
"//CC INCLUDES END\n\n",source,};
*shader = glCreateShader(type);
glShaderSource(*shader,sizeof(sources)/sizeof(*sources),sources,NULL);
glCompileShader(*shader);
glGetShaderiv(*shader,GL_COMPILE_STATUS,&status);
if (! status)
{
GLsizei length;
glGetShaderiv(*shader,GL_SHADER_SOURCE_LENGTH,&length);
GLchar* src = (GLchar *)malloc(sizeof(GLchar) * length);
glGetShaderSource(*shader,length,NULL,src);
CCLOG("cocos2d: ERROR: Failed to compile shader:\n%s",src);
if (type == GL_VERTEX_SHADER)
{
CCLOG("cocos2d: %s",vertexShaderLog());
}
else
{
CCLOG("cocos2d: %s",fragmentShaderLog());
}
free(src);
#if (CC_TARGET_PLATFORM == CC_PLATFORM_WINRT)
return false;
#else
abort();
#endif
}
return (status == GL_TRUE);
}
在代码中我们看到了CC_MVPMatrix
等uniform是从何而来。就总结这么多了,其它相关的东西放在CCGLProgram的文章里总结。
作者水平有限,对相关知识的理解和总结难免有错误,还望给予指正,非常感谢!