Make uniform dictionary copying behavior of CCRenderState explicit for immutability purposes. Fix a minor garbage creation issue with CCTTFLabel and CCRenderTexture.

Author: slembcke

cocos2d/CCLabelTTF.m

@@ -332,8 +332,12 @@ - (void) setTextureDirty
 -(CCRenderState *)renderState
 {
 	if(_renderState == nil){
+		// Allowing the uniforms to be copied speeds up the rendering by making the render state immutable.
+		// Copy the uniforms if custom uniforms are not being used.
+		BOOL copyUniforms = self.hasDefaultShaderUniforms;
+		
 		// Create an uncached renderstate so the texture can be released before the renderstate cache is flushed.
-		_renderState = [[CCRenderState alloc] initWithBlendMode:_blendMode shader:_shader shaderUniforms:self.shaderUniforms];
+		_renderState = [[CCRenderState alloc] initWithBlendMode:_blendMode shader:_shader shaderUniforms:self.shaderUniforms copyUniforms:copyUniforms];
 	}
 
 	return _renderState;

cocos2d/CCNode.m

@@ -1765,7 +1765,7 @@ -(CCRenderState *)renderState
 			_shaderUniforms = nil;
 		} else {
 			// Since the node has unique uniforms, it cannot be batched or use the fast path.
-			_renderState = [[CCRenderState alloc] initWithBlendMode:_blendMode shader:_shader shaderUniforms:_shaderUniforms];
+			_renderState = [[CCRenderState alloc] initWithBlendMode:_blendMode shader:_shader shaderUniforms:_shaderUniforms copyUniforms:NO];
 		}
 	}
 
@@ -1788,6 +1788,19 @@ -(CCBlendMode *)blendMode
 	return _blendMode;
 }
 
+-(BOOL)hasDefaultShaderUniforms
+{
+	CCTexture *texture = (_texture ?: [CCTexture none]);
+	if(CheckDefaultUniforms(_shaderUniforms, texture)){
+		// If the uniform dictionary was set, it was the default. Throw it away.
+		_shaderUniforms = nil;
+		
+		return YES;
+	} else {
+		return NO;
+	}
+}
+
 -(NSMutableDictionary *)shaderUniforms
 {
 	if(_shaderUniforms == nil){

cocos2d/CCNode_Private.h

@@ -43,6 +43,9 @@ CGAffineTransform CGAffineTransformMakeRigid(CGPoint translate, CGFloat radians)
 	CCTexture *_texture;
 }
 
+/// Returns true if the node is not using custom uniforms.
+-(BOOL)hasDefaultShaderUniforms;
+
 /// Cache and return the current render state.
 /// Should be set to nil whenever changing a property that affects the renderstate.
 @property(nonatomic, strong) CCRenderState *renderState;

cocos2d/CCRenderTexture.m

@@ -49,8 +49,12 @@ @implementation CCRenderTextureSprite
 -(CCRenderState *)renderState
 {
 	if(_renderState == nil){
+		// Allowing the uniforms to be copied speeds up the rendering by making the render state immutable.
+		// Copy the uniforms if custom uniforms are not being used.
+		BOOL copyUniforms = self.hasDefaultShaderUniforms;
+		
 		// Create an uncached renderstate so the texture can be released before the renderstate cache is flushed.
-		_renderState = [[CCRenderState alloc] initWithBlendMode:_blendMode shader:_shader shaderUniforms:self.shaderUniforms];
+		_renderState = [[CCRenderState alloc] initWithBlendMode:_blendMode shader:_shader shaderUniforms:self.shaderUniforms copyUniforms:copyUniforms];
 	}
 
 	return _renderState;

cocos2d/CCRenderer.h

@@ -172,8 +172,12 @@ extern const NSString *CCBlendEquationAlpha;
 /// Create a cached blending mode for a given blending mode, shader and main texture.
 +(instancetype)renderStateWithBlendMode:(CCBlendMode *)blendMode shader:(CCShader *)shader mainTexture:(CCTexture *)mainTexture;
 
+/// Create an uncached blending mode for a given blending mode, shader and set of uncopied uniform values.
+-(instancetype)initWithBlendMode:(CCBlendMode *)blendMode shader:(CCShader *)shader shaderUniforms:(NSDictionary *)shaderUniforms __deprecated;
+
 /// Create an uncached blending mode for a given blending mode, shader and set of uniform values.
--(instancetype)initWithBlendMode:(CCBlendMode *)blendMode shader:(CCShader *)shader shaderUniforms:(NSDictionary *)shaderUniforms;
+/// Allowing the uniform dictionary to be copied allows the render state to be immutable and used more optimally.
+-(instancetype)initWithBlendMode:(CCBlendMode *)blendMode shader:(CCShader *)shader shaderUniforms:(NSDictionary *)shaderUniforms copyUniforms:(BOOL)copyUniforms;
 
 @end
 

cocos2d/CCRenderer.m

@@ -263,6 +263,7 @@ -(void)flush
 
 @implementation CCRenderState {
 	CCTexture *_mainTexture;
+	BOOL _immutable;
 
 	@public
 	CCBlendMode *_blendMode;
@@ -280,11 +281,19 @@ +(void)initialize
 }
 
 -(instancetype)initWithBlendMode:(CCBlendMode *)blendMode shader:(CCShader *)shader shaderUniforms:(NSDictionary *)shaderUniforms
+{
+	return [self initWithBlendMode:blendMode shader:shader shaderUniforms:shaderUniforms copyUniforms:NO];
+}
+
+-(instancetype)initWithBlendMode:(CCBlendMode *)blendMode shader:(CCShader *)shader shaderUniforms:(NSDictionary *)shaderUniforms copyUniforms:(BOOL)copyUniforms
 {
 	if((self = [super init])){
 		_blendMode = blendMode;
 		_shader = shader;
-		_shaderUniforms = shaderUniforms;
+		_shaderUniforms = (copyUniforms ? [shaderUniforms copy] : shaderUniforms);
+		
+		// The renderstate as a whole is immutable if the uniforms are copied.
+		_immutable = copyUniforms;
 	}
 
 	return self;
@@ -297,25 +306,24 @@ +(instancetype)renderStateWithBlendMode:(CCBlendMode *)blendMode shader:(CCShade
 		mainTexture = [CCTexture none];
 	}
 
-	CCRenderState *renderState = [[self alloc] initWithBlendMode:blendMode shader:shader shaderUniforms:@{CCShaderUniformMainTexture: mainTexture}];
+	CCRenderState *renderState = [[self alloc] initWithBlendMode:blendMode shader:shader shaderUniforms:@{CCShaderUniformMainTexture: mainTexture} copyUniforms:YES];
 	renderState->_mainTexture = mainTexture;
 
 	return [CCRENDERSTATE_CACHE objectForKey:renderState];
 }
 
 -(id)copyWithZone:(NSZone *)zone
 {
-	NSDictionary *shaderUniforms = [_shaderUniforms copy];
-	if(shaderUniforms == _shaderUniforms){
+	if(_immutable){
 		return self;
 	} else {
-		return [[CCRenderState allocWithZone:zone] initWithBlendMode:_blendMode shader:_shader shaderUniforms:shaderUniforms];
+		return [[CCRenderState allocWithZone:zone] initWithBlendMode:_blendMode shader:_shader shaderUniforms:_shaderUniforms copyUniforms:YES];
 	}
 }
 
 -(NSUInteger)hash
 {
-	NSAssert(_mainTexture, @"Attempting to cache a renderstate without a mainTexture value.");
+	NSAssert(_mainTexture, @"Attempting to cache a renderstate that was nort created with renderStateWithBlendMode.");
 
 	// Not great, but acceptable. All values are unique by pointer.
 	return ((NSUInteger)_blendMode ^ (NSUInteger)_shader ^ (NSUInteger)_mainTexture);