OOTexture Class Reference

#include <OOTexture.h>

Inheritance diagram for OOTexture:

Collaboration diagram for OOTexture:

Instance Methods
(void)	- apply
(void)	- ensureFinishedLoading
(BOOL)	- isFinishedLoading
(NSString *)	- cacheKey
(NSSize)	- dimensions
(NSSize)	- originalDimensions
(BOOL)	- isMipMapped
(OOPixMap)	- copyPixMapRepresentation
(BOOL)	- isRectangleTexture
(BOOL)	- isCubeMap
(NSSize)	- texCoordsScale
(GLint)	- glTextureName
(void)	- setTrace:
(size_t)	- dataSize
(NSString *)	- name
(id)	- init [implementation]
(void)	- dealloc [implementation]
(void)	- forceRebind [implementation]
(void)	- addToCaches [implementation]
(void)	- removeFromCaches [implementation]
(id)	- retainInContext: [implementation]
(void)	- releaseInContext: [implementation]
(id)	- autoreleaseInContext: [implementation]
(id)	- retain [implementation]
(oneway void)	- release [implementation]
(id)	- autorelease [implementation]
Instance Methods inherited from OOWeakRefObject
(id)	- weakSelf
(id)	- weakRetain [implementation]
(void)	- weakRefDied: [implementation]
Instance Methods inherited from <OOWeakReferenceSupport>
(id)	- OO_RETURNS_RETAINED

Class Methods
(id)	+ textureWithName:inFolder:options:anisotropy:lodBias:
(id)	+ textureWithName:inFolder:
(id)	+ textureWithConfiguration:
(id)	+ textureWithConfiguration:extraOptions:
(id)	+ nullTexture
(id)	+ textureWithGenerator:
(id)	+ textureWithGenerator:enqueue:
(void)	+ applyNone
(void)	+ clearCache
(void)	+ rebindAllTextures
(NSArray *)	+ cachedTexturesByAge
(NSSet *)	+ allTextures
(OOTexture *)	+ existingTextureForKey: [implementation]
(void)	+ checkExtensions [implementation]

Protected Attributes
BOOL	_trace
Protected Attributes inherited from OOWeakRefObject
OOWeakReference *	weakSelf

Detailed Description

Definition at line 116 of file OOTexture.h.

Method Documentation

addToCaches

- (void) addToCaches

implementation

Provided by category OOTexture(SubclassInterface).

Definition at line 924 of file OOTexture.m.

{
#ifndef OOTEXTURE_NO_CACHE
    NSString *cacheKey = [self cacheKey];
    if (cacheKey == nil)  return;
    
    // Add self to in-use textures cache, wrapped in an NSValue so the texture isn't retained by the cache.
    if (EXPECT_NOT(sLiveTextureCache == nil))  sLiveTextureCache = [[NSMutableDictionary alloc] init];
    
    SET_TRACE_CONTEXT(@"in-use textures cache - SHOULD NOT RETAIN");
    [sLiveTextureCache setObject:[NSValue valueWithPointer:self] forKey:cacheKey];
    CLEAR_TRACE_CONTEXT();
    
    // Add self to recent textures cache.
    if (EXPECT_NOT(sRecentTextures == nil))
    {
        sRecentTextures = [[OOCache alloc] init];
        [sRecentTextures setName:@"recent textures"];
        [sRecentTextures setAutoPrune:YES];
        [sRecentTextures setPruneThreshold:kRecentTexturesCount];
    }
    
    SET_TRACE_CONTEXT(@"adding to recent textures cache");
    [sRecentTextures setObject:self forKey:cacheKey];
    CLEAR_TRACE_CONTEXT();
#endif
}

References OOGenerateTextureCacheKey(), and OOInterpretTextureSpecifier().

Here is the call graph for this function:

allTextures

+ (NSSet *) allTextures

Definition at line 924 of file OOTexture.m.

{
    NSMutableSet *result = [NSMutableSet setWithCapacity:[sAllLiveTextures count]];
    NSValue *box = nil;
    NSEnumerator *texEnum = nil;
    for (texEnum = [sAllLiveTextures objectEnumerator]; (box = [texEnum nextObject]); )
    {
        [result addObject:[box pointerValue]];
    }
    
    return result;
}

apply

- (void) apply

Reimplemented in OOConcreteTexture, and OONullTexture.

Provided by category OOTexture(SubclassResponsibilities).

Definition at line 924 of file OOTexture.m.

{
    OOLogGenericSubclassResponsibility();
}

Referenced by HeadUpDisplay::OODrawPlanetInfo, and HeadUpDisplay::OOStartDrawingStrings.

Here is the caller graph for this function:

applyNone

+ (void) applyNone

Definition at line 924 of file OOTexture.m.

{
    OO_ENTER_OPENGL();
    OOGL(glBindTexture(GL_TEXTURE_2D, 0));
#if OO_TEXTURE_CUBE_MAP
    if (OOCubeMapsAvailable())  OOGL(glBindTexture(GL_TEXTURE_CUBE_MAP, 0));
#endif
    
#if GL_EXT_texture_lod_bias
    if (gOOTextureInfo.textureLODBiasAvailable)  OOGL(glTexEnvf(GL_TEXTURE_FILTER_CONTROL_EXT, GL_TEXTURE_LOD_BIAS_EXT, 0));
#endif
}

Referenced by HeadUpDisplay::OODrawPlanetInfo, and HeadUpDisplay::OOStopDrawingStrings.

Here is the caller graph for this function:

autorelease

- (id) autorelease

implementation

Reimplemented in OONullTexture.

Definition at line 924 of file OOTexture.m.

{
    return [self autoreleaseInContext:sGlobalTraceContext];
}

autoreleaseInContext:

- (id) autoreleaseInContext: (NSString *) context

implementation

Provided by category OOTexture(OOPrivate).

Definition at line 924 of file OOTexture.m.

                           :(NSString *)context
{
    if (_trace)
    {
        if (context)  OOLog(@"texture.allocTrace.autoreleased", @"Texture %p autoreleased - %@.", self, context);
        else  OOLog(@"texture.allocTrace.autoreleased", @"Texture %p autoreleased.", self);
    }
    
    return [super autorelease];
}

cachedTexturesByAge

+ (NSArray *) cachedTexturesByAge

Definition at line 924 of file OOTexture.m.

{
    return [sRecentTextures objectsByAge];
}

cacheKey

- (NSString *) cacheKey

Reimplemented in OOConcreteTexture.

Provided by category OOTexture(SubclassOptional).

Definition at line 924 of file OOTexture.m.

{
    return nil;
}

checkExtensions

+ (void) checkExtensions

implementation

Provided by category OOTexture(OOPrivate).

Definition at line 924 of file OOTexture.m.

{
    OO_ENTER_OPENGL();
    
    sCheckedExtensions = YES;
    
    OOOpenGLExtensionManager    *extMgr = [OOOpenGLExtensionManager sharedManager];
    BOOL                        ver120 = [extMgr versionIsAtLeastMajor:1 minor:2];
    BOOL                        ver130 = [extMgr versionIsAtLeastMajor:1 minor:3];
    
#if GL_EXT_texture_filter_anisotropic
    gOOTextureInfo.anisotropyAvailable = [extMgr haveExtension:@"GL_EXT_texture_filter_anisotropic"];
    OOGL(glGetFloatv(GL_MAX_TEXTURE_MAX_ANISOTROPY_EXT, &gOOTextureInfo.anisotropyScale));
    gOOTextureInfo.anisotropyScale *= OOClamp_0_1_f([[NSUserDefaults standardUserDefaults] oo_floatForKey:@"texture-anisotropy-scale" defaultValue:0.5]);
#endif
    
#ifdef GL_CLAMP_TO_EDGE
    gOOTextureInfo.clampToEdgeAvailable = ver120 || [extMgr haveExtension:@"GL_SGIS_texture_edge_clamp"];
#endif
    
#if OO_GL_CLIENT_STORAGE
    gOOTextureInfo.clientStorageAvailable = [extMgr haveExtension:@"GL_APPLE_client_storage"];
#endif
    
    gOOTextureInfo.textureMaxLevelAvailable = ver120 || [extMgr haveExtension:@"GL_SGIS_texture_lod"];
    
#if GL_EXT_texture_lod_bias
    if ([[NSUserDefaults standardUserDefaults] oo_boolForKey:@"use-texture-lod-bias" defaultValue:YES])
    {
        gOOTextureInfo.textureLODBiasAvailable = [extMgr haveExtension:@"GL_EXT_texture_lod_bias"];
    }
    else
    {
        gOOTextureInfo.textureLODBiasAvailable = NO;
    }
#endif
    
#if GL_EXT_texture_rectangle
    gOOTextureInfo.rectangleTextureAvailable = [extMgr haveExtension:@"GL_EXT_texture_rectangle"];
#endif
    
#if OO_TEXTURE_CUBE_MAP
    if (![[NSUserDefaults standardUserDefaults] boolForKey:@"disable-cube-maps"])
    {
        gOOTextureInfo.cubeMapAvailable = ver130 || [extMgr haveExtension:@"GL_ARB_texture_cube_map"];
    }
    else
    {
        gOOTextureInfo.cubeMapAvailable = NO;
    }
 
#endif
}

clearCache

+ (void) clearCache

Definition at line 924 of file OOTexture.m.

{
    /*  Does not clear sAllLiveTextures - that really must refer to all
        live texture objects.
    */
    SET_TRACE_CONTEXT(@"clearing sLiveTextureCache");
    [sLiveTextureCache autorelease];
    sLiveTextureCache = nil;
    
    SET_TRACE_CONTEXT(@"clearing sRecentTextures");
    [sRecentTextures autorelease];
    sRecentTextures = nil;
    CLEAR_TRACE_CONTEXT();
}

copyPixMapRepresentation

- (struct OOPixMap) copyPixMapRepresentation

Reimplemented in OOConcreteTexture.

Provided by category OOTexture(SubclassOptional).

Definition at line 924 of file OOTexture.m.

{
    return kOONullPixMap;
}

dataSize

- (size_t) dataSize

Definition at line 924 of file OOTexture.m.

{
    NSSize dimensions = [self dimensions];
    size_t size = dimensions.width * dimensions.height;
    if ([self isCubeMap])  size *= 6;
    if ([self isMipMapped])  size = size * 4 / 3;
    
    return size;
}

dealloc

- (void) dealloc

implementation

Reimplemented from OOWeakRefObject.

Reimplemented in OOConcreteTexture.

Definition at line 924 of file OOTexture.m.

{
    [sAllLiveTextures removeObject:[NSValue valueWithPointer:self]];
    
    [super dealloc];
}

dimensions

- (NSSize) dimensions

Reimplemented in OOConcreteTexture, and OONullTexture.

Provided by category OOTexture(SubclassResponsibilities).

Definition at line 924 of file OOTexture.m.

{
    OOLogGenericSubclassResponsibility();
    return NSZeroSize;
}

ensureFinishedLoading

- (void) ensureFinishedLoading

Reimplemented in OOConcreteTexture.

Provided by category OOTexture(SubclassOptional).

Definition at line 924 of file OOTexture.m.

{
}

existingTextureForKey:

+ (OOTexture *) existingTextureForKey: (NSString *) key

implementation

Provided by category OOTexture(SubclassInterface).

Definition at line 924 of file OOTexture.m.

                                     :(NSString *)key
{
#ifndef OOTEXTURE_NO_CACHE
    if (key != nil)
    {
        return (OOTexture *)[[sLiveTextureCache objectForKey:key] pointerValue];
    }
    return nil;
#else
    return nil;
#endif
}

forceRebind

- (void) forceRebind

implementation

Reimplemented in OOConcreteTexture, and OONullTexture.

Provided by category OOTexture(SubclassResponsibilities).

Definition at line 924 of file OOTexture.m.

{
    OOLogGenericSubclassResponsibility();
}

glTextureName

- (GLint) glTextureName

Reimplemented in OOConcreteTexture.

Definition at line 924 of file OOTexture.m.

{
    OOLogGenericSubclassResponsibility();
    return 0;
}

init

- (id) init

implementation

Definition at line 924 of file OOTexture.m.

{
    if ((self = [super init]))
    {
        if (EXPECT_NOT(sAllLiveTextures == nil))  sAllLiveTextures = [[NSMutableSet alloc] init];
        [sAllLiveTextures addObject:[NSValue valueWithPointer:self]];
    }
    
    return self;
}

isCubeMap

- (BOOL) isCubeMap

Reimplemented in OOConcreteTexture.

Provided by category OOTexture(SubclassOptional).

Definition at line 924 of file OOTexture.m.

{
    return NO;
}

isFinishedLoading

- (BOOL) isFinishedLoading

Reimplemented in OOConcreteTexture.

Provided by category OOTexture(SubclassOptional).

Definition at line 924 of file OOTexture.m.

{
    return YES;
}

isMipMapped

- (BOOL) isMipMapped

Reimplemented in OOConcreteTexture, and OONullTexture.

Definition at line 924 of file OOTexture.m.

{
    OOLogGenericSubclassResponsibility();
    return NO;
}

isRectangleTexture

- (BOOL) isRectangleTexture

Reimplemented in OOConcreteTexture.

Provided by category OOTexture(SubclassOptional).

Definition at line 924 of file OOTexture.m.

{
    return NO;
}

name

- (NSString *) name

Reimplemented in OOConcreteTexture, and OONullTexture.

Definition at line 924 of file OOTexture.m.

{
    OOLogGenericSubclassResponsibility();
    return nil;
}

nullTexture

+ (id) nullTexture

Definition at line 924 of file OOTexture.m.

{
    return [OONullTexture sharedNullTexture];
}

originalDimensions

- (NSSize) originalDimensions

Reimplemented in OOConcreteTexture.

Definition at line 924 of file OOTexture.m.

{
    return [self dimensions];
}

Referenced by OOTextureSprite::blitBackgroundCentredToX:Y:Z:alpha:, and GuiDisplayGen(Internal)::drawAdvancedNavArrayAtX:y:z:alpha:usingRoute:optimizedBy:zoom:.

Here is the caller graph for this function:

rebindAllTextures

+ (void) rebindAllTextures

Definition at line 924 of file OOTexture.m.

{
    NSEnumerator            *textureEnum = nil;
    id                      texture = nil;
    
    // Keeping around unused, cached textures is unhelpful at this point.
    DESTROY(sRecentTextures);
    
    for (textureEnum = [sAllLiveTextures objectEnumerator]; (texture = [[textureEnum nextObject] pointerValue]); )
    {
        [texture forceRebind];
    }
}

release

- (oneway void) release

implementation

Reimplemented in OONullTexture.

Definition at line 924 of file OOTexture.m.

{
    [self releaseInContext:sGlobalTraceContext];
}

releaseInContext:

- (void) releaseInContext: (NSString *) context

implementation

Provided by category OOTexture(OOPrivate).

Definition at line 924 of file OOTexture.m.

                         :(NSString *)context
{
    if (_trace)
    {
        if (context)  OOLog(@"texture.allocTrace.release", @"Texture %p released (retain count -> %lu) - %@.", self, [self retainCount] - 1, context);
        else  OOLog(@"texture.allocTrace.release", @"Texture %p released (retain count -> %lu).", self, [self retainCount] - 1);
    }
    
    [super release];
}

removeFromCaches

- (void) removeFromCaches

implementation

Provided by category OOTexture(SubclassInterface).

Definition at line 924 of file OOTexture.m.

{
#ifndef OOTEXTURE_NO_CACHE
    NSString *cacheKey = [self cacheKey];
    if (cacheKey == nil)  return;
    
    [sLiveTextureCache removeObjectForKey:cacheKey];
    if (EXPECT_NOT([sRecentTextures objectForKey:cacheKey] == self))
    {
        /* Experimental for now: I think the recent crash problems may
         * be because if the last reference to a texture is in
         * sRecentTextures, and the texture is regenerated, it
         * replaces the texture, causing a release. Therefore, if this
         * texture *isn't* overretained in the texture cache, the 2009
         * crash avoider will delete its replacement from the cache
         * ... possibly before that texture has been fully added to
         * the cache itself. So, the texture is only removed from the
         * cache by key if it was in it with that key. The extra time
         * needed to generate a planet texture compared with loading a
         * standard one may be why this problem shows up.  - CIM 20140122
         */
        NSAssert2(0, @"Texture retain count error for %@; cacheKey is %@.", self, cacheKey); //miscount in autorelease
        // The following line is needed in order to avoid crashes when there's a 'texture retain count error'. Please do not delete. -- Kaks 20091221
        [sRecentTextures removeObjectForKey:cacheKey]; // make sure there's no reference left inside sRecentTexture ( was a show stopper for 1.73)
    }
#endif
}

retain

- (id) retain

implementation

Reimplemented in OONullTexture.

Definition at line 924 of file OOTexture.m.

{
    return [self retainInContext:sGlobalTraceContext];
}

Referenced by HeadUpDisplay::InitTextEngine(void).

Here is the caller graph for this function:

retainInContext:

- (id) retainInContext: (NSString *) context

implementation

Provided by category OOTexture(OOPrivate).

Definition at line 924 of file OOTexture.m.

                      :(NSString *)context
{
    if (_trace)
    {
        if (context)  OOLog(@"texture.allocTrace.retain", @"Texture %p retained (retain count -> %lu) - %@.", self, [self retainCount] + 1, context);
        else  OOLog(@"texture.allocTrace.retain", @"Texture %p retained  (retain count -> %lu).", self, [self retainCount] + 1);
    }
    
    return [super retain];
}

setTrace:

- (void) setTrace:

(BOOL)

trace

Definition at line 924 of file OOTexture.m.

                 :(BOOL)trace
{
    if (trace && !_trace)
    {
        OOLog(@"texture.allocTrace.begin", @"Started tracing texture %p with retain count %lu.", self, [self retainCount]);
    }
    _trace = trace;
}

texCoordsScale

- (NSSize) texCoordsScale

Reimplemented in OOConcreteTexture.

Provided by category OOTexture(SubclassOptional).

Definition at line 924 of file OOTexture.m.

{
    return NSMakeSize(1.0, 1.0);
}

textureWithConfiguration:

+ (id) textureWithConfiguration:

(id)

configuration

Definition at line 924 of file OOTexture.m.

                              :(id)configuration
{
    return [self textureWithConfiguration:configuration extraOptions:0];
}

Referenced by OOSingleTextureMaterial::allTextures.

Here is the caller graph for this function:

textureWithConfiguration:extraOptions:

+ (id) textureWithConfiguration:		(id)	configuration
extraOptions:		(OOTextureFlags)	extraOptions

Definition at line 924 of file OOTexture.m.

                               :(id)configuration extraOptions:(OOTextureFlags)extraOptions
{
    NSString                *name = nil;
    OOTextureFlags          options = 0;
    GLfloat                 anisotropy = 0.0f;
    GLfloat                 lodBias = 0.0f;
    
    if (!OOInterpretTextureSpecifier(configuration, &name, &options, &anisotropy, &lodBias, NO))  return nil;
    
    return [self textureWithName:name inFolder:@"Textures" options:options | extraOptions anisotropy:anisotropy lodBias:lodBias];
}

textureWithGenerator:

+ (id) textureWithGenerator:

(OOTextureGenerator *)

generator

Definition at line 924 of file OOTexture.m.

                           :(OOTextureGenerator *)generator
{
    return [self textureWithGenerator:generator enqueue: NO];
}

textureWithGenerator:enqueue:

+ (id) textureWithGenerator:		(OOTextureGenerator *)	generator
enqueue:		(BOOL)	enqueue

Definition at line 924 of file OOTexture.m.

                           :(OOTextureGenerator *)generator enqueue:(BOOL) enqueue
{
    if (generator == nil)  return nil;
    
#ifndef OOTEXTURE_NO_CACHE
    OOTexture *existing = [OOTexture existingTextureForKey:[generator cacheKey]];
    if (existing != nil && !enqueue)  return [[existing retain] autorelease];
#endif
    
    if (![generator enqueue])
    {
        OOLogERR(@"texture.generator.queue.failed", @"Failed to queue generator %@", generator);
        return nil;
    }
    OOLog(@"texture.generator.queue", @"Queued texture generator %@", generator);
    
    OOTexture *result = [[[OOConcreteTexture alloc] initWithLoader:generator
                                                               key:[generator cacheKey]
                                                           options:OOApplyTextureOptionDefaults([generator textureOptions])
                                                        anisotropy:[generator anisotropy]
                                                           lodBias:[generator lodBias]] autorelease];
    
    return result;
}

textureWithName:inFolder:

+ (id) textureWithName:		(NSString *)	name
inFolder:		(NSString*)	directory

Definition at line 924 of file OOTexture.m.

                     :(NSString *)name
             inFolder:(NSString*)directory
{
    return [self textureWithName:name
                        inFolder:directory
                         options:kOOTextureDefaultOptions
                      anisotropy:kOOTextureDefaultAnisotropy
                         lodBias:kOOTextureDefaultLODBias];
}

textureWithName:inFolder:options:anisotropy:lodBias:

+ (id) textureWithName:		(NSString *)	name
inFolder:		(NSString *)	directory
options:		(OOTextureFlags)	options
anisotropy:		(GLfloat)	anisotropy
lodBias:		(GLfloat)	lodBias

Definition at line 924 of file OOTexture.m.

                     :(NSString *)name
             inFolder:(NSString*)directory
              options:(OOTextureFlags)options
           anisotropy:(GLfloat)anisotropy
              lodBias:(GLfloat)lodBias
{
    NSString                *key = nil;
    OOTexture               *result = nil;
    NSString                *path = nil;
    BOOL                    noFNF;
    
    if (EXPECT_NOT(name == nil))  return nil;
    if (EXPECT_NOT(!sCheckedExtensions))  [self checkExtensions];
    
    if (!gOOTextureInfo.anisotropyAvailable || (options & kOOTextureMinFilterMask) != kOOTextureMinFilterMipMap)
    {
        anisotropy = 0.0f;
    }
    if (!gOOTextureInfo.textureLODBiasAvailable || (options & kOOTextureMinFilterMask) != kOOTextureMinFilterMipMap)
    {
        lodBias = 0.0f;
    }
    
    noFNF = (options & kOOTextureNoFNFMessage) != 0;
    options = OOApplyTextureOptionDefaults(options & ~kOOTextureNoFNFMessage);
    
    // Look for existing texture
    key = OOGenerateTextureCacheKey(directory, name, options, anisotropy, lodBias);
    result = [OOTexture existingTextureForKey:key];
    if (result == nil)
    {
        path = [ResourceManager pathForFileNamed:name inFolder:directory];
        if (path == nil)
        {
            if (!noFNF)  OOLogWARN(kOOLogFileNotFound, @"Could not find texture file \"%@\".", name);
            return nil;
        }
        
        // No existing texture, load texture.
        result = [[[OOConcreteTexture alloc] initWithPath:path key:key options:options anisotropy:anisotropy lodBias:lodBias] autorelease];
    }
    
    
    return result;
}

Referenced by HeadUpDisplay::InitTextEngine(void), and GuiDisplayGen::TextureForGUITexture.

Here is the caller graph for this function:

Member Data Documentation

_trace

- (BOOL) _trace

protected

Definition at line 120 of file OOTexture.h.

---

The documentation for this class was generated from the following files:

• src/Core/Materials/OOTexture.h
• src/Core/Materials/OOTexture.m