OOPixMap.h File Reference

import "OOMaths.h"

Include dependency graph for OOPixMap.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	OOPixMap

Macros
#define	OORoundUpToPowerOf2_PixMap   OORoundUpToPowerOf2_32

Typedefs
typedef uint_fast32_t	OOPixMapDimension
typedef struct OOPixMap	OOPixMap

Enumerations
enum	OOPixMapFormat { kOOPixMapInvalidFormat = 0 , kOOPixMapGrayscale = 1 , kOOPixMapGrayscaleAlpha = 2 , kOOPixMapRGBA = 4 }

Functions
OOINLINE BOOL	OOIsNullPixMap (OOPixMap pixMap)
BOOL	OOIsValidPixMap (OOPixMap pixMap)
OOINLINE size_t	OOMinimumPixMapBufferSize (OOPixMap pixMap)
OOPixMap	OOMakePixMap (void *pixels, OOPixMapDimension width, OOPixMapDimension height, OOPixMapFormat format, size_t rowBytes, size_t bufferSize)
OOPixMap	OOAllocatePixMap (OOPixMapDimension width, OOPixMapDimension height, OOPixMapFormat format, size_t rowBytes, size_t bufferSize)
void	OOFreePixMap (OOPixMap *ioPixMap)
OOPixMap	OODuplicatePixMap (OOPixMap srcPixMap, size_t desiredSize)
BOOL	OOResizePixMap (OOPixMap *ioPixMap, size_t desiredSize)
OOINLINE void	OOCompactPixMap (OOPixMap *ioPixMap)
BOOL	OOExpandPixMap (OOPixMap *ioPixMap, size_t desiredSize)
void	OODumpPixMap (OOPixMap pixMap, NSString *name)
BOOL	OOIsValidPixMapFormat (OOPixMapFormat format)
unsigned short	OOPixMapBytesPerPixelForFormat (OOPixMapFormat format) PURE_FUNC
OOINLINE unsigned short	OOPixMapBytesPerPixel (OOPixMap pixMap)
NSString *	OOPixMapFormatName (OOPixMapFormat format) PURE_FUNC
BOOL	OOPixMapFormatHasAlpha (OOPixMapFormat format) PURE_FUNC

Variables
const OOPixMap	kOONullPixMap

Macro Definition Documentation

OORoundUpToPowerOf2_PixMap

#define OORoundUpToPowerOf2_PixMap   OORoundUpToPowerOf2_32

Definition at line 35 of file OOPixMap.h.

Referenced by OOGenerateMipMaps().

Typedef Documentation

OOPixMap

typedef struct OOPixMap OOPixMap

OOPixMapDimension

typedef uint_fast32_t OOPixMapDimension

Definition at line 33 of file OOPixMap.h.

Enumeration Type Documentation

OOPixMapFormat

enum OOPixMapFormat

Enumerator
kOOPixMapInvalidFormat
kOOPixMapGrayscale
kOOPixMapGrayscaleAlpha
kOOPixMapRGBA

Definition at line 38 of file OOPixMap.h.

{
    kOOPixMapInvalidFormat      = 0,
    kOOPixMapGrayscale          = 1,
    kOOPixMapGrayscaleAlpha     = 2,
    kOOPixMapRGBA               = 4
} OOPixMapFormat;

Function Documentation

OOAllocatePixMap()

OOPixMap OOAllocatePixMap	(	OOPixMapDimension	width,
		OOPixMapDimension	height,
		OOPixMapFormat	format,
		size_t	rowBytes,
		size_t	bufferSize )

Definition at line 73 of file OOPixMap.m.

{
    // Create pixmap struct with dummy pixel pointer to test validity.
    OOPixMap pixMap = OOMakePixMap((void *)-1, width, height, format, rowBytes, bufferSize);
    if (EXPECT_NOT(!OOIsValidPixMap(pixMap)))  return kOONullPixMap;
    
    pixMap.pixels = malloc(pixMap.bufferSize);
    if (EXPECT_NOT(pixMap.pixels == NULL))  return kOONullPixMap;
    
    return pixMap;
}

References OOPixMap::bufferSize, EXPECT_NOT, kOONullPixMap, OOIsValidPixMap(), OOMakePixMap(), and OOPixMap::pixels.

Referenced by OOConvertCubeMapToLatLong(), OODuplicatePixMap(), OOPixMapToRGBA(), and OOScalePixMap().

Here is the call graph for this function:

Here is the caller graph for this function:

OOCompactPixMap()

OOINLINE void OOCompactPixMap

(

OOPixMap *

ioPixMap

)

Definition at line 103 of file OOPixMap.h.

{ OOResizePixMap(ioPixMap, OOMinimumPixMapBufferSize(*ioPixMap)); }

References OOMinimumPixMapBufferSize(), and OOResizePixMap().

Referenced by OOExtractPixMapChannel().

Here is the call graph for this function:

Here is the caller graph for this function:

OODumpPixMap()

void OODumpPixMap	(	OOPixMap	pixMap,
		NSString *	name )

Definition at line 145 of file OOPixMap.m.

{
    if (!OOIsValidPixMap(pixMap))  return;
    
    MyOpenGLView *gameView = [UNIVERSE gameView];
    
    switch (pixMap.format)
    {
            
        case kOOPixMapInvalidFormat:
            break;
            
        case kOOPixMapGrayscale:
            [gameView dumpGrayToFileNamed:name
                                    bytes:pixMap.pixels
                                    width:pixMap.width
                                   height:pixMap.height
                                 rowBytes:pixMap.rowBytes];
            break;
            
        case kOOPixMapGrayscaleAlpha:
            [gameView dumpGrayAlphaToFileNamed:name
                                         bytes:pixMap.pixels
                                         width:pixMap.width
                                        height:pixMap.height
                                      rowBytes:pixMap.rowBytes];
            break;
            
        case kOOPixMapRGBA:
            [gameView dumpRGBAToRGBFileNamed:[name stringByAppendingString:@" rgb"]
                            andGrayFileNamed:[name stringByAppendingString:@" alpha"]
                                       bytes:pixMap.pixels
                                       width:pixMap.width
                                      height:pixMap.height
                                    rowBytes:pixMap.rowBytes];
            break;
    }
}

References MyOpenGLView::dumpGrayAlphaToFileNamed:bytes:width:height:rowBytes:, MyOpenGLView::dumpGrayToFileNamed:bytes:width:height:rowBytes:, MyOpenGLView::dumpRGBAToRGBFileNamed:andGrayFileNamed:bytes:width:height:rowBytes:, OOPixMap::format, kOOPixMapGrayscale, kOOPixMapGrayscaleAlpha, kOOPixMapInvalidFormat, kOOPixMapRGBA, and OOIsValidPixMap().

Here is the call graph for this function:

OODuplicatePixMap()

OOPixMap OODuplicatePixMap	(	OOPixMap	srcPixMap,
		size_t	desiredSize )

Definition at line 95 of file OOPixMap.m.

{
    if (EXPECT_NOT(!OOIsValidPixMap(srcPixMap)))  return kOONullPixMap;
    
    size_t minSize = OOMinimumPixMapBufferSize(srcPixMap);
    if (desiredSize < minSize)  desiredSize = minSize;
    
    OOPixMap result = OOAllocatePixMap(srcPixMap.width, srcPixMap.width, srcPixMap.format, srcPixMap.rowBytes, desiredSize);
    if (EXPECT_NOT(!OOIsValidPixMap(result)))  return kOONullPixMap;
    
    memcpy(result.pixels, srcPixMap.pixels, minSize);
    return result;
}

References EXPECT_NOT, OOPixMap::format, kOONullPixMap, OOAllocatePixMap(), OOIsValidPixMap(), OOMinimumPixMapBufferSize(), OOPixMap::pixels, OOPixMap::rowBytes, and OOPixMap::width.

Referenced by OOPixMapTextureLoader::dealloc.

Here is the call graph for this function:

Here is the caller graph for this function:

OOExpandPixMap()

BOOL OOExpandPixMap	(	OOPixMap *	ioPixMap,
		size_t	desiredSize )

Definition at line 130 of file OOPixMap.m.

{
    if (EXPECT_NOT(ioPixMap == NULL || !OOIsValidPixMap(*ioPixMap)))  return NO;
    if (desiredSize <= ioPixMap->bufferSize)  return YES;
    
    return OOResizePixMap(ioPixMap, desiredSize);
}

References EXPECT_NOT, OOIsValidPixMap(), and OOResizePixMap().

Here is the call graph for this function:

OOFreePixMap()

void OOFreePixMap

(

OOPixMap *

ioPixMap

)

Definition at line 86 of file OOPixMap.m.

{
    if (EXPECT_NOT(ioPixMap == NULL))  return;
    
    free(ioPixMap->pixels);
    *ioPixMap = kOONullPixMap;
}

References EXPECT_NOT, kOONullPixMap, and OOPixMap::pixels.

OOIsNullPixMap()

OOINLINE BOOL OOIsNullPixMap

(

OOPixMap

pixMap

)

Definition at line 60 of file OOPixMap.h.

{ return pixMap.pixels == NULL; }

References OOPixMap::pixels.

Referenced by OOPixMapToRGBA().

Here is the caller graph for this function:

OOIsValidPixMap()

BOOL OOIsValidPixMap

(

OOPixMap

pixMap

)

Definition at line 42 of file OOPixMap.m.

{
    return  pixMap.pixels != NULL &&
            pixMap.width > 0 &&
            pixMap.height > 0 &&
            OOIsValidPixMapFormat(pixMap.format) &&
            pixMap.rowBytes >= pixMap.width * OOPixMapBytesPerPixelForFormat(pixMap.format) &&
            pixMap.bufferSize >= pixMap.rowBytes * pixMap.height;
}

References OOPixMap::bufferSize, OOPixMap::format, OOPixMap::height, OOIsValidPixMapFormat(), OOPixMapBytesPerPixelForFormat(), OOPixMap::pixels, OOPixMap::rowBytes, and OOPixMap::width.

Referenced by OOCombinedEmissionMapGenerator::anisotropy, OOPixMapTextureLoader::dealloc, EnsureCorrectDataSize(), OOAllocatePixMap(), OOConvertCubeMapToLatLong(), OODumpPixMap(), OODuplicatePixMap(), OOExpandPixMap(), OOExtractPixMapChannel(), OOMakePixMap(), OOPixMapAddPixMap(), OOPixMapModulatePixMap(), OOPixMapModulateUniform(), OOPixMapToRGBA(), OOResizePixMap(), OOScalePixMap(), SqueezeHorizontally1(), SqueezeHorizontally2(), SqueezeHorizontally4(), SqueezeVertically1(), SqueezeVertically2(), SqueezeVertically4(), StretchHorizontally1(), StretchHorizontally2(), and StretchHorizontally4().

Here is the call graph for this function:

Here is the caller graph for this function:

OOIsValidPixMapFormat()

BOOL OOIsValidPixMapFormat

(

OOPixMapFormat

format

)

Definition at line 186 of file OOPixMap.m.

{
    switch (format)
    {
        case kOOPixMapInvalidFormat: return NO;
        case kOOPixMapGrayscale:
        case kOOPixMapGrayscaleAlpha:
        case kOOPixMapRGBA:
            return YES;
    }
    
    return NO;
}

References kOOPixMapGrayscale, kOOPixMapGrayscaleAlpha, kOOPixMapInvalidFormat, and kOOPixMapRGBA.

Referenced by OOIsValidPixMap().

Here is the caller graph for this function:

OOMakePixMap()

OOPixMap OOMakePixMap	(	void *	pixels,
		OOPixMapDimension	width,
		OOPixMapDimension	height,
		OOPixMapFormat	format,
		size_t	rowBytes,
		size_t	bufferSize )

Definition at line 53 of file OOPixMap.m.

{
    if (rowBytes == 0)  rowBytes = width * OOPixMapBytesPerPixelForFormat(format);
    if (bufferSize == 0)  bufferSize = rowBytes * height;
    
    OOPixMap result =
    {
        .pixels = pixels,
        .width = width,
        .height = height,
        .format = format,
        .rowBytes = rowBytes,
        .bufferSize = bufferSize
    };
    
    if (OOIsValidPixMap(result))  return result;
    else  return kOONullPixMap;
}

References kOONullPixMap, OOIsValidPixMap(), and OOPixMapBytesPerPixelForFormat().

Referenced by OOAllocatePixMap(), and OOScalePixMap().

Here is the call graph for this function:

Here is the caller graph for this function:

OOMinimumPixMapBufferSize()

OOINLINE size_t OOMinimumPixMapBufferSize

(

OOPixMap

pixMap

)

Definition at line 62 of file OOPixMap.h.

{ return pixMap.rowBytes * pixMap.height; }

References OOPixMap::height, and OOPixMap::rowBytes.

Referenced by OOCompactPixMap(), OODuplicatePixMap(), and OOResizePixMap().

Here is the caller graph for this function:

OOPixMapBytesPerPixel()

OOINLINE unsigned short OOPixMapBytesPerPixel

(

OOPixMap

pixMap

)

Definition at line 132 of file OOPixMap.h.

{
    return OOPixMapBytesPerPixelForFormat(pixMap.format);
}

References OOPixMap::format, and OOPixMapBytesPerPixelForFormat().

Referenced by ModulateUniform_4(), OOScalePixMap(), SqueezeHorizontally1(), SqueezeHorizontally2(), SqueezeHorizontally4(), SqueezeVertically1(), SqueezeVertically2(), SqueezeVertically4(), StretchHorizontally1(), StretchHorizontally2(), StretchHorizontally4(), StretchVerticallyN_x1(), StretchVerticallyN_x4(), ToRGBA_1(), and ToRGBA_2().

Here is the call graph for this function:

Here is the caller graph for this function:

OOPixMapBytesPerPixelForFormat()

unsigned short OOPixMapBytesPerPixelForFormat

(

OOPixMapFormat

format

)

Definition at line 202 of file OOPixMap.m.

{
    switch (format)
    {
        case kOOPixMapInvalidFormat: return 0;
        case kOOPixMapGrayscale: return 1;
        case kOOPixMapGrayscaleAlpha: return 2;
        case kOOPixMapRGBA: return 4;
    }
    
    return -1;
}

References kOOPixMapGrayscale, kOOPixMapGrayscaleAlpha, kOOPixMapInvalidFormat, and kOOPixMapRGBA.

Referenced by OOIsValidPixMap(), OOMakePixMap(), and OOPixMapBytesPerPixel().

Here is the caller graph for this function:

OOPixMapFormatHasAlpha()

BOOL OOPixMapFormatHasAlpha

(

OOPixMapFormat

format

)

Definition at line 232 of file OOPixMap.m.

{
    switch (format)
    {
        case kOOPixMapInvalidFormat: return NO;
        case kOOPixMapGrayscale: return NO;
        case kOOPixMapGrayscaleAlpha: return YES;
        case kOOPixMapRGBA: return YES;
    }
    
    return NO;
}

References kOOPixMapGrayscale, kOOPixMapGrayscaleAlpha, kOOPixMapInvalidFormat, and kOOPixMapRGBA.

OOPixMapFormatName()

NSString * OOPixMapFormatName

(

OOPixMapFormat

format

)

Definition at line 217 of file OOPixMap.m.

{
    switch (format)
    {
        case kOOPixMapInvalidFormat: return @"invalid";
        case kOOPixMapGrayscale: return @"grayscale";
        case kOOPixMapGrayscaleAlpha: return @"grayscale+alpha";
        case kOOPixMapRGBA: return @"RGBA";
    }
    
    return [NSString stringWithFormat:@"invalid<%i>", (int)format];
}

References kOOPixMapGrayscale, kOOPixMapGrayscaleAlpha, kOOPixMapInvalidFormat, and kOOPixMapRGBA.

Referenced by OOGenerateMipMaps().

Here is the caller graph for this function:

OOResizePixMap()

BOOL OOResizePixMap	(	OOPixMap *	ioPixMap,
		size_t	desiredSize )

Definition at line 110 of file OOPixMap.m.

{
    if (EXPECT_NOT(ioPixMap == NULL || !OOIsValidPixMap(*ioPixMap)))  return NO;
    if (desiredSize == ioPixMap->bufferSize)  return YES;
    if (desiredSize < OOMinimumPixMapBufferSize(*ioPixMap))  return NO;
    
    void *newPixels = realloc(ioPixMap->pixels, desiredSize);
    if (newPixels != NULL)
    {
        ioPixMap->pixels = newPixels;
        ioPixMap->bufferSize = desiredSize;
        return YES;
    }
    else
    {
        return NO;
    }
}

References OOPixMap::bufferSize, EXPECT_NOT, OOIsValidPixMap(), OOMinimumPixMapBufferSize(), and OOPixMap::pixels.

Referenced by OOCompactPixMap(), and OOExpandPixMap().

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

kOONullPixMap

const OOPixMap kOONullPixMap

extern

Definition at line 31 of file OOPixMap.m.

{
    .pixels = NULL,
    .width = 0,
    .height = 0,
    .format = kOOPixMapInvalidFormat,
    .rowBytes = 0,
    .bufferSize = 0
};

Referenced by OOAllocatePixMap(), OOConvertCubeMapToLatLong(), OODuplicatePixMap(), OOFreePixMap(), OOMakePixMap(), and OOScalePixMap().