Shaders in Oolite: uniforms - Revision history

Kanthoney: /* Entity */ Add fogUniform

2016-02-24T17:03:04Z

‎Entity: Add fogUniform

Tricky: /* Ship */ Change 'withinStationAegis' from 'float' to 'bool'

2012-08-06T07:01:52Z

‎Ship: Change 'withinStationAegis' from 'float' to 'bool'

Cim: /* Ship */ alertCondition uniform in 1.77

2012-06-20T21:45:45Z

‎Ship: alertCondition uniform in 1.77

Ahruman: /* Conversions */ Spelling

2012-01-19T17:29:18Z

‎Conversions: Spelling

Ahruman: /* Basic syntax */ Formatting fixes.

2012-01-19T17:28:24Z

‎Basic syntax: Formatting fixes.

Eric Walch: Added scripting category

2010-02-10T20:19:00Z

Added scripting category

Ahruman: /* Ship */

2010-02-09T16:57:47Z

‎Ship

Ahruman: Removed obsolete information about default bindings.

2007-07-11T15:33:55Z

Removed obsolete information about default bindings.

Ahruman at 11:10, 28 June 2007

2007-06-28T11:10:19Z

Ahruman: Changed syntax

2007-06-28T10:42:45Z

Changed syntax

@@ Line 97: / Line 97: @@
 |-
 | ''throwingSparks'' || bool || Whether the entity is generating sparks (for instance, a ship about to explode).
 |-
 |}
 ==== Ship ====

@@ Line 130: / Line 130: @@
 | ''scannerRange'' || float || The distance (in metres) in which the ship will scan for enemies.
 |-
-| ''withinStationAegis'' || float || True if the ship is within the aegis of the system’s main station.
+| ''withinStationAegis'' || bool || True if the ship is within the aegis of the system’s main station.
 |-
 | ''fuel'' || int || Ship’s fuel level, in tenths of a light year.

@@ Line 169: / Line 169: @@
 |-
 | ''lightsActive'' || bool || True if flashers are turned on, false otherwise.
 |-
 |}

@@ Line 59: / Line 59: @@
      clamped = true;
  };
-The '''clamped''' conversion option, when applied to a property of type ''float'', causes the value to be clamped to the range [0, 1]. When applied to an ''int'' propertie, any value other than 0 (including negative values) is converted to 1. The default value is ''false''.
+The '''clamped''' conversion option, when applied to a property of type ''float'', causes the value to be clamped to the range [0, 1]. When applied to an ''int'' property, any value other than 0 (including negative values) is converted to 1. The default value is ''false''.
 The '''normalized''' option causes vector properties to be normalized, that is, scaled so they have the same direction but length 1. The default value is ''false''.

@@ Line 27: / Line 27: @@
  <font color="#AAAAAA">    }</font>
  <font color="#AAAAAA">}</font>
-This contrived example declares three uniforms, ''shininess'', ''withinAegis'' and compassMode. ''shininess'' is a constant float; it is always 42. ''withinAegis'' is bound to the ship’s ''withinStationAegis'' property. (See below for information on available properties.) This is a boolean, that is, a number whose value is either 0 (meaning no) or 1 (meaning yes). ''compassMode'' is a binding to the ''compassMode'' property. To use the uniforms within a shader (either a vertex shader or a fragment shader), they are declared as follows:
+This contrived example declares three uniforms, ''shininess'', ''withinAegis'' and ''compassMode''. ''shininess'' is a constant <code>float</code>; it is always 42. ''withinAegis'' is bound to the ship’s ''withinStationAegis'' property. (See below for information on available properties.) This is a boolean, that is, a number whose value is either 0 (meaning no) or 1 (meaning yes). ''compassMode'' is a binding to the ''compassMode'' property. To use the uniforms within a shader (either a vertex shader or a fragment shader), they are declared as follows:
  uniform float shininess;
  uniform int withinAegis;

← Older revision		Revision as of 20:19, 10 February 2010
Line 209:		Line 209:

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

@@ Line 167: / Line 167: @@
 |-
 | ''isHulk'' || bool || True if the ship has been abandoned.
 |-
 |}

@@ Line 1: / Line 1: @@
 :<small>The information presented on this page applies to Oolite test release 1.69 and later.</small>
-A '''uniform''' in a [[Shaders in Oolite|shader]] is a variable whose value is specified by the host application – in this case, [[Oolite]]. Oolite allows arbitrary uniforms to be specified for shaders applied to ships, and these may either take constant values specified in ''shipdata.plist'', or be “bound” to an attribute of the ship. This allows shader authors to access numerous properties of a game entity without having to ask for them and wait for an updated version of Oolite. ('''Note:''' in the case of subentities, bound properties are fetched from the parent ship.)
+A '''uniform''' in a [[Shaders in Oolite|shader]] is a variable whose value is specified by the host application – in this case, [[Oolite]]. Oolite allows arbitrary uniforms to be specified for shaders applied to ships, and these may either take constant values specified in ''shipdata.plist'', or be “bound” to an attribute of the ship. This allows shader authors to access numerous properties of a game entity without having to ask for them and wait for an updated version of Oolite. ('''Note:''' in the case of subentities, bound properties are fetched from the parent ship.)
 === Basic syntax ===
@@ Line 27: / Line 27: @@
  <font color="#AAAAAA">    }</font>
  <font color="#AAAAAA">}</font>
-This contrived example declares three uniforms, ''shininess'', ''withinAegis'' and compassMode. ''shininess'' is a constant float; it is always 42. ''withinAegis'' is bound to the ship’s ''withinStationAegis'' property. (See below for information on available properties.) This is a boolean, that is, a number whose value is either 0 (meaning no) or 1 (meaning yes). ''compassMode'' is a binding to the ''compassMode'' property. To use the uniforms within a shader (either a vertex shader or a fragment shader), they are declared as follows:
+This contrived example declares three uniforms, ''shininess'', ''withinAegis'' and compassMode. ''shininess'' is a constant float; it is always 42. ''withinAegis'' is bound to the ship’s ''withinStationAegis'' property. (See below for information on available properties.) This is a boolean, that is, a number whose value is either 0 (meaning no) or 1 (meaning yes). ''compassMode'' is a binding to the ''compassMode'' property. To use the uniforms within a shader (either a vertex shader or a fragment shader), they are declared as follows:
  uniform float shininess;
  uniform int withinAegis;
@@ Line 90: / Line 90: @@
 | ''maxEnergy'' || float || The current maximum energy level of the entity.
 |-
-| ''universalTime'' || float || The [[Time scales in Oolite#game real time|game real time]] clock. The value is the same for all entities and updates once per frame. This is bound to the uniform ''time'' by default, for backwards-compatibility reasons.
+| ''universalTime'' || float || The [[Time scales in Oolite#game real time|game real time]] clock. The value is the same for all entities and updates once per frame.
 |-
 | ''spawnTime'' || float || The [[Time scales in Oolite#game real time|game real time]] at which the entity came into existance.
@@ Line 142: / Line 142: @@
 | ''flightSpeed'' || float || Ship’s current speed.
 |-
-| ''maxFlightSpeed'' || float || Ship’s speed at full throttle. Something of a misnomer – actual speed may be higher using afterburners or hyperspeed.
+| ''maxFlightSpeed'' || float || Ship’s speed at full throttle. Something of a misnomer – actual speed may be higher using afterburners or hyperspeed.
 |-
-| ''speedFactor'' || float || ''flightSpeed'' divided by ''maxFlightSpeed''. May be greater than 1.0 (unless [[#Conversions|clamped]] is used). This is bound to the uniform ''engine_level'' by default, for backwards-compatibility reasons.
+| ''speedFactor'' || float || ''flightSpeed'' divided by ''maxFlightSpeed''. May be greater than 1.0 (unless [[#Conversions|clamped]] is used).
 |-
 | ''damage'' || int || ''energy'' expressed as a percentage of ''maxEnergy''.
 |-
-| ''laserHeatLevel'' || float || The temperature level of the current weapon. This is bound to the uniform ''laser_heat_level'' (with [[#Conversions|clamping]]) by default, for backwards-compatibility reasons.
+| ''laserHeatLevel'' || float || The temperature level of the current weapon.
 |-
-| ''hullHeatLevel'' || float || The temperature level of the hull, due to proximity to stars, atmospheric drag or combat hits. When it reaches 1.0, the ship starts taking damage rapidly. This is bound to the uniform ''hull_heat_level'' by default, for backwards-compatibility reasons.
+| ''hullHeatLevel'' || float || The temperature level of the hull, due to proximity to stars, atmospheric drag or combat hits. When it reaches 1.0, the ship starts taking damage rapidly.
 |-
-| ''entityPersonality'' || float || 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. This is bound to the uniform ''entity_personality'' by default, for backwards-compatibility reasons.
+| ''entityPersonality'' || float || 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.
 |-
-| ''entityPersonalityInt'' || float || Same as ''entity_personality'', scaled to the range 0 to 32767. This is bound to the uniform ''entity_personality_int'' by default, for backwards-compatibility reasons.
+| ''entityPersonalityInt'' || float || Same as ''entity_personality'', scaled to the range 0 to 32767.
 |-
 | ''numberOfScannedShips'' || int || The number of ships within scanner range (but no more than 16).
@@ Line 186: / Line 186: @@
 | ''dialAftShield'' || float || The aft shield level, ranging from 0.0 to 1.0.
 |-
-| ''dialMissileStatus'' || int || State of selected missile – 0 for safe/no missile, 1 for active, 2 for locked.
+| ''dialMissileStatus'' || int || State of selected missile – 0 for safe/no missile, 1 for active, 2 for locked.
 |-
-| ''dialFuelScoopStatus'' || int || State of cargo scoop – 0 for no scoop installed, 1 for full hold, 2 for idle with space in hold, 3 for actively scooping.
+| ''dialFuelScoopStatus'' || int || State of cargo scoop – 0 for no scoop installed, 1 for full hold, 2 for idle with space in hold, 3 for actively scooping.
 |-
-| ''compassMode'' || int || State of advanced space compass – 0 for no advanced space compass installed, 1 for planet mode, 2 for station mode, 3 for sun mode, 4 for target mode, 5 for any beacon. More may be added in future.
+| ''compassMode'' || int || State of advanced space compass – 0 for no advanced space compass installed, 1 for planet mode, 2 for station mode, 3 for sun mode, 4 for target mode, 5 for any beacon. More may be added in future.
 |-
 | ''activeMissile'' || int || Which missile slot is currently selected, from 0 to ''dialMaxMissiles'' - 1.

← Older revision		Revision as of 11:10, 28 June 2007
Line 1:		Line 1:
−	== Uniforms in Oolite Shaders ==
−
	:<small>The information presented on this page applies to Oolite test release 1.69 and later.</small>		:<small>The information presented on this page applies to Oolite test release 1.69 and later.</small>

@@ Line 23: / Line 23: @@
                      value = 42.0;
                  };
-                 withinAegis =
+                 withinAegis = "withinStationAegis";
+                 compassMode = "compassMode";
+             }
  <font color="#AAAAAA">        }</font>
  <font color="#AAAAAA">    }</font>
  <font color="#AAAAAA">}</font>
-This contrived example declares three uniforms, ''shininess'', ''withinAegis'' and compassMode. ''shininess'' is a constant float; it is always 42. ''withinAegis'' is bound to the ship’s ''withinStationAegis'' property. (See below for information on available properties.) This is a boolean, that is, a number whose value is either 0 (meaning no) or 1 (meaning yes). ''compassMode'' is a binding to the ''compassMode'' property; since the uniform has the same name as the property, a simpler syntax is used. To use the uniforms within a shader (either a vertex shader or a fragment shader), they are declared as follows:
+This contrived example declares three uniforms, ''shininess'', ''withinAegis'' and compassMode. ''shininess'' is a constant float; it is always 42. ''withinAegis'' is bound to the ship’s ''withinStationAegis'' property. (See below for information on available properties.) This is a boolean, that is, a number whose value is either 0 (meaning no) or 1 (meaning yes). ''compassMode'' is a binding to the ''compassMode'' property. To use the uniforms within a shader (either a vertex shader or a fragment shader), they are declared as follows:
  uniform float shininess;
  uniform int withinAegis;
@@ Line 58: / Line 58: @@
  haveFuel =
+ {
-     type = binding;
+     binding = "fuel";
      clamped = true;
  };