CCEffectReflection - API documentation

Author: Thayer J Andrews

cocos2d/CCEffectReflection.h

@@ -10,16 +10,102 @@
 
 @interface CCEffectReflection : CCEffect
 
+/// -----------------------------------------------------------------------
+/// @name Accessing Effect Attributes
+/// -----------------------------------------------------------------------
+
+/** The environment that will be refracted by the affected node. Typically this is a sprite
+ *  that is not visible in the scene as it is conceptually "behind the viewer" and only visible
+ *  where reflected by the affected node.
+ */
 @property (nonatomic) CCSprite *environment;
+
+/** The normal map that encodes the normal vectors of the affected node. Each pixel in the normal
+ *  map is a 3 component vector that is perpendicular to the surface of the sprite at that point.
+ */
 @property (nonatomic) CCSpriteFrame *normalMap;
+
+/** The bias term in the fresnel reflectance equation:
+ *    reflectance = max(0.0, fresnelBias + (1 - fresnelBias) * pow((1 - nDotV), fresnelPower))
+ *  This value is in the range [0..1] and it controls the constant (view angle independent) contribution
+ *  to the reflectance equation.
+ */
 @property (nonatomic) float fresnelBias;
+
+/** The power term in the fresnel reflectance equation:
+ *    reflectance = max(0.0, fresnelBias + (1 - fresnelBias) * pow((1 - nDotV), fresnelPower))
+ *  This value is in the range [0..inf] and it controls the view angle dependent contribution
+ *  to the reflectance equation.
+ */
 @property (nonatomic) float fresnelPower;
 
+
+/// -----------------------------------------------------------------------
+/// @name Initializing a CCEffectReflection object
+/// -----------------------------------------------------------------------
+
+/**
+ *  Initializes a CCEffectReflection object with the following default parameters:
+ *    fresnelBias : 1.0
+ *    fresnelPower : 0.0
+ *    environment : nil
+ *    normalMap : nil
+ *
+ *  @return The CCEffectReflection object.
+ */
 -(id)init;
+
+/**
+ *  Initializes a CCEffectReflection object with the specified environment and normal map and the following default parameters:
+ *    fresnelBias : 1.0
+ *    fresnelPower : 0.0
+ *
+ *  @param environment The environment image that will be reflected by the affected node.
+ *  @param normalMap The normal map of the affected node. This can also be specified as a property of the affected sprite.
+ *
+ *  @return The CCEffectReflection object.
+ */
 -(id)initWithEnvironment:(CCSprite *)environment normalMap:(CCSpriteFrame *)normalMap;
+
+/**
+ *  Initializes a CCEffectReflection object with the specified parameters.
+ *
+ *  @param bias The bias term in the fresnel reflectance equation.
+ *  @param power The power term in the fresnel reflectance equation.
+ *  @param environment The environment image that will be reflected by the affected node.
+ *  @param normalMap The normal map of the affected node. This can also be specified as a property of the affected sprite.
+ *
+ *  @return The CCEffectReflection object.
+ */
 -(id)initWithFresnelBias:(float)bias fresnelPower:(float)power environment:(CCSprite *)environment normalMap:(CCSpriteFrame *)normalMap;
 
+
+/// -----------------------------------------------------------------------
+/// @name Creating a CCEffectReflection object
+/// -----------------------------------------------------------------------
+
+/**
+ *  Creates a CCEffectReflection object with the specified environment and normal map and the following default parameters:
+ *    fresnelBias : 1.0
+ *    fresnelPower : 0.0
+ *
+ *  @param environment The environment image that will be reflected by the affected node.
+ *  @param normalMap The normal map of the affected node. This can also be specified as a property of the affected sprite.
+ *
+ *  @return The CCEffectReflection object.
+ */
 +(id)effectWithEnvironment:(CCSprite *)environment normalMap:(CCSpriteFrame *)normalMap;
+
+/**
+ *  Creates a CCEffectReflection object with the specified parameters.
+ *
+ *  @param bias The bias term in the fresnel reflectance equation.
+ *  @param power The power term in the fresnel reflectance equation.
+ *  @param environment The environment image that will be reflected by the affected node.
+ *  @param normalMap The normal map of the affected node. This can also be specified as a property of the affected sprite.
+ *
+ *  @return The CCEffectReflection object.
+ */
 +(id)effectWithFresnelBias:(float)bias fresnelPower:(float)power environment:(CCSprite *)environment normalMap:(CCSpriteFrame *)normalMap;
 
 @end