#include <OOConcreteTexture.h>

Inheritance diagram for OOConcreteTexture:

Collaboration diagram for OOConcreteTexture:

Instance Methods
(id)	- initWithLoader:key:options:anisotropy:lodBias:

(id)	- initWithPath:key:options:anisotropy:lodBias:

(void)	- dealloc `[implementation]`

(NSString *)	- descriptionComponents `[implementation]`

(NSString *)	- shortDescriptionComponents `[implementation]`

(NSString *)	- name `[implementation]`

(void)	- apply `[implementation]`

(void)	- ensureFinishedLoading `[implementation]`

(BOOL)	- isFinishedLoading `[implementation]`

(NSString *)	- cacheKey `[implementation]`

(NSSize)	- dimensions `[implementation]`

(NSSize)	- originalDimensions `[implementation]`

(BOOL)	- isMipMapped `[implementation]`

(struct OOPixMap)	- copyPixMapRepresentation `[implementation]`

(BOOL)	- isRectangleTexture `[implementation]`

(BOOL)	- isCubeMap `[implementation]`

(NSSize)	- texCoordsScale `[implementation]`

(GLint)	- glTextureName `[implementation]`

(void)	- setUpTexture `[implementation]`

(void)	- uploadTexture `[implementation]`

(void)	- uploadTextureDataWithMipMap:format: `[implementation]`

(GLenum)	- glTextureTarget `[implementation]`

(BOOL)	- isReloadable `[implementation]`

(void)	- forceRebind `[implementation]`

Instance Methods inherited from OOTexture
(void)	- setTrace:

(size_t)	- dataSize

(id)	- init `[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

Private Attributes
NSString *	_path

NSString *	_key

uint8_t	_loaded: 1

uint8_t	_uploaded: 1

uint8_t	_valid: 1

uint8_t	_mipLevels

OOTextureLoader *	_loader

void *	_bytes

GLuint	_textureName

uint32_t	_width

uint32_t	_height

uint32_t	_originalWidth

uint32_t	_originalHeight

OOTextureDataFormat	_format

uint32_t	_options

NSString *	_name

Additional Inherited Members
Class Methods inherited from OOTexture
(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 inherited from OOTexture
BOOL	_trace

Protected Attributes inherited from OOWeakRefObject
OOWeakReference *	weakSelf

Detailed Description

Definition at line 37 of file OOConcreteTexture.h.

Method Documentation

◆ apply

- (void) apply

implementation

Reimplemented from OOTexture.

Definition at line 671 of file OOConcreteTexture.m.

{
    OO_ENTER_OPENGL();
    
    if (EXPECT_NOT(!_loaded))  [self setUpTexture];
    else if (EXPECT_NOT(!_uploaded))  [self uploadTexture];
    else  OOGL(glBindTexture([self glTextureTarget], _textureName));
    
#if GL_EXT_texture_lod_bias
    if (gOOTextureInfo.textureLODBiasAvailable)  OOGL(glTexEnvf(GL_TEXTURE_FILTER_CONTROL_EXT, GL_TEXTURE_LOD_BIAS_EXT, _lodBias));
#endif
}

References kOOLogParameterError, kOOTextureAlphaMask, kOOTextureDataGrayscale, kOOTextureDataGrayscaleAlpha, kOOTextureDataRGBA, kOOTextureSRGBA, and OOLog.

◆ cacheKey

- (NSString *) cacheKey

implementation

Reimplemented from OOTexture.

Definition at line 671 of file OOConcreteTexture.m.

{
    return _key;
}

◆ copyPixMapRepresentation

- (struct OOPixMap) copyPixMapRepresentation

implementation

Reimplemented from OOTexture.

Definition at line 671 of file OOConcreteTexture.m.

{
    [self ensureFinishedLoading];
    
    OOPixMap                px = kOONullPixMap;
    
    if (_bytes != NULL)
    {
        // If possible, just copy our existing buffer.
        px = OOMakePixMap(_bytes, _width, _height, _format, 0, 0);
        px = OODuplicatePixMap(px, 0);
    }
#if OOTEXTURE_RELOADABLE
    else
    {
        // Otherwise, read it back from OpenGL.
        OO_ENTER_OPENGL();
        
        GLenum format, internalFormat, type;
        if (!DecodeFormat(_format, _options, &format, &internalFormat, &type))
        {
            return kOONullPixMap;
        }
        
        if (![self isCubeMap])
        {
            
            px = OOAllocatePixMap(_width, _height, _format, 0, 0);
            if (!OOIsValidPixMap(px))  return kOONullPixMap;
            
            glGetTexImage(GL_TEXTURE_2D, 0, format, type, px.pixels);
        }
#if OO_TEXTURE_CUBE_MAP
        else
        {
            px = OOAllocatePixMap(_width, _width * 6, _format, 0, 0);
            if (!OOIsValidPixMap(px))  return kOONullPixMap;
            uint8_t *pixels = px.pixels;
            
            unsigned i;
            for (i = 0; i < 6; i++)
            {
                glGetTexImage(GL_TEXTURE_CUBE_MAP_POSITIVE_X + i, 0, format, type, pixels);
                pixels += OOPixMapBytesPerPixelForFormat(_format) * _width * _width;
            }
        }
#endif
    }
#endif
    
    return px;
}

◆ dealloc

- (void) dealloc

implementation

Reimplemented from OOTexture.

Definition at line 671 of file OOConcreteTexture.m.

{
#ifndef NDEBUG
    OOLog(_trace ? @"texture.allocTrace.dealloc" : @"texture.dealloc", @"Deallocating and uncaching texture %p", self);
#endif
    
#if OOTEXTURE_RELOADABLE
    DESTROY(_path);
#endif
    
    if (_loaded)
    {
        if (_textureName != 0)
        {
            OO_ENTER_OPENGL();
            OOGL(glDeleteTextures(1, &_textureName));
            _textureName = 0;
        }
        free(_bytes);
        _bytes = NULL;
    }
    
#ifndef OOTEXTURE_NO_CACHE
    [self removeFromCaches];
    [_key autorelease];
    _key = nil;
#endif
    
    DESTROY(_loader);
    
#ifndef NDEBUG
    DESTROY(_name);
#endif
    
    [super dealloc];
}

◆ descriptionComponents

- (NSString *) descriptionComponents

implementation

Definition at line 671 of file OOConcreteTexture.m.

{
    NSString                *stateDesc = nil;
    
    if (_loaded)
    {
        if (_valid)
        {
            stateDesc = [NSString stringWithFormat:@"%u x %u", _width, _height];
        }
        else
        {
            stateDesc = @"LOAD ERROR";
        }
    }
    else
    {
        stateDesc = @"loading";
    }
    
    return [NSString stringWithFormat:@"%@, %@", _key, stateDesc];
}

◆ dimensions

- (NSSize) dimensions

implementation

Reimplemented from OOTexture.

Definition at line 671 of file OOConcreteTexture.m.

{
    [self ensureFinishedLoading];
    
    return NSMakeSize(_width, _height);
}

◆ ensureFinishedLoading

- (void) ensureFinishedLoading

implementation

Reimplemented from OOTexture.

Definition at line 671 of file OOConcreteTexture.m.

{
    if (!_loaded)  [self setUpTexture];
}

◆ forceRebind

- (void) forceRebind

implementation

Reimplemented from OOTexture.

Provided by category OOConcreteTexture(Private).

Definition at line 671 of file OOConcreteTexture.m.

{
    if (_loaded && _uploaded && _valid)
    {
        OO_ENTER_OPENGL();
        
        _uploaded = NO;
        OOGL(glDeleteTextures(1, &_textureName));
        _textureName = 0;
        
#if OOTEXTURE_RELOADABLE
        if ([self isReloadable])
        {
            OOLog(@"texture.reload", @"Reloading texture %@", self);
            
            free(_bytes);
            _bytes = NULL;
            _loaded = NO;
            _uploaded = NO;
            _valid = NO;
            
            _loader = [[OOTextureLoader loaderWithPath:_path options:_options] retain];
        }
#endif
    }
}

◆ glTextureName

- (GLint) glTextureName

implementation

Reimplemented from OOTexture.

Definition at line 671 of file OOConcreteTexture.m.

{
    [self ensureFinishedLoading];
    
    return _textureName;
}

◆ glTextureTarget

- (GLenum) glTextureTarget

implementation

Provided by category OOConcreteTexture(Private).

Definition at line 671 of file OOConcreteTexture.m.

{
    GLenum texTarget = GL_TEXTURE_2D;
#if OO_TEXTURE_CUBE_MAP
    if (_isCubeMap)
    {
        texTarget = GL_TEXTURE_CUBE_MAP;
    }
#endif
    return texTarget;
}

◆ initWithLoader:key:options:anisotropy:lodBias:

- (id) initWithLoader:	(OOTextureLoader *)	loader
key:	(NSString *)	key
options:	(uint32_t)	options
anisotropy:	(GLfloat)	anisotropy
lodBias:	(GLfloat)	lodBias

Definition at line 671 of file OOConcreteTexture.m.

                     :(OOTextureLoader *)loader
                  key:(NSString *)key
              options:(uint32_t)options
           anisotropy:(GLfloat)anisotropy
              lodBias:(GLfloat)lodBias
{
    if (loader == nil)
    {
        [self release];
        return nil;
    }
    
    self = [super init];
    if (EXPECT_NOT(self == nil))  return nil;
    
    _loader = [loader retain];
    _options = options;
    
#if GL_EXT_texture_filter_anisotropic
    _anisotropy = OOClamp_0_1_f(anisotropy) * gOOTextureInfo.anisotropyScale;
#endif
#if GL_EXT_texture_lod_bias
    _lodBias = lodBias;
#endif
    
#ifndef NDEBUG
    if ([loader isKindOfClass:[OOTextureGenerator class]])
    {
        _name = [[NSString alloc] initWithFormat:@"<%@>", [loader class]];
    }
#endif
    
    _key = [key copy];
    
    [self addToCaches];
    
    return self;
}

◆ initWithPath:key:options:anisotropy:lodBias:

- (id) initWithPath:	(NSString *)	path
key:	(NSString *)	key
options:	(uint32_t)	options
anisotropy:	(float)	anisotropy
lodBias:	(GLfloat)	lodBias

Definition at line 671 of file OOConcreteTexture.m.

                  :(NSString *)path
               key:(NSString *)key
           options:(uint32_t)options
        anisotropy:(float)anisotropy
           lodBias:(GLfloat)lodBias
{
    OOTextureLoader *loader = [OOTextureLoader loaderWithPath:path options:options];
    if (loader == nil)
    {
        [self release];
        return nil;
    }
    
    if ((self = [self initWithLoader:loader key:key options:options anisotropy:anisotropy lodBias:lodBias]))
    {
#if OOTEXTURE_RELOADABLE
        _path = [path retain];
#endif
    }
    
    return self;
}

◆ isCubeMap

- (BOOL) isCubeMap

implementation

Reimplemented from OOTexture.

Definition at line 671 of file OOConcreteTexture.m.

{
#if OO_TEXTURE_CUBE_MAP
    return _isCubeMap;
#else
    return NO;
#endif
}

◆ isFinishedLoading

- (BOOL) isFinishedLoading

implementation

Reimplemented from OOTexture.

Definition at line 671 of file OOConcreteTexture.m.

{
    return _loaded || [_loader isReady];
}

◆ isMipMapped

- (BOOL) isMipMapped

implementation

Reimplemented from OOTexture.

Definition at line 671 of file OOConcreteTexture.m.

{
    [self ensureFinishedLoading];
    
    return _mipLevels != 0;
}

◆ isRectangleTexture

- (BOOL) isRectangleTexture

implementation

Reimplemented from OOTexture.

Definition at line 671 of file OOConcreteTexture.m.

{
#if GL_EXT_texture_rectangle
    return _isRectTexture;
#else
    return NO;
#endif
}

◆ isReloadable

- (BOOL) isReloadable

implementation

Provided by category OOConcreteTexture(Private).

Definition at line 671 of file OOConcreteTexture.m.

{
    return _path != nil;
}

◆ name

- (NSString *) name

implementation

Reimplemented from OOTexture.

Definition at line 671 of file OOConcreteTexture.m.

{
    if (_name != nil)  return _name;
    
#if OOTEXTURE_RELOADABLE
    NSString *name = [_path lastPathComponent];
#else
    NSString *name = [[[[self cacheKey] componentsSeparatedByString:@":"] objectAtIndex:0] lastPathComponent];
#endif
    
    NSString *channelSuffix = nil;
    switch (_options & kOOTextureExtractChannelMask)
    {
        case kOOTextureExtractChannelR:
            channelSuffix = @":r";
            break;
            
        case kOOTextureExtractChannelG:
            channelSuffix = @":g";
            break;
            
        case kOOTextureExtractChannelB:
            channelSuffix = @":b";
            break;
            
        case kOOTextureExtractChannelA:
            channelSuffix = @":a";
            break;
    }
    
    if (channelSuffix != nil)  name = [name stringByAppendingString:channelSuffix];
    
    return name;
}

◆ originalDimensions

- (NSSize) originalDimensions

implementation

Reimplemented from OOTexture.

Definition at line 671 of file OOConcreteTexture.m.

{
    [self ensureFinishedLoading];
    
    return NSMakeSize(_originalWidth, _originalHeight);
}

◆ setUpTexture

- (void) setUpTexture

implementation

Provided by category OOConcreteTexture(Private).

Definition at line 671 of file OOConcreteTexture.m.

{
    OOPixMap        pm;
    
    // This will block until loading is completed, if necessary.
    if ([_loader getResult:&pm format:&_format originalWidth:&_originalWidth originalHeight:&_originalHeight])
    {
        _bytes = pm.pixels;
        _width = pm.width;
        _height = pm.height;
        
#if OO_TEXTURE_CUBE_MAP
        if (_options & kOOTextureAllowCubeMap && _height == _width * 6 && gOOTextureInfo.cubeMapAvailable)
        {
            _isCubeMap = YES;
        }
#endif
        
#if !defined(NDEBUG) && OOTEXTURE_RELOADABLE
        if (_trace)
        {
            static unsigned dumpID = 0;
            NSString *name = [NSString stringWithFormat:@"tex dump %u \"%@\"", ++dumpID,[self name]];
            OOLog(@"texture.trace.dump", @"Dumped traced texture %@ to \'%@.png\'", self, name);
            OODumpPixMap(pm, name);
        }
#endif
        
        [self uploadTexture];
    }
    else
    {
        _textureName = 0;
        _valid = NO;
        _uploaded = YES;
    }
    
    _loaded = YES;
    
    DESTROY(_loader);
}

◆ shortDescriptionComponents

- (NSString *) shortDescriptionComponents

implementation

Definition at line 671 of file OOConcreteTexture.m.

{
    return _key;
}

◆ texCoordsScale

- (NSSize) texCoordsScale

implementation

Reimplemented from OOTexture.

Definition at line 671 of file OOConcreteTexture.m.

{
#if GL_EXT_texture_rectangle
    if (_loaded)
    {
        if (!_isRectTexture)
        {
            return NSMakeSize(1.0f, 1.0f);
        }
        else
        {
            return NSMakeSize(_width, _height);
        }
    }
    else
    {
        // Not loaded
        if (!(_options & kOOTextureAllowRectTexture))
        {
            return NSMakeSize(1.0f, 1.0f);
        }
        else
        {
            // Finishing may clear the rectangle texture flag (if the texture turns out to be POT)
            [self ensureFinishedLoading];
            return [self texCoordsScale];
        }
    }
#else
    return NSMakeSize(1.0f, 1.0f);
#endif
}

◆ uploadTexture

- (void) uploadTexture

implementation

Provided by category OOConcreteTexture(Private).

Definition at line 671 of file OOConcreteTexture.m.

{
    GLint                   filter;
    BOOL                    mipMap = NO;
    
    OO_ENTER_OPENGL();
    
    if (!_uploaded)
    {
        GLenum texTarget = [self glTextureTarget];
        
        OOGL(glGenTextures(1, &_textureName));
        OOGL(glBindTexture(texTarget, _textureName));
        
        // Select wrap mode
        GLint clampMode = gOOTextureInfo.clampToEdgeAvailable ? GL_CLAMP_TO_EDGE : GL_CLAMP;
        GLint wrapS = (_options & kOOTextureRepeatS) ? GL_REPEAT : clampMode;
        GLint wrapT = (_options & kOOTextureRepeatT) ? GL_REPEAT : clampMode;
        
#if OO_TEXTURE_CUBE_MAP
        if (texTarget == GL_TEXTURE_CUBE_MAP)
        {
            wrapS = wrapT = clampMode;
            OOGL(glTexParameteri(texTarget, GL_TEXTURE_WRAP_R, clampMode));
        }
#endif
        
        OOGL(glTexParameteri(texTarget, GL_TEXTURE_WRAP_S, wrapS));
        OOGL(glTexParameteri(texTarget, GL_TEXTURE_WRAP_T, wrapT));
        
        // Select min filter
        filter = _options & kOOTextureMinFilterMask;
        if (filter == kOOTextureMinFilterNearest)  filter = GL_NEAREST;
        else if (filter == kOOTextureMinFilterMipMap)
        {
            mipMap = YES;
            filter = GL_LINEAR_MIPMAP_LINEAR;
        }
        else  filter = GL_LINEAR;
        OOGL(glTexParameteri(texTarget, GL_TEXTURE_MIN_FILTER, filter));
        
#if GL_EXT_texture_filter_anisotropic
        if (gOOTextureInfo.anisotropyAvailable && mipMap && 1.0 < _anisotropy)
        {
            OOGL(glTexParameterf(texTarget, GL_TEXTURE_MAX_ANISOTROPY_EXT, _anisotropy));
        }
#endif
        
        // Select mag filter
        filter = _options & kOOTextureMagFilterMask;
        if (filter == kOOTextureMagFilterNearest)  filter = GL_NEAREST;
        else  filter = GL_LINEAR;
        OOGL(glTexParameteri(texTarget, GL_TEXTURE_MAG_FILTER, filter));
        
    //  if (gOOTextureInfo.clientStorageAvailable)  EnableClientStorage();
        
        if (texTarget == GL_TEXTURE_2D)
        {
            [self uploadTextureDataWithMipMap:mipMap format:_format];
            OOLog(@"texture.upload", @"Uploaded texture %u (%ux%u pixels, %@)", _textureName, _width, _height, _key);
        }
#if OO_TEXTURE_CUBE_MAP
        else if (texTarget == GL_TEXTURE_CUBE_MAP)
        {
            [self uploadTextureCubeMapDataWithMipMap:mipMap format:_format];
            OOLog(@"texture.upload", @"Uploaded cube map texture %u (%ux%ux6 pixels, %@)", _textureName, _width, _width, _key);
        }
#endif
        else
        {
            [NSException raise:NSInternalInconsistencyException format:@"Unhandled texture target 0x%X.", texTarget];
        }
        
        _valid = YES;
        _uploaded = YES;
        
#if OOTEXTURE_RELOADABLE
        if ([self isReloadable])
        {
            free(_bytes);
            _bytes = NULL;
        }
#endif
    }
}

◆ uploadTextureDataWithMipMap:format:

- (void) uploadTextureDataWithMipMap:		(BOOL)	mipMap
format:		(OOTextureDataFormat)	format

implementation

Provided by category OOConcreteTexture(Private).

Definition at line 671 of file OOConcreteTexture.m.

                                   :(BOOL)mipMap format:(OOTextureDataFormat)format
{
    GLenum                  glFormat = 0, internalFormat = 0, type = 0;
    unsigned                w = _width,
                            h = _height,
                            level = 0;
    char                    *bytes = _bytes;
    uint8_t                 components = OOTextureComponentsForFormat(format);
    
    OO_ENTER_OPENGL();
    
    if (!DecodeFormat(format, _options, &glFormat, &internalFormat, &type))  return;
    
    while (0 < w && 0 < h)
    {
        OOGL(glTexImage2D(GL_TEXTURE_2D, level++, internalFormat, w, h, 0, glFormat, type, bytes));
        if (!mipMap)  return;
        bytes += w * components * h;
        w >>= 1;
        h >>= 1;
    }
    
    // Note: we only reach here if (mipMap).
    _mipLevels = level - 1;
    OOGL(glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MAX_LEVEL, _mipLevels));
}

Member Data Documentation

◆ _bytes

- (void*) _bytes

private

Definition at line 57 of file OOConcreteTexture.h.

◆ _format

- (OOTextureDataFormat) _format

private

Definition at line 64 of file OOConcreteTexture.h.

◆ _height

- (uint32_t) _height

private

Definition at line 60 of file OOConcreteTexture.h.

◆ _key

- (NSString*) _key

private

Definition at line 43 of file OOConcreteTexture.h.

◆ _loaded

- (uint8_t) _loaded

private

Definition at line 44 of file OOConcreteTexture.h.

◆ _loader

- (OOTextureLoader*) _loader

private

Definition at line 55 of file OOConcreteTexture.h.

◆ _mipLevels

- (uint8_t) _mipLevels

private

Definition at line 53 of file OOConcreteTexture.h.

◆ _name

- (NSString*) _name

private

Definition at line 74 of file OOConcreteTexture.h.

◆ _options

- (uint32_t) _options

private

Definition at line 65 of file OOConcreteTexture.h.

◆ _originalHeight

- (uint32_t) _originalHeight

private

Definition at line 62 of file OOConcreteTexture.h.

◆ _originalWidth

- (uint32_t) _originalWidth

private

Definition at line 61 of file OOConcreteTexture.h.

◆ _path

- (NSString*) _path

private

Definition at line 41 of file OOConcreteTexture.h.

◆ _textureName

- (GLuint) _textureName

private

Definition at line 58 of file OOConcreteTexture.h.

◆ _uploaded

- (uint8_t) _uploaded

private

Definition at line 45 of file OOConcreteTexture.h.

◆ _valid

- (uint8_t) _valid

private

Definition at line 52 of file OOConcreteTexture.h.

◆ _width

- (uint32_t) _width

private

Definition at line 59 of file OOConcreteTexture.h.

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

src/Core/Materials/OOConcreteTexture.h
src/Core/Materials/OOConcreteTexture.m

Instance Methods

Private Attributes

Additional Inherited Members

Detailed Description

Method Documentation

◆ apply

◆ cacheKey

◆ copyPixMapRepresentation

◆ dealloc

◆ descriptionComponents

◆ dimensions

◆ ensureFinishedLoading

◆ forceRebind

◆ glTextureName

◆ glTextureTarget

◆ initWithLoader:key:options:anisotropy:lodBias:

◆ initWithPath:key:options:anisotropy:lodBias:

◆ isCubeMap

◆ isFinishedLoading

◆ isMipMapped

◆ isRectangleTexture

◆ isReloadable

◆ name

◆ originalDimensions

◆ setUpTexture

◆ shortDescriptionComponents

◆ texCoordsScale

◆ uploadTexture

◆ uploadTextureDataWithMipMap:format:

Member Data Documentation

◆ _bytes

◆ _format

◆ _height

◆ _key

◆ _loaded

◆ _loader

◆ _mipLevels

◆ _name

◆ _options

◆ _originalHeight

◆ _originalWidth

◆ _path

◆ _textureName

◆ _uploaded

◆ _valid

◆ _width