iMiniB3D: thread safe texture2d

BlitzMax Forums/MiniB3D Module/iMiniB3D: thread safe texture2d

ima747 (Posted 2010) [#1]

This is a modification I've made to texture2d (the os specific underpinning for Texture) for iMiniB3D. It's every so slightly slower than the official texture2d (not noticable, talking millisecs) but it allows you to create textures from threads other than the main (opengl) thread. It does as much as it can processing wise on the calling thread, but when it gets to the final step of creating the texture it bundles the texture data into an object and shoves that to the main thread. It will still work for "normal" calls as well, and could be optimized slightly (do traditional call if it's already on the main thread, and threaded call on a child thread...) but it doesn't really need it. Texture2D.h /* ===== IMPORTANT ===== This is sample code demonstrating API, technology or techniques in development. Although this sample code has been reviewed for technical accuracy, it is not final. Apple is supplying this information to help you plan for the adoption of the technologies and programming interfaces described herein. This information is subject to change, and software implemented based on this sample code should be tested with final operating system software and final documentation. Newer versions of this sample code may be provided with future seeds of the API or technology. For information about updates to this and other developer documentation, view the New & Updated sidebars in subsequent documentation seeds. ===================== File: Texture2D.h Abstract: Creates OpenGL 2D textures from images or text. Version: 1.6 Disclaimer: IMPORTANT: This Apple software is supplied to you by Apple Inc. ("Apple") in consideration of your agreement to the following terms, and your use, installation, modification or redistribution of this Apple software constitutes acceptance of these terms. If you do not agree with these terms, please do not use, install, modify or redistribute this Apple software. In consideration of your agreement to abide by the following terms, and subject to these terms, Apple grants you a personal, non-exclusive license, under Apple's copyrights in this original Apple software (the "Apple Software"), to use, reproduce, modify and redistribute the Apple Software, with or without modifications, in source and/or binary forms; provided that if you redistribute the Apple Software in its entirety and without modifications, you must retain this notice and the following text and disclaimers in all such redistributions of the Apple Software. Neither the name, trademarks, service marks or logos of Apple Inc. may be used to endorse or promote products derived from the Apple Software without specific prior written permission from Apple. Except as expressly stated in this notice, no other rights or licenses, express or implied, are granted by Apple herein, including but not limited to any patent rights that may be infringed by your derivative works or by other works in which the Apple Software may be incorporated. The Apple Software is provided by Apple on an "AS IS" basis. APPLE MAKES NO WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, REGARDING THE APPLE SOFTWARE OR ITS USE AND OPERATION ALONE OR IN COMBINATION WITH YOUR PRODUCTS. IN NO EVENT SHALL APPLE BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION, MODIFICATION AND/OR DISTRIBUTION OF THE APPLE SOFTWARE, HOWEVER CAUSED AND WHETHER UNDER THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE), STRICT LIABILITY OR OTHERWISE, EVEN IF APPLE HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. Copyright (C) 2008 Apple Inc. All Rights Reserved. */ #import <UIKit/UIKit.h> #import <OpenGLES/ES1/gl.h> //CONSTANTS: typedef enum { kTexture2DPixelFormat_Automatic = 0, kTexture2DPixelFormat_RGBA8888, kTexture2DPixelFormat_RGB565, kTexture2DPixelFormat_A8, } Texture2DPixelFormat; //CLASS INTERFACES: /* This class allows to easily create OpenGL 2D textures from images, text or raw data. The created Texture2D object will always have power-of-two dimensions. Depending on how you create the Texture2D object, the actual image area of the texture might be smaller than the texture dimensions 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 TextureDataBundle : NSObject{ // object required for threaded loading const void* data; Texture2DPixelFormat pixelFormat; NSUInteger width; NSUInteger height; CGSize size; } @property (nonatomic, readwrite) const void* data; @property (nonatomic, readwrite) Texture2DPixelFormat pixelFormat; @property (nonatomic, readwrite) NSUInteger width; @property (nonatomic, readwrite) NSUInteger height; @property (nonatomic, readwrite) CGSize size; @end @interface Texture2D : NSObject { @private GLuint _name; CGSize _size; NSUInteger _width, _height; Texture2DPixelFormat _format; GLfloat _maxS, _maxT; } - (id) initWithData:(const void*)data pixelFormat:(Texture2DPixelFormat)pixelFormat pixelsWide:(NSUInteger)width pixelsHigh:(NSUInteger)height contentSize:(CGSize)size; - (id) initWithTextureDataBundle:(TextureDataBundle*)dataBundle; // addition for threaded texture loading @property(readonly) Texture2DPixelFormat pixelFormat; @property(readonly) NSUInteger pixelsWide; @property(readonly) NSUInteger pixelsHigh; @property(readonly) GLuint name; @property(readonly, nonatomic) CGSize contentSize; @property(readonly) GLfloat maxS; @property(readonly) GLfloat maxT; @end /* Drawing extensions to make it easy to draw basic quads using a Texture2D object. These functions require GL_TEXTURE_2D and both GL_VERTEX_ARRAY and GL_TEXTURE_COORD_ARRAY client states to be enabled. */ @interface Texture2D (Drawing) - (void) drawAtPoint:(CGPoint)point; - (void) drawInRect:(CGRect)rect; @end /* Extensions to make it easy to create a Texture2D object from an image file. Note that RGBA type textures will have their alpha premultiplied - use the blending mode (GL_ONE, GL_ONE_MINUS_SRC_ALPHA). */ @interface Texture2D (Image) - (id) initWithImage:(UIImage *)uiImage; @end /* Extensions to make it easy to create a Texture2D object from a string of text. Note that the generated textures are of type A8 - use the blending mode (GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA). */ @interface Texture2D (Text) - (id) initWithString:(NSString*)string dimensions:(CGSize)dimensions alignment:(UITextAlignment)alignment fontName:(NSString*)name fontSize:(CGFloat)size; @end Texture2D.mm /* ===== IMPORTANT ===== This is sample code demonstrating API, technology or techniques in development. Although this sample code has been reviewed for technical accuracy, it is not final. Apple is supplying this information to help you plan for the adoption of the technologies and programming interfaces described herein. This information is subject to change, and software implemented based on this sample code should be tested with final operating system software and final documentation. Newer versions of this sample code may be provided with future seeds of the API or technology. For information about updates to this and other developer documentation, view the New & Updated sidebars in subsequent documentation seeds. ===================== File: Texture2D.m Abstract: Creates OpenGL 2D textures from images or text. Version: 1.6 Disclaimer: IMPORTANT: This Apple software is supplied to you by Apple Inc. ("Apple") in consideration of your agreement to the following terms, and your use, installation, modification or redistribution of this Apple software constitutes acceptance of these terms. If you do not agree with these terms, please do not use, install, modify or redistribute this Apple software. In consideration of your agreement to abide by the following terms, and subject to these terms, Apple grants you a personal, non-exclusive license, under Apple's copyrights in this original Apple software (the "Apple Software"), to use, reproduce, modify and redistribute the Apple Software, with or without modifications, in source and/or binary forms; provided that if you redistribute the Apple Software in its entirety and without modifications, you must retain this notice and the following text and disclaimers in all such redistributions of the Apple Software. Neither the name, trademarks, service marks or logos of Apple Inc. may be used to endorse or promote products derived from the Apple Software without specific prior written permission from Apple. Except as expressly stated in this notice, no other rights or licenses, express or implied, are granted by Apple herein, including but not limited to any patent rights that may be infringed by your derivative works or by other works in which the Apple Software may be incorporated. The Apple Software is provided by Apple on an "AS IS" basis. APPLE MAKES NO WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, REGARDING THE APPLE SOFTWARE OR ITS USE AND OPERATION ALONE OR IN COMBINATION WITH YOUR PRODUCTS. IN NO EVENT SHALL APPLE BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION, MODIFICATION AND/OR DISTRIBUTION OF THE APPLE SOFTWARE, HOWEVER CAUSED AND WHETHER UNDER THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE), STRICT LIABILITY OR OTHERWISE, EVEN IF APPLE HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. Copyright (C) 2008 Apple Inc. All Rights Reserved. */ #import <OpenGLES/ES1/glext.h> #import "Texture2D.h" //CONSTANTS: //#define kMaxTextureSize 1024 // UIRequiredDeviceCapabilities opengles-1 // Everything //#define kMaxTextureSize 2048 // UIRequiredDeviceCapabilities opengles-2 // 3Gs and higher GLint maxTextureSize = 1024; //CLASS IMPLEMENTATIONS: @implementation TextureDataBundle @synthesize data, pixelFormat, width, height, size; @end @implementation Texture2D @synthesize contentSize=_size, pixelFormat=_format, pixelsWide=_width, pixelsHigh=_height, name=_name, maxS=_maxS, maxT=_maxT; - (id) initWithData:(const void*)data pixelFormat:(Texture2DPixelFormat)pixelFormat pixelsWide:(NSUInteger)width pixelsHigh:(NSUInteger)height contentSize:(CGSize)size { GLint saveName; if((self = [super init])) { glGenTextures(1, &_name); glGetIntegerv(GL_TEXTURE_BINDING_2D, &saveName); glBindTexture(GL_TEXTURE_2D, _name); glTexParameterf(GL_TEXTURE_2D,GL_GENERATE_MIPMAP, GL_TRUE); glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_LINEAR); switch(pixelFormat) { case kTexture2DPixelFormat_RGBA8888: glTexImage2D(GL_TEXTURE_2D, 0, GL_RGBA, width, height, 0, GL_RGBA, GL_UNSIGNED_BYTE, data); break; case kTexture2DPixelFormat_RGB565: glTexImage2D(GL_TEXTURE_2D, 0, GL_RGB, width, height, 0, GL_RGB, GL_UNSIGNED_SHORT_5_6_5, data); break; case kTexture2DPixelFormat_A8: glTexImage2D(GL_TEXTURE_2D, 0, GL_ALPHA, width, height, 0, GL_ALPHA, GL_UNSIGNED_BYTE, data); break; default: [NSException raise:NSInternalInconsistencyException format:@""]; } glBindTexture(GL_TEXTURE_2D, saveName); _size = size; _width = width; _height = height; _format = pixelFormat; _maxS = size.width / (float)width; _maxT = size.height / (float)height; } return self; } - (id) initWithTextureDataBundle:(TextureDataBundle*)dataBundle { return [self initWithData:dataBundle.data pixelFormat:dataBundle.pixelFormat pixelsWide:dataBundle.width pixelsHigh:dataBundle.height contentSize:dataBundle.size]; } - (void) dealloc { if(_name) glDeleteTextures(1, &_name); [super dealloc]; } - (NSString*) description { return [NSString stringWithFormat:@"<%@ = %08X | Name = %i | Dimensions = %ix%i | Coordinates = (%.2f, %.2f)>", [self class], self, _name, _width, _height, _maxS, _maxT]; } @end @implementation Texture2D (Image) - (id) initWithImage:(UIImage *)uiImage { NSUInteger width, height, i; CGContextRef context = nil; void* data = nil;; CGColorSpaceRef colorSpace; void* tempData; unsigned int* inPixel32; unsigned short* outPixel16; BOOL hasAlpha; CGImageAlphaInfo info; CGAffineTransform transform; CGSize imageSize; Texture2DPixelFormat pixelFormat; CGImageRef image; UIImageOrientation orientation; BOOL sizeToFit = NO; image = [uiImage CGImage]; if(image == NULL) { [self release]; NSLog(@"Image is Null"); return nil; } orientation = [uiImage imageOrientation]; info = CGImageGetAlphaInfo(image); hasAlpha = ((info == kCGImageAlphaPremultipliedLast) || (info == kCGImageAlphaPremultipliedFirst) || (info == kCGImageAlphaLast) || (info == kCGImageAlphaFirst) ? YES : NO); if(CGImageGetColorSpace(image)) { if(hasAlpha) pixelFormat = kTexture2DPixelFormat_RGBA8888; else pixelFormat = kTexture2DPixelFormat_RGB565; } else //NOTE: No colorspace means a mask image pixelFormat = kTexture2DPixelFormat_A8; imageSize = CGSizeMake(CGImageGetWidth(image), CGImageGetHeight(image)); transform = CGAffineTransformIdentity; width = imageSize.width; if((width != 1) && (width & (width - 1))) { i = 1; while((sizeToFit ? 2 * i : i) < width) i *= 2; width = i; } height = imageSize.height; if((height != 1) && (height & (height - 1))) { i = 1; while((sizeToFit ? 2 * i : i) < height) i *= 2; height = i; } //NSLog(@"tex size %i", maxTextureSize); while((width > maxTextureSize) || (height > maxTextureSize)) { width /= 2; height /= 2; transform = CGAffineTransformScale(transform, 0.5, 0.5); imageSize.width *= 0.5; imageSize.height *= 0.5; } //NSLog(@"image size %ix%i", width, height); bool drawRotatedDimensions = NO; switch (orientation) { case UIImageOrientationUp: //NSLog(@"oriented up"); break; case UIImageOrientationLeft: //NSLog(@"left"); transform = CGAffineTransformTranslate(transform, CGImageGetWidth(image), 0); transform = CGAffineTransformRotate(transform, (M_PI / 2.0)); drawRotatedDimensions = YES; break; case UIImageOrientationRight: //NSLog(@"right"); transform = CGAffineTransformTranslate(transform, 0, CGImageGetHeight(image)); transform = CGAffineTransformRotate(transform, -(M_PI / 2.0)); drawRotatedDimensions = YES; break; case UIImageOrientationDown: //NSLog(@"down"); transform = CGAffineTransformTranslate(transform, CGImageGetWidth(image), CGImageGetHeight(image)); transform = CGAffineTransformRotate(transform, -M_PI); break; default: NSLog(@"Unsuported Texture Image Orientation"); break; } switch(pixelFormat) { case kTexture2DPixelFormat_RGBA8888: colorSpace = CGColorSpaceCreateDeviceRGB(); data = malloc(height * width * 4); context = CGBitmapContextCreate(data, width, height, 8, 4 * width, colorSpace, kCGImageAlphaPremultipliedLast | kCGBitmapByteOrder32Big); CGColorSpaceRelease(colorSpace); break; case kTexture2DPixelFormat_RGB565: colorSpace = CGColorSpaceCreateDeviceRGB(); data = malloc(height * width * 4); context = CGBitmapContextCreate(data, width, height, 8, 4 * width, colorSpace, kCGImageAlphaNoneSkipLast | kCGBitmapByteOrder32Big); CGColorSpaceRelease(colorSpace); break; case kTexture2DPixelFormat_A8: data = malloc(height * width); context = CGBitmapContextCreate(data, width, height, 8, width, NULL, kCGImageAlphaOnly); break; default: [NSException raise:NSInternalInconsistencyException format:@"Invalid pixel format"]; } CGContextClearRect(context, CGRectMake(0, 0, width, height)); //CGContextClearRect(context, CGRectMake(0, 0, imageSize.width, imageSize.height)); CGContextTranslateCTM(context, 0, height - imageSize.height); if(!CGAffineTransformIsIdentity(transform)) CGContextConcatCTM(context, transform); //CGContextDrawImage(context, CGRectMake(0, 0, CGImageGetWidth(image), CGImageGetHeight(image)), image); if (drawRotatedDimensions) CGContextDrawImage(context, CGRectMake(0, 0, CGImageGetHeight(image), CGImageGetWidth(image)), image); else CGContextDrawImage(context, CGRectMake(0, 0, CGImageGetWidth(image), CGImageGetHeight(image)), image); //Convert "RRRRRRRRRGGGGGGGGBBBBBBBBAAAAAAAA" to "RRRRRGGGGGGBBBBB" if(pixelFormat == kTexture2DPixelFormat_RGB565) { tempData = malloc(height * width * 2); inPixel32 = (unsigned int*)data; outPixel16 = (unsigned short*)tempData; for(i = 0; i < width * height; ++i, ++inPixel32) *outPixel16++ = ((((*inPixel32 >> 0) & 0xFF) >> 3) << 11) | ((((*inPixel32 >> 8) & 0xFF) >> 2) << 5) | ((((*inPixel32 >> 16) & 0xFF) >> 3) << 0); free(data); data = tempData; } //self = [self initWithData:data pixelFormat:pixelFormat pixelsWide:width pixelsHigh:height contentSize:imageSize]; TextureDataBundle *dataBundle = [[TextureDataBundle alloc] init]; dataBundle.data = data; dataBundle.pixelFormat = pixelFormat; dataBundle.width = width; dataBundle.height = height; dataBundle.size = imageSize; //self = [self initWithTextureDataBundle:dataBundle]; [self performSelectorOnMainThread:@selector(initWithTextureDataBundle:) withObject:dataBundle waitUntilDone:YES]; [dataBundle release]; CGContextRelease(context); free(data); return self; } @end @implementation Texture2D (Text) - (id) initWithString:(NSString*)string dimensions:(CGSize)dimensions alignment:(UITextAlignment)alignment fontName:(NSString*)name fontSize:(CGFloat)size { NSUInteger width, height, i; CGContextRef context; void* data; CGColorSpaceRef colorSpace; UIFont * font; font = [UIFont fontWithName:name size:size]; width = dimensions.width; if((width != 1) && (width & (width - 1))) { i = 1; while(i < width) i *= 2; width = i; } height = dimensions.height; if((height != 1) && (height & (height - 1))) { i = 1; while(i < height) i *= 2; height = i; } colorSpace = CGColorSpaceCreateDeviceGray(); data = calloc(height, width); context = CGBitmapContextCreate(data, width, height, 8, width, colorSpace, kCGImageAlphaNone); CGColorSpaceRelease(colorSpace); CGContextSetGrayFillColor(context, 1.0, 1.0); CGContextTranslateCTM(context, 0.0, height); CGContextScaleCTM(context, 1.0, -1.0); //NOTE: NSString draws in UIKit referential i.e. renders upside-down compared to CGBitmapContext referential UIGraphicsPushContext(context); [string drawInRect:CGRectMake(0, 0, dimensions.width, dimensions.height) withFont:font lineBreakMode:UILineBreakModeWordWrap alignment:alignment]; UIGraphicsPopContext(); self = [self initWithData:data pixelFormat:kTexture2DPixelFormat_A8 pixelsWide:width pixelsHigh:height contentSize:dimensions]; CGContextRelease(context); free(data); return self; } @end @implementation Texture2D (Drawing) - (void) drawAtPoint:(CGPoint)point { GLfloat coordinates[] = { 0, _maxT, _maxS, _maxT, 0, 0, _maxS, 0 }; GLfloat width = (GLfloat)_width * _maxS, height = (GLfloat)_height * _maxT; GLfloat vertices[] = { -width / 2 + point.x, -height / 2 + point.y, 0.0, width / 2 + point.x, -height / 2 + point.y, 0.0, -width / 2 + point.x, height / 2 + point.y, 0.0, width / 2 + point.x, height / 2 + point.y, 0.0 }; glBindTexture(GL_TEXTURE_2D, _name); glVertexPointer(3, GL_FLOAT, 0, vertices); glTexCoordPointer(2, GL_FLOAT, 0, coordinates); glDrawArrays(GL_TRIANGLE_STRIP, 0, 4); } - (void) drawInRect:(CGRect)rect { GLfloat coordinates[] = { 0, _maxT, _maxS, _maxT, 0, 0, _maxS, 0 }; GLfloat vertices[] = { rect.origin.x, rect.origin.y, 0.0, rect.origin.x + rect.size.width, rect.origin.y, 0.0, rect.origin.x, rect.origin.y + rect.size.height, 0.0, rect.origin.x + rect.size.width, rect.origin.y + rect.size.height, 0.0 }; glBindTexture(GL_TEXTURE_2D, _name); glVertexPointer(3, GL_FLOAT, 0, vertices); glTexCoordPointer(2, GL_FLOAT, 0, coordinates); glDrawArrays(GL_TRIANGLE_STRIP, 0, 4); } @end Last edited 2010

jhocking (Posted 2010) [#2]

Thanks for sharing, but could you maybe explain what this is for? I'm not too familiar with multithreading; I'm thinking this is to load textures in the background while the game is running but I'm not sure.

ima747 (Posted 2010) [#3]

that's one use. the threading system in iOS is actually really good at load balancing so you could also use this (like I do) for dynamic quality adjustment. e.g. load low res textures to conserver the very limited vram, and when you get close to something, or the user triggers something load a higher res version. You could also use it to load textures on a child thread while you use the main application thread to display a loading animation or what have you.