CCEffectGlass / Reflection - Properly condition the shininess, fresnel bias, and fresnel power.

Make sure these are all within their valid ranges.

Author: Thayer J Andrews

cocos2d/CCEffectGlass.m

@@ -18,9 +18,16 @@
 #import "CCSprite_Private.h"
 
 
+static const float CCEffectGlassDefaultFresnelBias = 0.1f;
+static const float CCEffectGlassDefaultFresnelPower = 2.0f;
+
+
 @interface CCEffectGlass ()
 
 @property (nonatomic) float conditionedRefraction;
+@property (nonatomic) float conditionedShininess;
+@property (nonatomic) float conditionedFresnelBias;
+@property (nonatomic) float conditionedFresnelPower;
 
 @end
 
@@ -61,10 +68,17 @@ -(id)initWithShininess:(float)shininess refraction:(float)refraction refractionE
     if((self = [super initWithFragmentUniforms:uniforms vertexUniforms:nil varying:nil]))
     {
         _refraction = refraction;
-        _shininess = shininess;
-        _fresnelBias = 0.1f;
-        _fresnelPower = 2.0f;
         _conditionedRefraction = CCEffectUtilsConditionRefraction(refraction);
+        
+        _shininess = shininess;
+        _conditionedShininess = CCEffectUtilsConditionShininess(shininess);
+        
+        _fresnelBias = CCEffectGlassDefaultFresnelBias;
+        _conditionedFresnelBias = CCEffectUtilsConditionFresnelBias(CCEffectGlassDefaultFresnelBias);
+
+        _fresnelPower = CCEffectGlassDefaultFresnelPower;
+        _conditionedFresnelPower = CCEffectUtilsConditionFresnelPower(CCEffectGlassDefaultFresnelPower);
+        
         _refractionEnvironment = refractionEnvironment;
         _reflectionEnvironment = reflectionEnvironment;
         _normalMap = normalMap;
@@ -185,9 +199,9 @@ -(void)buildRenderPasses
 
         pass.shaderUniforms[weakSelf.uniformTranslationTable[@"u_refraction"]] = [NSNumber numberWithFloat:weakSelf.conditionedRefraction];
 
-        pass.shaderUniforms[weakSelf.uniformTranslationTable[@"u_shininess"]] = [NSNumber numberWithFloat:weakSelf.shininess];
-        pass.shaderUniforms[weakSelf.uniformTranslationTable[@"u_fresnelBias"]] = [NSNumber numberWithFloat:weakSelf.fresnelBias];
-        pass.shaderUniforms[weakSelf.uniformTranslationTable[@"u_fresnelPower"]] = [NSNumber numberWithFloat:weakSelf.fresnelPower];
+        pass.shaderUniforms[weakSelf.uniformTranslationTable[@"u_shininess"]] = [NSNumber numberWithFloat:weakSelf.conditionedShininess];
+        pass.shaderUniforms[weakSelf.uniformTranslationTable[@"u_fresnelBias"]] = [NSNumber numberWithFloat:weakSelf.conditionedFresnelBias];
+        pass.shaderUniforms[weakSelf.uniformTranslationTable[@"u_fresnelPower"]] = [NSNumber numberWithFloat:weakSelf.conditionedFresnelPower];
 
         pass.shaderUniforms[weakSelf.uniformTranslationTable[@"u_refractEnvMap"]] = weakSelf.refractionEnvironment.texture ?: [CCTexture none];
         pass.shaderUniforms[weakSelf.uniformTranslationTable[@"u_reflectEnvMap"]] = weakSelf.reflectionEnvironment.texture ?: [CCTexture none];
@@ -235,4 +249,23 @@ -(void)setRefraction:(float)refraction
     _refraction = refraction;
     _conditionedRefraction = CCEffectUtilsConditionRefraction(refraction);
 }
+
+-(void)setShininess:(float)shininess
+{
+    _shininess = shininess;
+    _conditionedShininess = CCEffectUtilsConditionShininess(shininess);
+}
+
+-(void)setFresnelBias:(float)bias
+{
+    _fresnelBias = bias;
+    _conditionedFresnelBias = CCEffectUtilsConditionFresnelBias(bias);
+}
+
+-(void)setFresnelPower:(float)power
+{
+    _fresnelPower = power;
+    _conditionedFresnelPower = CCEffectUtilsConditionFresnelPower(power);
+}
+
 @end

cocos2d/CCEffectReflection.m

@@ -22,6 +22,9 @@
 
 @interface CCEffectReflection ()
 
+@property (nonatomic) float conditionedShininess;
+@property (nonatomic) float conditionedFresnelBias;
+@property (nonatomic) float conditionedFresnelPower;
 
 @end
 
@@ -62,11 +65,17 @@ -(id)initWithShininess:(float)shininess fresnelBias:(float)bias fresnelPower:(fl
 
     if((self = [super initWithFragmentUniforms:uniforms vertexUniforms:nil varying:nil]))
     {
-        _environment = environment;
-        _normalMap = normalMap;
         _shininess = shininess;
+        _conditionedShininess = CCEffectUtilsConditionShininess(shininess);
+        
         _fresnelBias = bias;
+        _conditionedFresnelBias = CCEffectUtilsConditionFresnelBias(bias);
+        
         _fresnelPower = power;
+        _conditionedFresnelPower = CCEffectUtilsConditionFresnelPower(power);
+        
+        _environment = environment;
+        _normalMap = normalMap;
 
         self.debugName = @"CCEffectReflection";
     }
@@ -164,9 +173,9 @@ -(void)buildRenderPasses
             pass.verts = verts;
         }
 
-        pass.shaderUniforms[weakSelf.uniformTranslationTable[@"u_shininess"]] = [NSNumber numberWithFloat:weakSelf.shininess];
-        pass.shaderUniforms[weakSelf.uniformTranslationTable[@"u_fresnelBias"]] = [NSNumber numberWithFloat:weakSelf.fresnelBias];
-        pass.shaderUniforms[weakSelf.uniformTranslationTable[@"u_fresnelPower"]] = [NSNumber numberWithFloat:weakSelf.fresnelPower];
+        pass.shaderUniforms[weakSelf.uniformTranslationTable[@"u_shininess"]] = [NSNumber numberWithFloat:weakSelf.conditionedShininess];
+        pass.shaderUniforms[weakSelf.uniformTranslationTable[@"u_fresnelBias"]] = [NSNumber numberWithFloat:weakSelf.conditionedFresnelBias];
+        pass.shaderUniforms[weakSelf.uniformTranslationTable[@"u_fresnelPower"]] = [NSNumber numberWithFloat:weakSelf.conditionedFresnelPower];
 
         pass.shaderUniforms[weakSelf.uniformTranslationTable[@"u_envMap"]] = weakSelf.environment.texture ?: [CCTexture none];
 
@@ -189,6 +198,25 @@ -(void)buildRenderPasses
 
     self.renderPasses = @[pass0];
 }
+
+-(void)setShininess:(float)shininess
+{
+    _shininess = shininess;
+    _conditionedShininess = CCEffectUtilsConditionShininess(shininess);
+}
+
+-(void)setFresnelBias:(float)bias
+{
+    _fresnelBias = bias;
+    _conditionedFresnelBias = CCEffectUtilsConditionFresnelBias(bias);
+}
+
+-(void)setFresnelPower:(float)power
+{
+    _fresnelPower = power;
+    _conditionedFresnelPower = CCEffectUtilsConditionFresnelPower(power);
+}
+
 @end
 
 GLKMatrix4 GLKMatrix4FromAffineTransform(CGAffineTransform at)

cocos2d/CCEffectUtils.h

@@ -13,4 +13,7 @@ CGAffineTransform CCEffectUtilsWorldToEnvironmentTransform(CCSprite *environment
 GLKVector4 CCEffectUtilsTangentInEnvironmentSpace(GLKMatrix4 effectToWorldMat, GLKMatrix4 worldToEnvMat);
 GLKMatrix4 CCEffectUtilsMat4FromAffineTransform(CGAffineTransform at);
 float CCEffectUtilsConditionRefraction(float refraction);
+float CCEffectUtilsConditionShininess(float shininess);
+float CCEffectUtilsConditionFresnelBias(float bias);
+float CCEffectUtilsConditionFresnelPower(float power);
 

cocos2d/CCEffectUtils.m

@@ -41,7 +41,7 @@ GLKMatrix4 CCEffectUtilsMat4FromAffineTransform(CGAffineTransform at)
 
 float CCEffectUtilsConditionRefraction(float refraction)
 {
-    NSCAssert((refraction >= -1.0) && (refraction <= 1.0), @"Supplied refraction out of range [-1..1].");
+    NSCAssert((refraction >= -1.0f) && (refraction <= 1.0f), @"Supplied refraction out of range [-1..1].");
 
     // Lerp between min and max
     if (refraction >= 0.0f)
@@ -54,3 +54,22 @@ float CCEffectUtilsConditionRefraction(float refraction)
     }
 }
 
+float CCEffectUtilsConditionShininess(float shininess)
+{
+    NSCAssert((shininess >= 0.0f) && (shininess <= 1.0f), @"Supplied shininess out of range [0..1].");
+    return clampf(shininess, 0.0f, 1.0f);
+}
+
+float CCEffectUtilsConditionFresnelBias(float bias)
+{
+    NSCAssert((bias >= 0.0f) && (bias <= 1.0f), @"Supplied bias out of range [0..1].");
+    return clampf(bias, 0.0f, 1.0f);
+}
+
+float CCEffectUtilsConditionFresnelPower(float power)
+{
+    NSCAssert(power >= 0.0f, @"Supplied power out of range [0..inf].");
+    return (power < 0.0f) ? 0.0f : power;
+}
+
+