OOTexture.m File Reference

import "OOTexture.h"
import "OOTextureInternal.h"
import "OOConcreteTexture.h"
import "OONullTexture.h"
import "OOTextureLoader.h"
import "OOTextureGenerator.h"
import "OOCollectionExtractors.h"
import "Universe.h"
import "ResourceManager.h"
import "OOOpenGLExtensionManager.h"
import "OOMacroOpenGL.h"
import "OOCPUInfo.h"
import "OOCache.h"
import "OOPixMap.h"

Include dependency graph for OOTexture.m:

Go to the source code of this file.

Classes
category	OOTexture(OOPrivate)

Macros
#define	SET_TRACE_CONTEXT(str)   do { sGlobalTraceContext = (str); } while (0)
#define	CLEAR_TRACE_CONTEXT()   SET_TRACE_CONTEXT(nil)

Enumerations
enum	{ kRecentTexturesCount = 50 }

Functions
NSDictionary *	OOTextureSpecFromObject (id object, NSString *defaultName)
uint8_t	OOTextureComponentsForFormat (OOTextureDataFormat format)
BOOL	OOCubeMapsAvailable (void)
BOOL	OOInterpretTextureSpecifier (id specifier, NSString **outName, OOTextureFlags *outOptions, float *outAnisotropy, float *outLODBias, BOOL ignoreExtract)
NSDictionary *	OOMakeTextureSpecifier (NSString *name, OOTextureFlags options, float anisotropy, float lodBias, BOOL internal)
OOTextureFlags	OOApplyTextureOptionDefaults (OOTextureFlags options)
NSString *	OOGenerateTextureCacheKey (NSString *directory, NSString *name, OOTextureFlags options, float anisotropy, float lodBias)
NSString *	OOTextureCacheKeyForSpecifier (id specifier)

Variables
NSString *const	kOOTextureSpecifierNameKey = @"name"
NSString *const	kOOTextureSpecifierSwizzleKey = @"extract_channel"
NSString *const	kOOTextureSpecifierMinFilterKey = @"min_filter"
NSString *const	kOOTextureSpecifierMagFilterKey = @"mag_filter"
NSString *const	kOOTextureSpecifierNoShrinkKey = @"no_shrink"
NSString *const	kOOTextureSpecifierExtraShrinkKey = @"extra_shrink"
NSString *const	kOOTextureSpecifierRepeatSKey = @"repeat_s"
NSString *const	kOOTextureSpecifierRepeatTKey = @"repeat_t"
NSString *const	kOOTextureSpecifierCubeMapKey = @"cube_map"
NSString *const	kOOTextureSpecifierAnisotropyKey = @"anisotropy"
NSString *const	kOOTextureSpecifierLODBiasKey = @"texture_LOD_bias"
NSString *const	kOOTextureSpecifierModulateColorKey = @"color"
NSString *const	kOOTextureSpecifierIlluminationModeKey = @"illumination_mode"
NSString *const	kOOTextureSpecifierSelfColorKey = @"self_color"
NSString *const	kOOTextureSpecifierScaleFactorKey = @"scale_factor"
NSString *const	kOOTextureSpecifierBindingKey = @"binding"
static NSString *const	kOOTextureSpecifierFlagValueInternalKey = @"_oo_internal_flags"
static NSMutableDictionary *	sLiveTextureCache
static NSMutableSet *	sAllLiveTextures
static OOCache *	sRecentTextures
static BOOL	sCheckedExtensions
OOTextureInfo	gOOTextureInfo
static NSString *	sGlobalTraceContext = nil

Macro Definition Documentation

CLEAR_TRACE_CONTEXT

#define CLEAR_TRACE_CONTEXT

(

)

SET_TRACE_CONTEXT(nil)

Definition at line 129 of file OOTexture.m.

SET_TRACE_CONTEXT

#define SET_TRACE_CONTEXT

(

str

)

do { sGlobalTraceContext = (str); } while (0)

Definition at line 125 of file OOTexture.m.

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
kRecentTexturesCount

Definition at line 90 of file OOTexture.m.

{
    kRecentTexturesCount        = 50
};

Function Documentation

OOApplyTextureOptionDefaults()

OOTextureFlags OOApplyTextureOptionDefaults

(

OOTextureFlags

options

)

Definition at line 854 of file OOTexture.m.

{
    // Set default flags if needed
    if ((options & kOOTextureMinFilterMask) == kOOTextureMinFilterDefault)
    {
        if ([UNIVERSE reducedDetail])
        {
            options |= kOOTextureMinFilterLinear;
        }
        else
        {
            options |= kOOTextureMinFilterMipMap;
        }
    }
    
    if (!gOOTextureInfo.textureMaxLevelAvailable)
    {
        /*  In the unlikely case of an OpenGL system without GL_SGIS_texture_lod,
         disable mip-mapping completely. Strictly this is only needed for
         non-square textures, but extra logic for such a rare case isn't
         worth it.
         */
        if ((options & kOOTextureMinFilterMask) == kOOTextureMinFilterMipMap)
        {
            options ^= kOOTextureMinFilterMipMap ^ kOOTextureMinFilterLinear;
        }
    }
    
    if (options & kOOTextureAllowRectTexture)
    {
        // Apply rectangle texture restrictions (regardless of whether rectangle textures are available, for consistency)
        options &= kOOTextureFlagsAllowedForRectangleTexture;
        if ((options & kOOTextureMinFilterMask) == kOOTextureMinFilterMipMap)
        {
            options = (kOOTextureMinFilterMask & ~kOOTextureMinFilterMask) | kOOTextureMinFilterLinear;
        }
        
#if GL_EXT_texture_rectangle
        if (!gOOTextureInfo.rectangleTextureAvailable)
        {
            options &= ~kOOTextureAllowRectTexture;
        }
#else
        options &= ~kOOTextureAllowRectTexture;
#endif
    }
    
    options &= kOOTextureDefinedFlags;
    
    return options;
}

References gOOTextureInfo, kOOTextureAllowRectTexture, kOOTextureDefinedFlags, kOOTextureFlagsAllowedForRectangleTexture, kOOTextureMinFilterDefault, kOOTextureMinFilterLinear, kOOTextureMinFilterMask, kOOTextureMinFilterMipMap, OOTextureInfo::rectangleTextureAvailable, OOTextureInfo::textureMaxLevelAvailable, and UNIVERSE.

Referenced by OOPixMapTextureLoader::dealloc, OODefaultShaderSynthesizer::KeyFromTextureParameters, and OOGenerateTextureCacheKey().

Here is the caller graph for this function:

OOCubeMapsAvailable()

BOOL OOCubeMapsAvailable

(

void

)

Definition at line 687 of file OOTexture.m.

{
    return gOOTextureInfo.cubeMapAvailable;
}

References OOTextureInfo::cubeMapAvailable, and gOOTextureInfo.

OOGenerateTextureCacheKey()

NSString * OOGenerateTextureCacheKey	(	NSString *	directory,
		NSString *	name,
		OOTextureFlags	options,
		float	anisotropy,
		float	lodBias
	)

Definition at line 907 of file OOTexture.m.

{
    if (!gOOTextureInfo.anisotropyAvailable || (options & kOOTextureMinFilterMask) != kOOTextureMinFilterMipMap)
    {
        anisotropy = 0.0f;
    }
    if (!gOOTextureInfo.textureLODBiasAvailable || (options & kOOTextureMinFilterMask) != kOOTextureMinFilterMipMap)
    {
        lodBias = 0.0f;
    }
    options = OOApplyTextureOptionDefaults(options & ~kOOTextureNoFNFMessage);
    
    return [NSString stringWithFormat:@"%@%@%@:0x%.4X/%g/%g", directory ? directory : (NSString *)@"", directory ? @"/" : @"", name, options, anisotropy, lodBias];
}

References OOTextureInfo::anisotropyAvailable, gOOTextureInfo, kOOTextureMinFilterMask, kOOTextureMinFilterMipMap, kOOTextureNoFNFMessage, OOApplyTextureOptionDefaults(), and OOTextureInfo::textureLODBiasAvailable.

Referenced by OOTexture(OOPrivate)::addToCaches.

Here is the call graph for this function:

Here is the caller graph for this function:

OOInterpretTextureSpecifier()

BOOL OOInterpretTextureSpecifier	(	id	specifier,
		NSString **	outName,
		OOTextureFlags *	outOptions,
		float *	outAnisotropy,
		float *	outLODBias,
		BOOL	ignoreExtract
	)

Definition at line 693 of file OOTexture.m.

{
    NSString            *name = nil;
    OOTextureFlags      options = kOOTextureDefaultOptions;
    float               anisotropy = kOOTextureDefaultAnisotropy;
    float               lodBias = kOOTextureDefaultLODBias;
    
    if ([specifier isKindOfClass:[NSString class]])
    {
        name = specifier;
    }
    else if ([specifier isKindOfClass:[NSDictionary class]])
    {
        name = [specifier oo_stringForKey:kOOTextureSpecifierNameKey];
        if (name == nil)
        {
            OOLog(@"texture.load.noName", @"Invalid texture configuration dictionary (must specify name):\n%@", specifier);
            return NO;
        }
        
        int quickFlags = [specifier oo_intForKey:kOOTextureSpecifierFlagValueInternalKey defaultValue:-1];
        if (quickFlags != -1)
        {
            options = quickFlags;
        }
        else
        {
            NSString *filterString = [specifier oo_stringForKey:kOOTextureSpecifierMinFilterKey defaultValue:@"default"];
            if ([filterString isEqualToString:@"nearest"])  options |= kOOTextureMinFilterNearest;
            else if ([filterString isEqualToString:@"linear"])  options |= kOOTextureMinFilterLinear;
            else if ([filterString isEqualToString:@"mipmap"])  options |= kOOTextureMinFilterMipMap;
            else  options |= kOOTextureMinFilterDefault;    // Covers "default"
            
            filterString = [specifier oo_stringForKey:kOOTextureSpecifierMagFilterKey defaultValue:@"default"];
            if ([filterString isEqualToString:@"nearest"])  options |= kOOTextureMagFilterNearest;
            else  options |= kOOTextureMagFilterLinear; // Covers "default" and "linear"
            
            if ([specifier oo_boolForKey:kOOTextureSpecifierNoShrinkKey defaultValue:NO])  options |= kOOTextureNoShrink;
            if ([specifier oo_boolForKey:kOOTextureSpecifierExtraShrinkKey defaultValue:NO])  options |= kOOTextureExtraShrink;
            if ([specifier oo_boolForKey:kOOTextureSpecifierRepeatSKey defaultValue:NO])  options |= kOOTextureRepeatS;
            if ([specifier oo_boolForKey:kOOTextureSpecifierRepeatTKey defaultValue:NO])  options |= kOOTextureRepeatT;
            if ([specifier oo_boolForKey:kOOTextureSpecifierCubeMapKey defaultValue:NO])  options |= kOOTextureAllowCubeMap;
            
            if (!ignoreExtract)
            {
                NSString *extractChannel = [specifier oo_stringForKey:@"extract_channel"];
                if (extractChannel != nil)
                {
                    if ([extractChannel isEqualToString:@"r"])  options |= kOOTextureExtractChannelR;
                    else if ([extractChannel isEqualToString:@"g"])  options |= kOOTextureExtractChannelG;
                    else if ([extractChannel isEqualToString:@"b"])  options |= kOOTextureExtractChannelB;
                    else if ([extractChannel isEqualToString:@"a"])  options |= kOOTextureExtractChannelA;
                    else
                    {
                        OOLogWARN(@"texture.load.extractChannel.invalid", @"Unknown value \"%@\" for extract_channel in specifier \"%@\" (should be \"r\", \"g\", \"b\" or \"a\").", extractChannel,specifier);
                    }
                }
            }
        }
        anisotropy = [specifier oo_floatForKey:@"anisotropy" defaultValue:kOOTextureDefaultAnisotropy];
        lodBias = [specifier oo_floatForKey:@"texture_LOD_bias" defaultValue:kOOTextureDefaultLODBias];
    }
    else
    {
        // Bad type
        if (specifier != nil)  OOLog(kOOLogParameterError, @"%s: expected string or dictionary, got %@.", __PRETTY_FUNCTION__, [specifier class]);
        return NO;
    }
    
    if ([name length] == 0)  return NO;
    
    if (outName != NULL)  *outName = name;
    if (outOptions != NULL)  *outOptions = options;
    if (outAnisotropy != NULL)  *outAnisotropy = anisotropy;
    if (outLODBias != NULL)  *outLODBias = lodBias;
    
    return YES;
}

References kOOLogParameterError, kOOTextureAllowCubeMap, kOOTextureDefaultAnisotropy, kOOTextureDefaultLODBias, kOOTextureDefaultOptions, kOOTextureExtractChannelA, kOOTextureExtractChannelB, kOOTextureExtractChannelG, kOOTextureExtractChannelR, kOOTextureExtraShrink, kOOTextureMagFilterLinear, kOOTextureMagFilterNearest, kOOTextureMinFilterDefault, kOOTextureMinFilterLinear, kOOTextureMinFilterMipMap, kOOTextureMinFilterNearest, kOOTextureNoShrink, kOOTextureRepeatS, kOOTextureRepeatT, kOOTextureSpecifierCubeMapKey, kOOTextureSpecifierExtraShrinkKey, kOOTextureSpecifierNoShrinkKey, kOOTextureSpecifierRepeatSKey, kOOTextureSpecifierRepeatTKey, nil, OOLog, and OOLogWARN.

Referenced by OOTexture(OOPrivate)::addToCaches, and OODefaultShaderSynthesizer::assignIDForTexture:.

Here is the caller graph for this function:

OOMakeTextureSpecifier()

NSDictionary * OOMakeTextureSpecifier	(	NSString *	name,
		OOTextureFlags	options,
		float	anisotropy,
		float	lodBias,
		BOOL	internal
	)

Definition at line 773 of file OOTexture.m.

{
    NSMutableDictionary *result = [NSMutableDictionary dictionary];
    
    [result setObject:name forKey:kOOTextureSpecifierNameKey];
    
    if (anisotropy != kOOTextureDefaultAnisotropy)  [result oo_setFloat:anisotropy forKey:kOOTextureSpecifierAnisotropyKey];
    if (lodBias != kOOTextureDefaultLODBias)  [result oo_setFloat:lodBias forKey:kOOTextureSpecifierLODBiasKey];
    
    if (internal)
    {
        [result oo_setUnsignedInteger:options forKey:kOOTextureSpecifierFlagValueInternalKey];
    }
    else
    {
        NSString *value = nil;
        switch (options & kOOTextureMinFilterMask)
        {
            case kOOTextureMinFilterDefault:
                break;
                
            case kOOTextureMinFilterNearest:
                value = @"nearest";
                break;
                
            case kOOTextureMinFilterLinear:
                value = @"linear";
                break;
                
            case kOOTextureMinFilterMipMap:
                value = @"mipmap";
                break;
        }
        if (value != nil)  [result setObject:value forKey:kOOTextureSpecifierNoShrinkKey];
        
        value = nil;
        switch (options & kOOTextureMagFilterMask)
        {
            case kOOTextureMagFilterNearest:
                value = @"nearest";
                break;
                
            case kOOTextureMagFilterLinear:
                break;
        }
        if (value != nil)  [result setObject:value forKey:kOOTextureSpecifierMagFilterKey];
        
        value = nil;
        switch (options & kOOTextureExtractChannelMask)
        {
            case kOOTextureExtractChannelNone:
                break;
                
            case kOOTextureExtractChannelR:
                value = @"r";
                break;
                
            case kOOTextureExtractChannelG:
                value = @"g";
                break;
                
            case kOOTextureExtractChannelB:
                value = @"b";
                break;
                
            case kOOTextureExtractChannelA:
                value = @"a";
                break;
        }
        if (value != nil)  [result setObject:value forKey:kOOTextureSpecifierSwizzleKey];
        
        if (options & kOOTextureNoShrink)  [result oo_setBool:YES forKey:kOOTextureSpecifierNoShrinkKey];
        if (options & kOOTextureRepeatS)  [result oo_setBool:YES forKey:kOOTextureSpecifierRepeatSKey];
        if (options & kOOTextureRepeatT)  [result oo_setBool:YES forKey:kOOTextureSpecifierRepeatTKey];
        if (options & kOOTextureAllowCubeMap)  [result oo_setBool:YES forKey:kOOTextureSpecifierCubeMapKey];
    }
    
    return result;
}

References kOOTextureAllowCubeMap, kOOTextureDefaultAnisotropy, kOOTextureDefaultLODBias, kOOTextureExtractChannelA, kOOTextureExtractChannelB, kOOTextureExtractChannelG, kOOTextureExtractChannelMask, kOOTextureExtractChannelNone, kOOTextureExtractChannelR, kOOTextureMagFilterLinear, kOOTextureMagFilterMask, kOOTextureMagFilterNearest, kOOTextureMinFilterDefault, kOOTextureMinFilterLinear, kOOTextureMinFilterMask, kOOTextureMinFilterMipMap, kOOTextureMinFilterNearest, kOOTextureNoShrink, kOOTextureRepeatS, kOOTextureRepeatT, and nil.

OOTextureCacheKeyForSpecifier()

NSString * OOTextureCacheKeyForSpecifier

(

id

specifier

)

Definition at line 923 of file OOTexture.m.

{
    NSString *name;
    OOTextureFlags options;
    float anisotropy;
    float lodBias;
    
    OOInterpretTextureSpecifier(specifier, &name, &options, &anisotropy, &lodBias, NO);
    return OOGenerateTextureCacheKey(@"Textures", name, options, anisotropy, lodBias);
}

OOTextureComponentsForFormat()

uint8_t OOTextureComponentsForFormat

(

OOTextureDataFormat

format

)

Definition at line 666 of file OOTexture.m.

{
    switch (format)
    {
        case kOOTextureDataRGBA:
            return 4;
            
        case kOOTextureDataGrayscale:
            return 1;
            
        case kOOTextureDataGrayscaleAlpha:
            return 2;
            
        case kOOTextureDataInvalid:
            break;
    }
    
    return 0;
}

References kOOTextureDataGrayscale, kOOTextureDataGrayscaleAlpha, kOOTextureDataInvalid, and kOOTextureDataRGBA.

OOTextureSpecFromObject()

NSDictionary * OOTextureSpecFromObject	(	id	object,
		NSString *	defaultName
	)

Definition at line 646 of file OOTexture.m.

{
    if (object == nil)  object = defaultName;
    if ([object isKindOfClass:[NSString class]])
    {
        if ([object isEqualToString:@""])  return nil;
        return [NSDictionary dictionaryWithObject:object forKey:@"name"];
    }
    if (![object isKindOfClass:[NSDictionary class]])  return nil;
    
    // If we're here, it's a dictionary.
    if (defaultName == nil || [object oo_stringForKey:@"name"] != nil)  return object;
    
    // If we get here, there's no "name" key and there is a default, so we fill it in:
    NSMutableDictionary *mutableResult = [NSMutableDictionary dictionaryWithDictionary:object];
    [mutableResult setObject:[[defaultName copy] autorelease] forKey:@"name"];
    return mutableResult;
}

References nil.

Variable Documentation

gOOTextureInfo

OOTextureInfo gOOTextureInfo

Definition at line 101 of file OOTexture.m.

Referenced by OOApplyTextureOptionDefaults(), OOCubeMapsAvailable(), and OOGenerateTextureCacheKey().

kOOTextureSpecifierAnisotropyKey

NSString* const kOOTextureSpecifierAnisotropyKey = @"anisotropy"

Definition at line 54 of file OOTexture.m.

kOOTextureSpecifierBindingKey

NSString* const kOOTextureSpecifierBindingKey = @"binding"

Definition at line 61 of file OOTexture.m.

kOOTextureSpecifierCubeMapKey

NSString* const kOOTextureSpecifierCubeMapKey = @"cube_map"

Definition at line 53 of file OOTexture.m.

Referenced by OOInterpretTextureSpecifier().

kOOTextureSpecifierExtraShrinkKey

NSString* const kOOTextureSpecifierExtraShrinkKey = @"extra_shrink"

Definition at line 50 of file OOTexture.m.

Referenced by OOInterpretTextureSpecifier().

kOOTextureSpecifierFlagValueInternalKey

NSString* const kOOTextureSpecifierFlagValueInternalKey = @"_oo_internal_flags"

static

Definition at line 64 of file OOTexture.m.

kOOTextureSpecifierIlluminationModeKey

NSString* const kOOTextureSpecifierIlluminationModeKey = @"illumination_mode"

Definition at line 58 of file OOTexture.m.

kOOTextureSpecifierLODBiasKey

NSString* const kOOTextureSpecifierLODBiasKey = @"texture_LOD_bias"

Definition at line 55 of file OOTexture.m.

kOOTextureSpecifierMagFilterKey

NSString* const kOOTextureSpecifierMagFilterKey = @"mag_filter"

Definition at line 48 of file OOTexture.m.

kOOTextureSpecifierMinFilterKey

NSString* const kOOTextureSpecifierMinFilterKey = @"min_filter"

Definition at line 47 of file OOTexture.m.

kOOTextureSpecifierModulateColorKey

NSString* const kOOTextureSpecifierModulateColorKey = @"color"

Definition at line 57 of file OOTexture.m.

kOOTextureSpecifierNameKey

NSString* const kOOTextureSpecifierNameKey = @"name"

Definition at line 45 of file OOTexture.m.

kOOTextureSpecifierNoShrinkKey

NSString* const kOOTextureSpecifierNoShrinkKey = @"no_shrink"

Definition at line 49 of file OOTexture.m.

Referenced by OOInterpretTextureSpecifier().

kOOTextureSpecifierRepeatSKey

NSString* const kOOTextureSpecifierRepeatSKey = @"repeat_s"

Definition at line 51 of file OOTexture.m.

Referenced by OOInterpretTextureSpecifier().

kOOTextureSpecifierRepeatTKey

NSString* const kOOTextureSpecifierRepeatTKey = @"repeat_t"

Definition at line 52 of file OOTexture.m.

Referenced by OOInterpretTextureSpecifier().

kOOTextureSpecifierScaleFactorKey

NSString* const kOOTextureSpecifierScaleFactorKey = @"scale_factor"

Definition at line 60 of file OOTexture.m.

kOOTextureSpecifierSelfColorKey

NSString* const kOOTextureSpecifierSelfColorKey = @"self_color"

Definition at line 59 of file OOTexture.m.

kOOTextureSpecifierSwizzleKey

NSString* const kOOTextureSpecifierSwizzleKey = @"extract_channel"

Definition at line 46 of file OOTexture.m.

sAllLiveTextures

NSMutableSet* sAllLiveTextures

static

Definition at line 96 of file OOTexture.m.

sCheckedExtensions

BOOL sCheckedExtensions

static

Definition at line 100 of file OOTexture.m.

sGlobalTraceContext

NSString* sGlobalTraceContext = nil

static

Definition at line 123 of file OOTexture.m.

sLiveTextureCache

NSMutableDictionary* sLiveTextureCache

static

Definition at line 95 of file OOTexture.m.

sRecentTextures

OOCache* sRecentTextures

static

Definition at line 97 of file OOTexture.m.