Hasty (but working) implementation of Metal textures.

Author: slembcke

cocos2d/CCLabelTTF.m

@@ -37,6 +37,7 @@
 #import "CCConfiguration.h"
 #import "CCNode_Private.h"
 #import "CCDirector.h"
+#import "CCTexture_Private.h"
 #import <Foundation/Foundation.h>
 
 #if __CC_PLATFORM_IOS
@@ -54,15 +55,6 @@
 static __strong NSMutableDictionary* ccLabelTTF_registeredFonts;
 
 
-@implementation CCTexture (CCLabelTTF)
-
-- (void) setPremultipliedAlpha:(BOOL)flag
-{
-    _premultipliedAlpha = flag;
-}
-
-@end
-
 #pragma mark CCLabelTTF
 
 

cocos2d/CCTexture.h

@@ -118,24 +118,7 @@ typedef NS_ENUM(NSUInteger, CCTexturePixelFormat) {
  *  - i.e. "contentSize" != (pixelsWide, pixelsHigh) and (maxS, maxT) != (1.0, 1.0).
  *  Be aware that the content of the generated textures will be upside-down!
  */
-@interface CCTexture : NSObject {
-	GLuint						_name;
-	CGSize						_sizeInPixels;
-	CGFloat _contentScale;
-	NSUInteger					_width,
-								_height;
-	CCTexturePixelFormat		_format;
-	GLfloat						_maxS,
-								_maxT;
-	BOOL						_premultipliedAlpha;
-	BOOL						_hasMipmaps;
-    
-    BOOL                        _antialiased;
-
-	// Needed for drawAtRect, drawInPoint.
-	CCShader					*_shaderProgram;
-}
-
+@interface CCTexture : NSObject
 
 /// -----------------------------------------------------------------------
 /// @name Initializing a CCTexture Object

cocos2d/CCTexture.m

@@ -88,6 +88,10 @@ CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
 #import "CCTextureCache.h"
 #import "CCSpriteFrame.h"
 
+#if __CC_METAL_SUPPORTED_AND_ENABLED
+#import "CCMetalSupport_Private.h"
+#endif
+
 
 //CLASS IMPLEMENTATIONS:
 
@@ -113,7 +117,7 @@ -(BOOL)isKindOfClass:(Class)aClass {return [_target isKindOfClass:aClass];}
 
 // Make concrete implementations for CCTexture methods commonly called at runtime.
 -(GLuint)name {return [(CCTexture *)_target name];}
--(CGFloat)contentScale {return [_target contentScale];}
+-(CGFloat)contentScale {return [(CCTexture *)_target contentScale];}
 -(CGSize)contentSize {return [_target contentSize];}
 -(NSUInteger)pixelWidth {return [_target pixelWidth];}
 -(NSUInteger)pixelHeight {return [_target pixelHeight];}
@@ -122,7 +126,7 @@ -(CCSpriteFrame *)createSpriteFrame {return [_target createSpriteFrame];}
 
 // Make concrete implementations for CCSpriteFrame methods commonly called at runtime.
 -(CGRect)rect {return [_target rect];}
--(CGPoint)offset {return [_target offset];}
+-(CGPoint)offset {return [(CCSpriteFrame *)_target offset];}
 -(BOOL)rotated {return [_target rotated];}
 -(CGSize)originalSize {return [_target originalSize];}
 -(CCTexture *)texture {return [_target texture];}
@@ -152,7 +156,18 @@ - (void)dealloc
 
 @implementation CCTexture
 {
-    CCProxy __weak *_proxy;
+	GLuint _name;
+	CGSize _sizeInPixels;
+	CGFloat _contentScale;
+	NSUInteger _width, _height;
+	CCTexturePixelFormat _format;
+	GLfloat _maxS, _maxT;
+	BOOL _premultipliedAlpha;
+	BOOL _hasMipmaps;
+	
+	BOOL _antialiased;
+	
+	CCProxy __weak *_proxy;
 }
 
 @synthesize contentSizeInPixels = _sizeInPixels, pixelFormat = _format, pixelWidth = _width, pixelHeight = _height, name = _name, maxS = _maxS, maxT = _maxT;
@@ -187,6 +202,42 @@ - (id) initWithData:(const void*)data pixelFormat:(CCTexturePixelFormat)pixelFor
 {
 	if((self = [super init])) {
 		CCRenderDispatch(NO, ^{
+#if __CC_METAL_SUPPORTED_AND_ENABLED
+			if([CCConfiguration sharedConfiguration].graphicsAPI == CCGraphicsAPIMetal){
+				id<MTLDevice> device = [CCMetalContext currentContext].device;
+				
+				MTLSamplerDescriptor *samplerDesc = [MTLSamplerDescriptor new];
+				samplerDesc.minFilter = MTLSamplerMinMagFilterLinear;
+				samplerDesc.magFilter = MTLSamplerMinMagFilterLinear;
+				samplerDesc.mipFilter = MTLSamplerMipFilterNotMipmapped;
+				samplerDesc.sAddressMode = MTLSamplerAddressModeClampToEdge;
+				samplerDesc.tAddressMode = MTLSamplerAddressModeClampToEdge;
+				
+				_metalSampler = [device newSamplerStateWithDescriptor:samplerDesc];
+				
+				static const MTLPixelFormat metalFormats[] = {
+					MTLPixelFormatRGBA8Unorm,
+					MTLPixelFormatInvalid, //CCTexturePixelFormat_RGB888,
+					MTLPixelFormatInvalid, //CCTexturePixelFormat_RGB565,
+					MTLPixelFormatA8Unorm, //CCTexturePixelFormat_A8,
+					MTLPixelFormatRG8Unorm, //CCTexturePixelFormat_I8,
+					MTLPixelFormatInvalid, //CCTexturePixelFormat_AI88,
+					MTLPixelFormatABGR4Unorm, //CCTexturePixelFormat_RGBA4444,
+					MTLPixelFormatInvalid, //CCTexturePixelFormat_RGB5A1,
+					MTLPixelFormatPVRTC_RGBA_4BPP, //CCTexturePixelFormat_PVRTC4,
+					MTLPixelFormatPVRTC_RGBA_2BPP, //CCTexturePixelFormat_PVRTC2,
+				};
+				MTLPixelFormat metalFormat = metalFormats[pixelFormat];
+				NSAssert(metalFormat != MTLPixelFormatInvalid, @"This texture format is not supported by Apple's Metal API.");
+				
+				MTLTextureDescriptor *textureDesc = [MTLTextureDescriptor texture2DDescriptorWithPixelFormat:metalFormat width:width height:height mipmapped:NO];
+				_metalTexture = [device newTextureWithDescriptor:textureDesc];
+				
+				NSUInteger bytesPerRow = width*[CCTexture bitsPerPixelForFormat:pixelFormat]/8;
+				[_metalTexture replaceRegion:MTLRegionMake2D(0, 0, width, height) mipmapLevel:0 withBytes:data bytesPerRow:bytesPerRow];
+			} else
+#endif
+			{
 			CCGL_DEBUG_PUSH_GROUP_MARKER("CCTexture: Init");
 
 			// XXX: 32 bits or POT textures uses UNPACK of 4 (is this correct ??? )
@@ -233,6 +284,7 @@ - (id) initWithData:(const void*)data pixelFormat:(CCTexturePixelFormat)pixelFor
 			}
 
 			CCGL_DEBUG_POP_GROUP_MARKER();
+			}
 		});
 
 		_sizeInPixels  = sizeInPixels;
@@ -296,7 +348,7 @@ - (void*) keepData:(void*)data length:(NSUInteger)length
 - (void) dealloc
 {
 	CCLOGINFO(@"cocos2d: deallocing %@", self);
-
+	
 	GLuint name = _name;
 	if(name){
 		CCRenderDispatch(YES, ^{
@@ -618,6 +670,8 @@ +(void) PVRImagesHavePremultipliedAlpha:(BOOL)haveAlphaPremultiplied
 #pragma mark -
 #pragma mark CCTexture2D - GLFilter
 
+#warning Not implemented for Metal.
+
 //
 // Use to apply MIN/MAG filter
 //

cocos2d/CCTexture_Private.h

@@ -25,6 +25,11 @@
 
 #import "CCTexture.h"
 
+#if __CC_METAL_SUPPORTED_AND_ENABLED
+#import <Metal/Metal.h>
+#endif
+
+
 // -------------------------------------------------------------
 
 // Proxy object returned in place of a CCTexture or CCSpriteFrame by the texture cache.
@@ -47,11 +52,18 @@
 /* texture name */
 @property(nonatomic,readonly) GLuint name;
 
+#if __CC_METAL_SUPPORTED_AND_ENABLED
+@property(nonatomic,readonly) id<MTLTexture> metalTexture;
+@property(nonatomic,readonly) id<MTLSamplerState> metalSampler;
+#endif
+
 /* texture max S */
 @property(nonatomic,readwrite) GLfloat maxS;
 /* texture max T */
 @property(nonatomic,readwrite) GLfloat maxT;
 
+@property(nonatomic,readwrite) BOOL premultipliedAlpha;
+
 // Check if the texture's weakly retained proxy still exists.
 @property(atomic, readonly) BOOL hasProxy;
 

cocos2d/Platforms/iOS/CCMetalSupport.m

@@ -24,9 +24,10 @@
  */
 
 #import "CCMetalSupport_Private.h"
-
 #if __CC_METAL_SUPPORTED_AND_ENABLED
 
+#import "CCTexture_Private.h"
+
 @implementation CCMetalContext
 
 -(instancetype)init
@@ -44,6 +45,9 @@ -(instancetype)init
 
 NSString *CURRENT_CONTEXT_KEY = @"CURRENT_CONTEXT_KEY";
 
+#warning TODO
+// This uses a pretty measurable piece of CPU time.
+// Access through the CCRenderer when possible somehow?
 static inline CCMetalContext *
 CCMetalContextCurrent(void)
 {
@@ -164,9 +168,19 @@ -(void)bind:(BOOL)bind
 @end
 
 
+// This is effectively hardcoded to 10 by Apple's docs and there is no API to query capabilities...
+// Seems like an oversight, but whatever.
+#define CCMTL_MAX_TEXTURES 10
+
+
 @interface CCRenderStateMetal : CCRenderState @end
 @implementation CCRenderStateMetal {
 	id<MTLRenderPipelineState> _renderPipelineState;
+	
+	NSRange _textureRange;
+	// TODO should be unretained once the sampler issue is fixed.
+	id<MTLSamplerState> _samplers[CCMTL_MAX_TEXTURES];
+	__unsafe_unretained id<MTLTexture> _textures[CCMTL_MAX_TEXTURES];
 }
 
 // Using GL enums for CCBlendMode types should never have happened. Oops.
@@ -206,7 +220,7 @@ -(void)prepare
 		id<MTLLibrary> library = context.library;
 		#warning TEMP Hard coded shaders.
 		pipelineStateDescriptor.vertexFunction = [library newFunctionWithName:@"CCVertexFunctionDefault"];
-    pipelineStateDescriptor.fragmentFunction = [library newFunctionWithName:@"CCFragmentFunctionDefaultColor"];
+    pipelineStateDescriptor.fragmentFunction = [library newFunctionWithName:@"CCFragmentFunctionDefaultTextureColor"];
 
 		NSDictionary *blendOptions = _blendMode.options;
     MTLRenderPipelineColorAttachmentDescriptor *colorDescriptor = [MTLRenderPipelineColorAttachmentDescriptor new];
@@ -221,13 +235,20 @@ -(void)prepare
 		pipelineStateDescriptor.colorAttachments[0] = colorDescriptor;
 
     _renderPipelineState = [context.device newRenderPipelineStateWithDescriptor:pipelineStateDescriptor error:nil];
+		
+		CCTexture *texture = _shaderUniforms[CCShaderUniformMainTexture] ?: [CCTexture none];
+		_textureRange = NSMakeRange(0, 1);
+		_samplers[0] = texture.metalSampler ?: [context.device newSamplerStateWithDescriptor:[MTLSamplerDescriptor new]];
+		_textures[0] = texture.metalTexture;
 	}
 }
 
 -(void)transitionRenderer:(CCRenderer *)renderer FromState:(CCRenderState *)previous
 {
-	// TODO Get the context more efficiently through the renderer perhaps?
-	[CCMetalContextCurrent().currentRenderCommandEncoder setRenderPipelineState:_renderPipelineState];
+	id<MTLRenderCommandEncoder> renderEncoder = CCMetalContextCurrent().currentRenderCommandEncoder;
+	[renderEncoder setRenderPipelineState:_renderPipelineState];
+	[renderEncoder setFragmentSamplerStates:_samplers withRange:_textureRange];
+	[renderEncoder setFragmentTextures:_textures withRange:_textureRange];
 }
 
 @end