Difference between revisions of "Shader Variables"

m (Added another link)
(Added love_Canvases)
Line 14: Line 14:
 
{{param|vec4|VertexTexCoord|The texture coordinate of the vertex. The third and fourth components of the vector are normally (0, 1). [[Geometry]] objects allow for custom texture coordinates.}}
 
{{param|vec4|VertexTexCoord|The texture coordinate of the vertex. The third and fourth components of the vector are normally (0, 1). [[Geometry]] objects allow for custom texture coordinates.}}
 
{{param|vec4|VertexColor|The global color set with [[love.graphics.setColor]], or the color of the vertex if a [[Geometry]] with per-vertex colors is drawn.}}
 
{{param|vec4|VertexColor|The global color set with [[love.graphics.setColor]], or the color of the vertex if a [[Geometry]] with per-vertex colors is drawn.}}
 +
 +
== Pixel Shader built-in variables ==
 +
{{param|vec4 array|love_Canvases|Array used to set per-canvas pixel colors when multiple canvases are set with [[love.graphics.setCanvas]] and the [[love.graphics.newShader#Pixel Shader Function|effects]] function is used instead of <code>effect</code>. Note that arrays in shaders are 0-based.}}
  
 
== See Also ==
 
== See Also ==

Revision as of 08:28, 16 August 2013

Available since LÖVE 0.9.0
These built-in shader variables are not supported in earlier versions.

There are several built-in variables LÖVE provides in vertex and pixel shaders. All built-in variables are read-only unless otherwise specified.

Global built-in variables

mat4 TransformMatrix
The transformation matrix affected by love.graphics.translate and friends.
mat4 ProjectionMatrix
The orthographic projection matrix.
mat4 TransformProjectionMatrix
The combined transform and projection matrices. Used as the first argument to the position function.
vec4 VaryingTexCoord
The interpolated per-vertex texture coordinate. Automatically set to the value of VertexTexCoord in the vertex shader before the position function is called. Used as the third argument to the effect function. Writable in the vertex shader.
vec4 VaryingColor
The interpolated per-vertex color. Automatically set to the value of VertexColor in the vertex shader before the position function is called. Used as the first argument to the effect function. Writable in the vertex shader.

Vertex Shader built-in variables

vec4 VertexPosition
The pre-transformed position of the vertex. Used as the second argument to the position function. The third and fourth components of the vector are normally (0, 1).
vec4 VertexTexCoord
The texture coordinate of the vertex. The third and fourth components of the vector are normally (0, 1). Geometry objects allow for custom texture coordinates.
vec4 VertexColor
The global color set with love.graphics.setColor, or the color of the vertex if a Geometry with per-vertex colors is drawn.

Pixel Shader built-in variables

vec4 array love_Canvases
Array used to set per-canvas pixel colors when multiple canvases are set with love.graphics.setCanvas and the effects function is used instead of effect. Note that arrays in shaders are 0-based.

See Also

Other Languages