Shader

Supported platforms:
Available since: Gideros 2015.06.30
Inherits from: Object

Description

Gideros internally uses five distinct shaders:

• the ‘Basic’ shader handles shapes with a constant color
• the ‘Color’ shader handles shapes with per-vertex colors (mostly used by Mesh sprite)
• the ‘Texture’ shader handles textured shapes (Bitmaps)
• the ‘TextureColor’ shader handles textured and per-vertex colored shapes
• and the ‘Particle’ shader deals with Box2D particle systems

The shader API allows replacing the default shader used by Gideros with a custom one, on a sprite per sprite basis. You create a Shader object and assign it to one or several sprites. See Writing Custom Shaders.

The recommended way is to write your shader code in Lua, it will then be automatically translated to the relevant shader language for the platform you are using, eg GLSL, HLSL or MSL. Please see Shader.lua and Writing Lua Shaders.

That said, since Gideros will use your shader as if it was the standard one, you will have to make sure that your custom shader is compatible with Gideros standard Shader, which essentially means that it takes the same input parameters.

Methods Shader.getEngineVersion gets the shader engine version Shader.getProperties gets the graphics engine properties Shader.getShaderLanguage gets the shader language Shader.lua creates a new Lua shader Shader.new creates a new shader Shader:isValid checks if this shader was compiled successfully Shader:setConstant changes the value of a uniform

Events Constants Shader Constants Shader Flags Shader Uniform Descriptors Shader Attribute Descriptors

---

• Main Page
• Lua API
• Main API
• Plugins