Shaders in Oolite - Revision history

Ahruman: /* Macros */ Updated with correct version info.

2010-02-28T18:07:11Z

‎Macros: Updated with correct version info.

Eric Walch: Added scripting category

2010-02-10T20:22:09Z

Added scripting category

Ahruman: Removed “will be removed in 1.6x” stuff.

2008-11-30T14:16:03Z

Removed “will be removed in 1.6x” stuff.

Ahruman: /* Macros */

2008-11-21T23:09:59Z

‎Macros

Ahruman: Updated old information.

2007-07-11T17:29:49Z

Updated old information.

Ahruman: /* Uniform reference */ Updated for Oolite 1.69.

2007-07-01T12:51:54Z

‎Uniform reference: Updated for Oolite 1.69.

Ahruman: Added deprecation notice to uniforms section. Removed deprecated macros. Wikified shipdata.plist.

2007-06-28T10:52:08Z

Added deprecation notice to uniforms section. Removed deprecated macros. Wikified shipdata.plist.

Ahruman: /* Macros */ Added OO_USER_DEFINED_BINDINGS.

2007-06-07T22:41:03Z

‎Macros: Added OO_USER_DEFINED_BINDINGS.

Ahruman: /* Uniform reference */ Actual levels for greater-than-1 engine_level.

2007-04-11T17:49:43Z

‎Uniform reference: Actual levels for greater-than-1 engine_level.

Ahruman: /* Macros */ Added OO_REDUCED_COMPLEXITY

2007-04-11T00:03:38Z

‎Macros: Added OO_REDUCED_COMPLEXITY

@@ Line 118: / Line 118: @@
 | <code>OO_LIGHT_0_FIX</code>||In current versions of Oolite, light number 0 is effectively always attached to the camera, giving the effect of the player shining a light on anything they’re looking at. When this is fixed, <code>OO_LIGHT_0_FIX</code> will be defined. (Not yet defined in any version of Oolite.)
 |-
-| <code>OO_REDUCED_COMPLEXITY</code>||Defined if user has selected lower-complexity shaders. (Not yet defined in any version of Oolite.)
+| <code>OO_REDUCED_COMPLEXITY</code>||Defined if user has selected lower-complexity shaders.
 |-
 | <code>OO_TEXTURE_UNIT_COUNT</code>||An integer specifying the number of texture units supported by hardware, which is the maximum number of ''tex'''N''''' uniforms that will be meaningful. This should be the same as ''gl_MaxTextureUnits'', but a macro has the advantage that it can be used to completely exclude parts of the shader. (Defined in Oolite 1.69 and later.)
@@ Line 124: / Line 124: @@
 | <code>OO_USER_DEFINED_BINDINGS</code>||Defined to indicate that [[Shaders in Oolite: uniforms|arbitrary uniform bindings]] are available. (Defined in Oolite 1.69 and later.)
 |-
-| <code>OO_TANGENT_ATTR</code>||Defined to indicate that the <code>tangent</code> vertex attribute is available. Expected to be defined in Oolite 1.73.
+| <code>OO_TANGENT_ATTR</code>||Defined to indicate that the <code>tangent</code> vertex attribute is available. (Defined in Oolite 1.73 and later.)
 |}

← Older revision		Revision as of 20:22, 10 February 2010
Line 131:		Line 131:

	[[Category:Oolite]]		[[Category:Oolite]]
		+	[[Category:Oolite scripting]]

@@ Line 1: / Line 1: @@
 '''Shaders'''  are programs which run on a graphics processing unit. They provide a more flexible alternative or supplement to textures for specifying objects’ appearance. There are two widely-used types of shader, '''vertex shaders''' and '''fragment shaders''' (also known, less accurately, as '''pixel shaders'''), which are generally used in combination. Shaders can be implemented in a number of special-purpose programming languages; [[Oolite]] uses the '''[http://en.wikipedia.org/wiki/GLSL OpenGL Shading Language]''', also known as '''GLslang''' or '''GLSL'''.
-Shaders are supported in Oolite 1.67 for Mac OS X and later, and from 1.68 on other platforms. However, the shader support is still evolving. This page currently documents the state in Oolite 1.69 and 1.69.1.
+Shaders are supported in Oolite 1.67 for Mac OS X and later, and from 1.68 on other platforms. However, the shader support is still evolving. This page currently documents the state in Oolite 1.72.
@@ Line 13: / Line 15: @@
 |-
 | ''vertex_shader'' || string || The name of a vertex shader file to use. Oolite will search the Shaders folder of all installed OXPs for a shader of the appropriate name. (Requires Oolite 1.68 or later.)
 |-
 | ''fragment_shader'' || string || The name of a fragment shader file to use. Oolite will search the Shaders folder of all installed OXPs for a shader of the appropriate name. (Requires Oolite 1.68 or later.)
 |-
 | ''uniforms'' || dictionary || Uniforms to pass to the shaders.

@@ Line 127: / Line 127: @@
 |-
 | <code>OO_USER_DEFINED_BINDINGS</code>||Defined to indicate that [[Shaders in Oolite: uniforms|arbitrary uniform bindings]] are available. (Defined in Oolite 1.69 and later.)
 |}

@@ Line 1: / Line 1: @@
 '''Shaders'''  are programs which run on a graphics processing unit. They provide a more flexible alternative or supplement to textures for specifying objects’ appearance. There are two widely-used types of shader, '''vertex shaders''' and '''fragment shaders''' (also known, less accurately, as '''pixel shaders'''), which are generally used in combination. Shaders can be implemented in a number of special-purpose programming languages; [[Oolite]] uses the '''[http://en.wikipedia.org/wiki/GLSL OpenGL Shading Language]''', also known as '''GLslang''' or '''GLSL'''.
-Shaders are supported in Oolite 1.67 for Mac OS X and later. At the time of writing, no released version of Oolite for other platforms supports shaders, but version 1.68 for Windows will.
+Shaders are supported in Oolite 1.67 for Mac OS X and later, and from 1.68 on other platforms. However, the shader support is still evolving. This page currently documents the state in Oolite 1.69 and 1.69.1.
@@ Line 14: / Line 14: @@
 | ''vertex_shader'' || string || The name of a vertex shader file to use. Oolite will search the Shaders folder of all installed OXPs for a shader of the appropriate name. (Requires Oolite 1.68 or later.)
 |-
-| ''glsl-vertex'' || string || GLslang code to use as a vertex shader. This is ignored if ''vertex_shader'' is specified. ('''Deprecated''' – may be removed in Oolite 1.69.)
+| ''glsl-vertex'' || string || GLslang code to use as a vertex shader. This is ignored if ''vertex_shader'' is specified. ('''Deprecated''' – will be removed after Oolite 1.69.1.)
 |-
 | ''fragment_shader'' || string || The name of a fragment shader file to use. Oolite will search the Shaders folder of all installed OXPs for a shader of the appropriate name. (Requires Oolite 1.68 or later.)
 |-
-| ''glsl-fragment'' || string || GLslang code to use as a fragment shader. This is ignored if ''fragment_shader'' is specified. ('''Deprecated''' – may be removed in Oolite 1.69.)
+| ''glsl-fragment'' || string || GLslang code to use as a fragment shader. This is ignored if ''fragment_shader'' is specified. '''Deprecated''' – will be removed after Oolite 1.69.1.)
 |-
-| ''glsl'' || string || Synonym for ''glsl-fragment''. ('''Deprecated''' – may be removed in Oolite 1.69.)
+| ''glsl'' || string || Synonym for ''glsl-fragment''. '''Deprecated''' – will be removed after Oolite 1.69.1.)
 |-
 | ''uniforms'' || dictionary || Uniforms to pass to the shaders.

@@ Line 108: / Line 108: @@
-== Uniform reference ==
+== Uniforms ==
-:'''This section applies to Oolite 1.67–1.68. The predefined uniforms documented here (except <code>tex0</code>…<code>texN</code>) are deprecated and will not be supported beyond Oolite 1.69. The new, more flexible uniform binding system is documented at [[Shaders in Oolite: uniforms]].'''
+Uniforms are variables whose value is set by the host application, i.e. Oolite. Oolite automatically supplies one uniform of type <code>sampler2D</code> for each texture, named <code>tex0</code>, <code>tex1</code> etc. It is also possible to bind uniforms to certain properties of the entity the shader is being applied to, for instance, its engine level. Additionally, constant values can be specified for uniforms, allowing a single shader to be used on different entities with differences in configuration.
-The uniform variables currently provided by Oolite are:
-{| class="wikitable" border="1" cellpadding="3" cellspacing="0"
+For more information on uniforms, see [[Shaders in Oolite: uniforms]].
 == Macros ==

@@ Line 5: / Line 5: @@
 == Specifying shaders ==
-Shaders are specified in a dictionary named ''shaders'' in the ship’s definition in ''shipdata.plist''. The keys of this dictionary are names of textures used in the ship’s or entity’s .dat file, and the values are dictionaries specifying shaders to use instead. The elements are:
+Shaders are specified in a dictionary named ''shaders'' in the ship’s definition in ''[[shipdata.plist]]''. The keys of this dictionary are names of textures used in the ship’s or entity’s .dat file, and the values are dictionaries specifying shaders to use instead. The elements are:
 {| class="wikitable" border="1" cellpadding="3" cellspacing="0"
 |+ ''shaders'' dictionary values
@@ Line 109: / Line 109: @@
 == Uniform reference ==
 The uniform variables currently provided by Oolite are:
 {| class="wikitable" border="1" cellpadding="3" cellspacing="0"
@@ Line 136: / Line 137: @@
 == Macros ==
 {| class="wikitable" border="1" cellpadding="3" cellspacing="0"
 |+ Macros
 ! Name !! Description
 |-
 | <code>OO_LIGHT_0_FIX</code>||In current versions of Oolite, light number 0 is effectively always attached to the camera, giving the effect of the player shining a light on anything they’re looking at. When this is fixed, <code>OO_LIGHT_0_FIX</code> will be defined. (Not yet defined in any version of Oolite.)
@@ Line 160: / Line 148: @@
 |-
 | <code>OO_TEXTURE_UNIT_COUNT</code>||An integer specifying the number of texture units supported by hardware, which is the maximum number of ''tex'''N''''' uniforms that will be meaningful. This should be the same as ''gl_MaxTextureUnits'', but a macro has the advantage that it can be used to completely exclude parts of the shader. (Defined in Oolite 1.69 and later.)
 |-
 | <code>OO_USER_DEFINED_BINDINGS</code>||Defined to indicate that [[Shaders in Oolite: uniforms|arbitrary uniform bindings]] are available. (Defined in Oolite 1.69 and later.)

@@ Line 162: / Line 162: @@
 |-
 | <code>OO_TIME</code>||Defined to indicate that the ''time'' uniform is available. (Defined in Oolite 1.68 and later.)
 |}

@@ Line 122: / Line 122: @@
 | ''tex'''N''''' || <code>sampler2D</code> || Sampler for the '''N+1th''' texture.
 |-
-| ''engine_level'' || <code>float</code> || Engine thrust. 0.0 for no movement, 1.0 for full thrust. Greater than 1.0 for injectors or hyperspeed.
+| ''engine_level'' || <code>float</code> || Engine thrust. 0.0 for no movement, 1.0 for full thrust. Up to 7.0 for fuel injectors, and 32.0 for hyperspeed.
 |-
 | ''entity_personality'' || <code>float</code> || A randomly-generated value in the range 0.0 to 1.0 that stays with the entity for its lifetime. Useful for adding random variations. (Requires Oolite 1.68 or later.)