Skip to content

Latest commit

 

History

History
155 lines (135 loc) · 4.82 KB

readme.md

File metadata and controls

155 lines (135 loc) · 4.82 KB
Raw

OpenFL-GLSL

使用Haxe编写GLSL，编写时，请确保你使用的类都是GLSL所支持的，基础类由vector-math支持。 在Haxe中，你可以正常使用：Array、int、float、bool、vec2、vec3、vec4、mat2、mat3、mat4等。 Use Haxe to write GLSL. When writing, please make sure that the classes you use are supported by GLSL, and the basic classes are supported by vector-math. In Haxe, you can use it normally: Array, int, float, bool, vec2, vec3, vec4, mat2, mat3, mat4, etc.

Demo

Demo

Haxelib

它会在haxelib中同步版本，可通过以下命令安装：

haxelib install openfl-glsl

Issues

如果遇到问题，请第一时间创建Issues告诉我。 If you encounter problems, please create Issues and let me know as soon as possible.

Test.hx

@:debug
class Test extends glsl.OpenFLShader {
	public function new() {
		super();
	}

	override function fragment() {
		super.fragment();
		var v:Vec2 = this.gl_openfl_TextureCoordv * 0.5;
		this.gl_FragColor = texture2D(gl_openfl_Texture, v);
	}
}

Test.hx to GLSL

最终Test.hx的fragment方法会被编译成GLSL，并可直接被OpenFL使用。 Finally, the fragment method of Test.hx will be compiled into GLSL and can be used directly by OpenFL.

#pragma header

 void main(void){
    #pragma body
    vec2 v=openfl_TextureCoordv*0.5;
    gl_FragColor=texture2D(openfl_Texture,v);
}

Use:

var bitmap = new Bitmap();
bitmap.shader = new Test();

注意

  • 当前已实现了:glFragmentSource以及:glVertexSource的GLSL的编写支持。Currently, GLSL writing support for :glFragmentSource and :glVertexSource has been implemented.
  • 需要依赖（Need to rely on vector-math）vector-math

宏功能

@:debug

在Class上添加:debug可以将转义后的GLSL输出： Add :debug to class to output escaped glsl:

@:debug
class Shader extends glsl.OpenFLShader {}

通过haxe build.hxml编译后会自动输出。 After compiling through 'haxe build. Hxml', it will output automatically.

@:glsl

在方法中添加@:glsl则会将方法转义成GLSL，并提供给着色器使用： Adding 'glsl' to the method will escape the method to glsl and provide it to the shader for use: Reference examples: :glsl Use Function

@:glsl public function name(v:Vec2):Float{
	return v.x + v.y;
}

他还可以将变量转义成GLSL：

@:glsl public var a:Vec2 = vec2(1,2);

@:vertexglsl

当只想给vertex顶点着色器添加方法时，则使用@:vertexglsl，而不需要@:glsl。

@:attribute

在类中添加@:attribute变量，可创建出attribute变量：

class Shader extends glsl.OpenFLShader {
	@:attribute public var time:Float;
}

@:uniform

在类中添加@:uniform变量，当需要提供参数时，需要通过u_+变量名组合赋值： Add the ': uniform' variable to the class. When you need to provide parameters, you need to use the 'U'_`+ Variable name combination assignment:

class Shader extends glsl.OpenFLShader {
	@:uniform public var time:Float;
	public function new(){
		super();
		this.u_time.value = [0];
	}
}

@:varying

在类中添加@:varying变量，可以定义varying变量： Add the @:varying variable to the class, you can define the varying variable:

class Shader extends glsl.OpenFLShader {
	@:varying public var textureCoords:Vec2;
	override function vertex() {
		super.vertex();
		textureCoords = vec2(gl_openfl_Position.x, 0);
	}
	override function fragment() {
		super.fragment();
		gl_FragColor = vec4(textureCoords, 0, 1);
	}
}

@:define

在指定的fragment()或者vertex()方法中，新增@:define可以对该着色器添加宏定义，他们之间定义的宏不会互相定义。 In the specified fragment() or vertex() method, the new @:define can add macro definitions to the shader, and the macros defined between them will not define each other.

@:define("VALUE 10.")
override public function fragment(){
	color.r = 10 / VALUE;
}

或者

@:define("VALUE 10.")
override public function vertex(){
	color.r = 10 / VALUE;
}

@:precision

@:precision允许用来定义precision：

@:precision("highp float")
override public function fragment(){}

Haxe to GLSL

现在可以直接在Haxe中编写GLSL，可以参考例子(Now you can write GLSL directly in Haxe, you can refer to the example)：Click Me

使用HaxeToGLSL时，你可以访问类的fragmentSource和vertexSource的静态变量。 When using HaxeToGLSL, you can access the static variables of the class fragmentSource and vertexSource.