Fixing some Metal runtime validation errors.

Author: slembcke

cocos2d/CCRenderTexture.m

@@ -114,7 +114,15 @@ - (id)initWithWidth:(int)w height:(int)h pixelFormat:(CCTexturePixelFormat)forma
 -(id)initWithWidth:(int)width height:(int)height pixelFormat:(CCTexturePixelFormat) format depthStencilFormat:(GLuint)depthStencilFormat
 {
 	if((self = [super init])){
-		NSAssert(format != CCTexturePixelFormat_A8, @"only RGB and RGBA formats are valid for a render texture");
+#if __CC_METAL_SUPPORTED_AND_ENABLED
+		if([CCConfiguration sharedConfiguration].graphicsAPI == CCGraphicsAPIMetal){
+			NSAssert(format == CCTexturePixelFormat_RGBA8888, @"Only RGBA8 pixel formats are supported for Metal render textures. (The internally created texture is actually BRGA8)");
+			format = CCTexturePixelFormat_BGRA8888;
+		} else
+#endif
+		{
+			NSAssert(format != CCTexturePixelFormat_A8, @"only RGB and RGBA formats are valid for a render texture");
+		}
 
 		CCDirector *director = [CCDirector sharedDirector];
 

cocos2d/CCRenderer.m

@@ -317,13 +317,15 @@ -(void)prepareWithProjection:(const GLKMatrix4 *)projection framebuffer:(CCFrame
 
 		for(NSString *name in _globalShaderUniforms){
 			NSValue *value = _globalShaderUniforms[name];
-			size_t bytes = value.CCRendererSizeOf;
 
-			void * buff = CCGraphicsBufferPushElements(uniformBuffer, bytes);
+			// Round up to the next multiple of 16 since Metal types have an alignment of 16 bytes at most.
+			size_t alignedBytes = ((value.CCRendererSizeOf - 1) | 0xF) + 1;
+			
+			void * buff = CCGraphicsBufferPushElements(uniformBuffer, alignedBytes);
 			[value getValue:buff];
 			offsets[name] = @(offset);
 
-			offset += bytes;
+			offset += alignedBytes;
 		}
 
 		_globalShaderUniformBufferOffsets = offsets;

cocos2d/CCShader.m

@@ -415,6 +415,9 @@ -(instancetype)initWithGLProgram:(GLuint)program uniformSetters:(NSDictionary *)
 		// If both args are active, they must match.
 		NSCAssert(!vertexArg || !fragmentArg || vertexArg.bufferDataSize == fragmentArg.bufferDataSize, @"Vertex and fragment argument type don't match for '%@'.", vertexArg.name);
 
+		// Round up to the next multiple of 16 since Metal types have an alignment of 16 bytes at most.
+		size_t alignedBytes = ((bytes - 1) | 0xF) + 1;
+		
 		return ^(CCRenderer *renderer, NSDictionary *shaderUniforms, NSDictionary *globalShaderUniforms){
 			CCGraphicsBufferMetal *uniformBuffer = (CCGraphicsBufferMetal *)renderer->_buffers->_uniformBuffer;
 			id<MTLBuffer> metalBuffer = uniformBuffer->_buffer;
@@ -424,7 +427,7 @@ -(instancetype)initWithGLProgram:(GLuint)program uniformSetters:(NSDictionary *)
 			NSValue *value = shaderUniforms[name];
 			if(value){
 				// Try finding a per-node value first and append it to the uniform buffer.
-				void *buff = CCGraphicsBufferPushElements(uniformBuffer, bytes);
+				void *buff = CCGraphicsBufferPushElements(uniformBuffer, alignedBytes);
 				[value getValue:buff];
 
 				offset = buff - uniformBuffer->_ptr;
@@ -550,6 +553,8 @@ -(instancetype)initWithMetalVertexFunction:(id<MTLFunction>)vertexFunction fragm
 -(instancetype)initWithMetalVertexShaderSource:(NSString *)vertexSource fragmentShaderSource:(NSString *)fragmentSource
 {
 	CCMetalContext *context = [CCMetalContext currentContext];
+	
+	// TODO this is a terrible terrible hack.
 	NSString *header = CC_METAL(
 using namespace metal;
 
@@ -577,7 +582,6 @@ -(instancetype)initWithMetalVertexShaderSource:(NSString *)vertexSource fragment
 	float4 cosTime;
 	float4 random01;
 } CCGlobalUniforms;
-
 	);
 
 	id<MTLFunction> vertexFunction = nil;

cocos2d/CCTexture.h

@@ -105,6 +105,9 @@ typedef NS_ENUM(NSUInteger, CCTexturePixelFormat) {
 	///! 2-bit PVRTC-compressed texture: PVRTC2
 	CCTexturePixelFormat_PVRTC2,
 
+	///! 32-bit texture: BGRA8888
+	CCTexturePixelFormat_BGRA8888,
+    
 	///! Default texture format: RGBA8888
 	CCTexturePixelFormat_Default = CCTexturePixelFormat_RGBA8888,
 };

cocos2d/CCTexture.m

@@ -103,6 +103,7 @@ CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
 	MTLPixelFormatInvalid, //CCTexturePixelFormat_RGB5A1,
 	MTLPixelFormatPVRTC_RGBA_4BPP, //CCTexturePixelFormat_PVRTC4,
 	MTLPixelFormatPVRTC_RGBA_2BPP, //CCTexturePixelFormat_PVRTC2,
+	MTLPixelFormatBGRA8Unorm,
 };
 
 #endif
@@ -824,47 +825,29 @@ +(CCTexturePixelFormat) defaultAlphaPixelFormat
 
 +(NSUInteger) bitsPerPixelForFormat:(CCTexturePixelFormat)format
 {
-	NSUInteger ret=0;
-	
 	switch (format) {
 		case CCTexturePixelFormat_RGBA8888:
-			ret = 32;
-			break;
-		case CCTexturePixelFormat_RGB888:
+		case CCTexturePixelFormat_BGRA8888:
 			// It is 32 and not 24, since its internal representation uses 32 bits.
-			ret = 32;
-			break;
+		case CCTexturePixelFormat_RGB888:
+			return 32;
 		case CCTexturePixelFormat_RGB565:
-			ret = 16;
-			break;
 		case CCTexturePixelFormat_RGBA4444:
-			ret = 16;
-			break;
 		case CCTexturePixelFormat_RGB5A1:
-			ret = 16;
-			break;
 		case CCTexturePixelFormat_AI88:
-			ret = 16;
-			break;
+			return 16;
 		case CCTexturePixelFormat_A8:
-			ret = 8;
-			break;
 		case CCTexturePixelFormat_I8:
-			ret = 8;
-			break;
+			return 8;
 		case CCTexturePixelFormat_PVRTC4:
-			ret = 4;
-			break;
+			return 4;
 		case CCTexturePixelFormat_PVRTC2:
-			ret = 2;
-			break;
+			return 2;
 		default:
-			ret = -1;
 			NSAssert1(NO , @"bitsPerPixelForFormat: %ld, unrecognised pixel format", (long)format);
 			CCLOG(@"bitsPerPixelForFormat: %ld, cannot give useful result", (long)format);
-			break;
+			return -1;
 	}
-	return ret;
 }
 
 -(NSUInteger) bitsPerPixelForFormat
@@ -906,13 +889,14 @@ -(NSString*) stringForFormat
 		case CCTexturePixelFormat_PVRTC2:
 			return  @"PVRTC2";
 
+		case CCTexturePixelFormat_BGRA8888:
+			return  @"BGRA8888";
+
 		default:
 			NSAssert1(NO , @"stringForFormat: %ld, unrecognised pixel format", (long)_format);
 			CCLOG(@"stringForFormat: %ld, cannot give useful result", (long)_format);
-			break;
+			return  nil;
 	}
-	
-	return  nil;
 }
 @end