#include <OOOpenGLExtensionManager.h>

Inheritance diagram for OOOpenGLExtensionManager:

Collaboration diagram for OOOpenGLExtensionManager:

Instance Methods
(void)	- reset

(BOOL)	- haveExtension:

(BOOL)	- shadersSupported

(BOOL)	- shadersForceDisabled

(OOGraphicsDetail)	- defaultDetailLevel

(OOGraphicsDetail)	- maximumDetailLevel

(GLint)	- textureImageUnitCount

(BOOL)	- vboSupported

(BOOL)	- fboSupported

(BOOL)	- textureCombinersSupported

(GLint)	- textureUnitCount

(NSUInteger)	- majorVersionNumber

(NSUInteger)	- minorVersionNumber

(NSUInteger)	- releaseVersionNumber

(void)	- getVersionMajor:minor:release:

(BOOL)	- versionIsAtLeastMajor:minor:

(NSString *)	- vendorString

(NSString *)	- rendererString

(BOOL)	- usePointSmoothing

(BOOL)	- useLineSmoothing

(BOOL)	- useDustShader

(id)	- init `[implementation]`

(void)	- dealloc `[implementation]`

(void)	- checkShadersSupported `[implementation]`

(NSDictionary *)	- lookUpPerGPUSettingsWithVersionString:extensionsString: `[implementation]`

(NSComparisonResult)	- CompareGPUSettingsByPriority `[implementation]`

(id)	- copyWithZone: `[implementation]`

(id)	- retain `[implementation]`

(NSUInteger)	- retainCount `[implementation]`

(id)	- autorelease `[implementation]`

Class Methods
(OOOpenGLExtensionManager *)	+ sharedManager

(static BOOL)	+ CheckRegExps `[implementation]`

(id)	+ allocWithZone: `[implementation]`

Private Attributes
NSSet *	extensions

NSString *	vendor

NSString *	renderer

unsigned	major

unsigned	minor

unsigned	release

BOOL	usePointSmoothing

BOOL	useLineSmoothing

BOOL	useDustShader

BOOL	shadersAvailable

BOOL	shadersForceDisabled

OOShaderSetting	defaultShaderSetting

OOShaderSetting	maximumShaderSetting

GLint	textureImageUnitCount

Detailed Description

Definition at line 115 of file OOOpenGLExtensionManager.h.

Method Documentation

◆ allocWithZone:

+ (id) allocWithZone: (NSZone *) inZone

implementation

Provided by category OOOpenGLExtensionManager(Singleton).

Definition at line 769 of file OOOpenGLExtensionManager.m.

                   :(NSZone *)inZone
{
    if (sSingleton == nil)
    {
        sSingleton = [super allocWithZone:inZone];
        return sSingleton;
    }
    return nil;
}

◆ autorelease

- (id) autorelease

implementation

Provided by category OOOpenGLExtensionManager(Singleton).

Definition at line 769 of file OOOpenGLExtensionManager.m.

{
    return self;
}

◆ CheckRegExps

+ (static BOOL) CheckRegExps	(NSString *)	string
	(id)	regexps

implementation

Provided by category OOOpenGLExtensionManager(OOPrivate).

Definition at line 739 of file OOOpenGLExtensionManager.m.

{
    if (regexps == nil)  return YES;    // No restriction == match.
    if ([regexps isKindOfClass:[NSString class]])
    {
        return [string oo_matchesRegularExpression:regexps];
    }
    if ([regexps isKindOfClass:[NSArray class]])
    {
        NSEnumerator *regexpEnum = nil;
        NSString *regexp = nil;
        
        for (regexpEnum = [regexps objectEnumerator]; (regexp = [regexpEnum nextObject]); )
        {
            if (EXPECT_NOT(![regexp isKindOfClass:[NSString class]]))
            {
                // Invalid type -- match fails.
                return NO;
            }
            
            if (![string oo_matchesRegularExpression:regexp])  return NO;
        }
        return YES;
    }
    
    // Invalid type -- match fails.
    return NO;
}

◆ CompareGPUSettingsByPriority

- (NSComparisonResult) CompareGPUSettingsByPriority	(id)	a
	(id)	b
	(void *)	context

implementation

Provided by category OOOpenGLExtensionManager(OOPrivate).

Definition at line 769 of file OOOpenGLExtensionManager.m.

{
    NSString        *keyA = a;
    NSString        *keyB = b;
    NSDictionary    *configurations = context;
    NSDictionary    *dictA = [configurations oo_dictionaryForKey:keyA];
    NSDictionary    *dictB = [configurations oo_dictionaryForKey:keyB];
    double          precedenceA = [dictA oo_doubleForKey:@"precedence" defaultValue:1];
    double          precedenceB = [dictB oo_doubleForKey:@"precedence" defaultValue:1];
    
    if (precedenceA > precedenceB)  return NSOrderedAscending;
    if (precedenceA < precedenceB)  return NSOrderedDescending;
    
    return [keyA caseInsensitiveCompare:keyB];
}

◆ copyWithZone:

- (id) copyWithZone: (NSZone *) inZone

implementation

Provided by category OOOpenGLExtensionManager(Singleton).

Definition at line 769 of file OOOpenGLExtensionManager.m.

                  :(NSZone *)inZone
{
    return self;
}

◆ dealloc

- (void) dealloc

implementation

Definition at line 528 of file OOOpenGLExtensionManager.m.

{
    if (sSingleton == self)  sSingleton = nil;
    
#if OOOPENGLEXTMGR_LOCK_SET_ACCESS
    [lock release];
#endif
    DESTROY(extensions);
    DESTROY(vendor);
    DESTROY(renderer);
    
    [super dealloc];
}

◆ defaultDetailLevel

- (OOGraphicsDetail) defaultDetailLevel

Definition at line 528 of file OOOpenGLExtensionManager.m.

{
#if OO_SHADERS
    if (defaultShaderSetting < SHADERS_FULL)
    {
        return DETAIL_LEVEL_MINIMUM;
    }
    else
    {
        return DETAIL_LEVEL_MAXIMUM;
    }
#else
    return SHADERS_NOT_SUPPORTED;
#endif
}

◆ fboSupported

- (BOOL) fboSupported

Definition at line 528 of file OOOpenGLExtensionManager.m.

{
#if OO_USE_FBO
    return fboSupported;
#else
    return NO;
#endif
}

◆ getVersionMajor:minor:release:

- (void) getVersionMajor:	(unsigned *)	outMajor
minor:	(unsigned *)	outMinor
release:	(unsigned *)	outRelease

Definition at line 528 of file OOOpenGLExtensionManager.m.

                       :(unsigned *)outMajor minor:(unsigned *)outMinor release:(unsigned *)outRelease
{
    if (outMajor != NULL)  *outMajor = major;
    if (outMinor != NULL)  *outMinor = minor;
    if (outRelease != NULL)  *outRelease = release;
}

◆ haveExtension:

- (BOOL) haveExtension: (NSString *) extension

Definition at line 528 of file OOOpenGLExtensionManager.m.

                     :(NSString *)extension
{
// NSSet is documented as thread-safe under OS X, but I'm not sure about GNUstep. -- Ahruman
#if OOOPENGLEXTMGR_LOCK_SET_ACCESS
    [lock lock];
#endif
    
    BOOL result = [extensions containsObject:extension];
    
#if OOOPENGLEXTMGR_LOCK_SET_ACCESS
    [lock unlock];
#endif
    
    return result;
}

◆ init

- (id) init

implementation

Definition at line 528 of file OOOpenGLExtensionManager.m.

{
    self = [super init];
    if (self != nil)
    {
#if OOOPENGLEXTMGR_LOCK_SET_ACCESS
        lock = [[NSLock alloc] init];
        [lock setName:@"OOOpenGLExtensionManager extension set lock"];
#endif
        
        [self reset];
    }
    
    return self;
}

◆ lookUpPerGPUSettingsWithVersionString:extensionsString:

- (NSDictionary *) lookUpPerGPUSettingsWithVersionString:	(NSString *)	version
extensionsString:	(NSString *)	extensionsStr

implementation

Provided by category OOOpenGLExtensionManager(OOPrivate).

Definition at line 769 of file OOOpenGLExtensionManager.m.

                                                        :(NSString *)versionStr extensionsString:(NSString *)extensionsStr
{
    NSDictionary *configurations = [ResourceManager dictionaryFromFilesNamed:@"gpu-settings.plist"
                                                                    inFolder:@"Config"
                                                                    andMerge:YES];
    
    NSArray *keys = [[configurations allKeys] sortedArrayUsingFunction:CompareGPUSettingsByPriority context:configurations];
    
    NSString *key = nil;
    NSDictionary *config = nil;
    
    foreach (key, keys)
    {
        config = [configurations oo_dictionaryForKey:key];
        if (EXPECT_NOT(config == nil))  continue;
        
        NSDictionary *match = [config oo_dictionaryForKey:@"match"];
        NSString *expr = nil;
        
        expr = [match objectForKey:@"vendor"];
        if (!CheckRegExps(vendor, expr))  continue;
        
        expr = [match oo_stringForKey:@"renderer"];
        if (!CheckRegExps(renderer, expr))  continue;
        
        expr = [match oo_stringForKey:@"version"];
        if (!CheckRegExps(versionStr, expr))  continue;
        
        expr = [match oo_stringForKey:@"extensions"];
        if (!CheckRegExps(extensionsStr, expr))  continue;
        
        OOLog(@"rendering.opengl.gpuSpecific", @"Matched GPU configuration \"%@\".", key);
        return config;
    }
    
    return [NSDictionary dictionary];
}

◆ majorVersionNumber

- (NSUInteger) majorVersionNumber

Definition at line 528 of file OOOpenGLExtensionManager.m.

{
    return major;
}

◆ maximumDetailLevel

- (OOGraphicsDetail) maximumDetailLevel

Definition at line 528 of file OOOpenGLExtensionManager.m.

{
#if OO_SHADERS
    if (maximumShaderSetting < SHADERS_FULL)
    {
        return DETAIL_LEVEL_MINIMUM;
    }
    else
    {
        return DETAIL_LEVEL_MAXIMUM;
    }
#else
    return DETAIL_LEVEL_MINIMUM;
#endif
}

Referenced by ConsoleGetProperty().

Here is the caller graph for this function:

◆ minorVersionNumber

- (NSUInteger) minorVersionNumber

Definition at line 528 of file OOOpenGLExtensionManager.m.

{
    return minor;
}

◆ releaseVersionNumber

- (NSUInteger) releaseVersionNumber

Definition at line 528 of file OOOpenGLExtensionManager.m.

{
    return release;
}

◆ rendererString

- (NSString *) rendererString

Definition at line 528 of file OOOpenGLExtensionManager.m.

{
    return renderer;
}

◆ reset

- (void) reset

Definition at line 528 of file OOOpenGLExtensionManager.m.

{
    const GLubyte       *versionString = NULL, *curr = NULL;
    
    DESTROY(extensions);
    DESTROY(vendor);
    DESTROY(renderer);
    
    NSString *extensionsStr = [NSString stringWithUTF8String:(char *)glGetString(GL_EXTENSIONS)];
    extensions = [[NSSet alloc] initWithArray:ArrayOfExtensions(extensionsStr)];
    
    vendor = [[NSString alloc] initWithUTF8String:(const char *)glGetString(GL_VENDOR)];
    renderer = [[NSString alloc] initWithUTF8String:(const char *)glGetString(GL_RENDERER)];
    
    versionString = glGetString(GL_VERSION);
    if (versionString != NULL)
    {
        /*  String is supposed to be "major.minorFOO" or
         "major.minor.releaseFOO" where FOO is an empty string or
         a string beginning with space.
         */
        curr = versionString;
        major = IntegerFromString(&curr);
        if (*curr == '.')
        {
            curr++;
            minor = IntegerFromString(&curr);
        }
        if (*curr == '.')
        {
            curr++;
            release = IntegerFromString(&curr);
        }
    }
    
    /*  For aesthetic reasons, cause the ResourceManager to initialize its
     search paths here. If we don't, the search path dump ends up in
     the middle of the OpenGL stuff.
     */
    [ResourceManager paths];
    
    OOLog(@"rendering.opengl.version", @"OpenGL renderer version: %u.%u.%u (\"%s\"). Vendor: \"%@\". Renderer: \"%@\".", major, minor, release, versionString, vendor, renderer);
    OOLog(@"rendering.opengl.extensions", @"OpenGL extensions (%llu):\n%@", [extensions count], [[extensions allObjects] componentsJoinedByString:@", "]);
    
    if (![self versionIsAtLeastMajor:kMinMajorVersion minor:kMinMinorVersion])
    {
        OOLog(@"rendering.opengl.version.insufficient", @"***** Oolite requires OpenGL version %u.%u or later.", kMinMajorVersion, kMinMinorVersion);
        [NSException raise:@"OoliteOpenGLTooOldException"
                    format:@"Oolite requires at least OpenGL %u.%u. You have %u.%u (\"%s\").", kMinMajorVersion, kMinMinorVersion, major, minor, versionString];
    }
    
    NSString *versionStr = [[[NSString alloc] initWithUTF8String:(const char *)versionString] autorelease];
    NSDictionary *gpuConfig = [self lookUpPerGPUSettingsWithVersionString:versionStr extensionsString:extensionsStr];
    
#if OO_SHADERS
    [self checkShadersSupported];
    
    if (shadersAvailable)
    {
        defaultShaderSetting = OOShaderSettingFromString([gpuConfig oo_stringForKey:@"default_shader_level"
                                                                   defaultValue:@"SHADERS_FULL"]);
        maximumShaderSetting = OOShaderSettingFromString([gpuConfig oo_stringForKey:@"maximum_shader_level"
                                                                   defaultValue:@"SHADERS_FULL"]);
        if (maximumShaderSetting <= SHADERS_OFF)
        {
            shadersAvailable = NO;
            maximumShaderSetting = SHADERS_NOT_SUPPORTED;
            OOLog(kOOLogOpenGLShaderSupport, @"Shaders will not be used (disallowed for GPU type \"%@\").", [gpuConfig oo_stringForKey:@"name" defaultValue:renderer]);
        }
        if (maximumShaderSetting < defaultShaderSetting)
        {
            defaultShaderSetting = maximumShaderSetting;
        }
        
        if (shadersAvailable)
        {
            OOLog(kOOLogOpenGLShaderSupport, @"%@", @"Shaders are supported.");
        }
    }
    else
    {
        defaultShaderSetting = SHADERS_NOT_SUPPORTED;
        maximumShaderSetting = SHADERS_NOT_SUPPORTED;
    }
    
    GLint texImageUnitOverride = [gpuConfig oo_intForKey:@"texture_image_units" defaultValue:textureImageUnitCount];
    if (texImageUnitOverride < textureImageUnitCount)  textureImageUnitCount = MAX(texImageUnitOverride, 0);
#endif
    
#if OO_USE_VBO
    [self checkVBOSupported];
#endif
#if OO_USE_FBO
    [self checkFBOSupported];
#endif
#if OO_MULTITEXTURE
    [self checkTextureCombinersSupported];
    GLint texUnitOverride = [gpuConfig oo_intForKey:@"texture_units" defaultValue:textureUnitCount];
    if (texUnitOverride < textureUnitCount)  textureUnitCount = MAX(texUnitOverride, 0);
#endif
    
    usePointSmoothing = [gpuConfig oo_boolForKey:@"smooth_points" defaultValue:YES];
    useLineSmoothing = [gpuConfig oo_boolForKey:@"smooth_lines" defaultValue:YES];
    useDustShader = [gpuConfig oo_boolForKey:@"use_dust_shader" defaultValue:YES];
}

◆ retain

- (id) retain

implementation

Provided by category OOOpenGLExtensionManager(Singleton).

Definition at line 769 of file OOOpenGLExtensionManager.m.

{
    return self;
}

◆ retainCount

- (NSUInteger) retainCount

implementation

Provided by category OOOpenGLExtensionManager(Singleton).

Definition at line 769 of file OOOpenGLExtensionManager.m.

{
    return UINT_MAX;
}

◆ shadersForceDisabled

- (BOOL) shadersForceDisabled

◆ shadersSupported

- (BOOL) shadersSupported

Definition at line 528 of file OOOpenGLExtensionManager.m.

{
#if OO_SHADERS
    return shadersAvailable;
#else
    return NO;
#endif
}

Referenced by OOShadersSupported().

Here is the caller graph for this function:

◆ sharedManager

+ (OOOpenGLExtensionManager *) sharedManager

Definition at line 528 of file OOOpenGLExtensionManager.m.

{
    // NOTE: assumes single-threaded first access. See header.
    if (sSingleton == nil)  sSingleton = [[self alloc] init];
    return sSingleton;
}

Referenced by ConsoleGetProperty(), and OOShadersSupported().

Here is the caller graph for this function:

◆ textureCombinersSupported

- (BOOL) textureCombinersSupported

Definition at line 528 of file OOOpenGLExtensionManager.m.

{
#if OO_MULTITEXTURE
    return textureCombinersSupported;
#else
    return NO;
#endif
}

◆ textureImageUnitCount

- (GLint) textureImageUnitCount

◆ textureUnitCount

- (GLint) textureUnitCount

Definition at line 528 of file OOOpenGLExtensionManager.m.

{
#if OO_MULTITEXTURE
    return textureUnitCount;
#else
    return 0;
#endif
}

◆ useDustShader

- (BOOL) useDustShader

◆ useLineSmoothing

- (BOOL) useLineSmoothing

◆ usePointSmoothing

- (BOOL) usePointSmoothing

◆ vboSupported

- (BOOL) vboSupported

Definition at line 528 of file OOOpenGLExtensionManager.m.

{
#if OO_USE_VBO
    return vboSupported;
#else
    return NO;
#endif
}

◆ vendorString

- (NSString *) vendorString

Definition at line 528 of file OOOpenGLExtensionManager.m.

{
    return vendor;
}

◆ versionIsAtLeastMajor:minor:

- (BOOL) versionIsAtLeastMajor:	(unsigned)	maj
minor:	(unsigned)	min

Definition at line 528 of file OOOpenGLExtensionManager.m.

                              :(unsigned)maj minor:(unsigned)min
{
    return major > maj || (major == maj && minor >= min);
}

Member Data Documentation

◆ defaultShaderSetting

- (OOShaderSetting) defaultShaderSetting

private

Definition at line 135 of file OOOpenGLExtensionManager.h.

◆ extensions

- (NSSet*) extensions

private

Definition at line 121 of file OOOpenGLExtensionManager.h.

◆ major

- (unsigned) major

private

Definition at line 126 of file OOOpenGLExtensionManager.h.

◆ maximumShaderSetting

- (OOShaderSetting) maximumShaderSetting

private

Definition at line 136 of file OOOpenGLExtensionManager.h.

◆ minor

- (unsigned) minor

private

Definition at line 126 of file OOOpenGLExtensionManager.h.

◆ release

- (unsigned) release

private

Provided by category OOOpenGLExtensionManager(Singleton).

Definition at line 126 of file OOOpenGLExtensionManager.h.

◆ renderer

- (NSString*) renderer

private

Definition at line 124 of file OOOpenGLExtensionManager.h.

◆ shadersAvailable

- (BOOL) shadersAvailable

private

Definition at line 133 of file OOOpenGLExtensionManager.h.

◆ shadersForceDisabled

- (BOOL) shadersForceDisabled

private

Definition at line 134 of file OOOpenGLExtensionManager.h.

◆ textureImageUnitCount

- (GLint) textureImageUnitCount

private

Definition at line 137 of file OOOpenGLExtensionManager.h.

◆ useDustShader

- (BOOL) useDustShader

private

Definition at line 130 of file OOOpenGLExtensionManager.h.

◆ useLineSmoothing

- (BOOL) useLineSmoothing

private

Definition at line 129 of file OOOpenGLExtensionManager.h.

◆ usePointSmoothing

- (BOOL) usePointSmoothing

private

Definition at line 128 of file OOOpenGLExtensionManager.h.

◆ vendor

- (NSString*) vendor

private

Definition at line 123 of file OOOpenGLExtensionManager.h.

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

src/Core/OOOpenGLExtensionManager.h
src/Core/OOOpenGLExtensionManager.m

Instance Methods

Class Methods

Private Attributes

Detailed Description

Method Documentation

◆ allocWithZone:

◆ autorelease

◆ CheckRegExps

◆ CompareGPUSettingsByPriority

◆ copyWithZone:

◆ dealloc

◆ defaultDetailLevel

◆ fboSupported

◆ getVersionMajor:minor:release:

◆ haveExtension:

◆ init

◆ lookUpPerGPUSettingsWithVersionString:extensionsString:

◆ majorVersionNumber

◆ maximumDetailLevel

◆ minorVersionNumber

◆ releaseVersionNumber

◆ rendererString

◆ reset

◆ retain

◆ retainCount

◆ shadersForceDisabled

◆ shadersSupported

◆ sharedManager

◆ textureCombinersSupported

◆ textureImageUnitCount

◆ textureUnitCount

◆ useDustShader

◆ useLineSmoothing

◆ usePointSmoothing

◆ vboSupported

◆ vendorString

◆ versionIsAtLeastMajor:minor:

Member Data Documentation

◆ defaultShaderSetting

◆ extensions

◆ major

◆ maximumShaderSetting

◆ minor

◆ release

◆ renderer

◆ shadersAvailable

◆ shadersForceDisabled

◆ textureImageUnitCount

◆ useDustShader

◆ useLineSmoothing

◆ usePointSmoothing

◆ vendor