FineMedia

group media

Provides classes for reading and writing image files. More...

Classes

Type Name
class ffw::BmpLoader
class ffw::BmpSaver
class ffw::DdsLoader
class ffw::DdsSaver
class ffw::ImageFormat
class ffw::ImageBuffer
class ffw::ImageReader
class ffw::ImageWriter
class ffw::JpgLoader
class ffw::JpgSaver
class ffw::PbmLoader
class ffw::PbmSaver
class ffw::PngLoader
class ffw::PngSaver
class ffw::TgaLoader
class ffw::TgaSaver
class ffw::TifLoader
class ffw::TifSaver

Enums

Type Name
enum ImageType { INVALID = 0, BITMAP_1, GRAYSCALE_4, GRAYSCALE_ALPHA_4, GRAYSCALE_8, GRAYSCALE_ALPHA_8, GRAYSCALE_16, GRAYSCALE_16F, GRAYSCALE_ALPHA_16, GRAYSCALE_ALPHA_16F, GRAYSCALE_32F, GRAYSCALE_ALPHA_32F, RG_88, RG_1616, RG_1616F, RG_3232F, RGB_565, RGB_888, RGB_161616, RGB_161616F, RGB_323232F, RGB_ALPHA_5551, RGB_ALPHA_4444, RGB_ALPHA_8888, RGB_ALPHA_16161616, RGB_ALPHA_16161616F, RGB_ALPHA_32323232F, RGB_DXT1, RGB_ALPHA_DXT3, RGB_ALPHA_DXT5, RED_RGTC1, RED_GREEN_RGTC2, SIGNED_RED_RGTC1, SIGNED_RED_GREEN_RGTC2, CUSTOM }

Functions

Type Name
unsigned short byteSwap16 (unsigned short Value)
unsigned long byteSwap32 (unsigned long Value)
unsigned long long byteSwap64 (unsigned long long Value)
ImageReader * openImageReader (const std::string & path)
ImageWriter * openImageWriter (const std::string & path, int width, int height, ffw::ImageType type, int quality = 100, int mips = 1)
void readImage (const std::string & path, void ** dest, int * width, int * height, ffw::ImageType * format, int * mips = NULL)
void writeImage (const std::string & path, const void * src, int width, int height, ffw::ImageType format, int quality = 100, int mips = 1)
void readImage (const std::string & path, ffw::ImageBuffer & image)
void writeImage (const std::string & path, const ffw::ImageBuffer & image, int quality = 100)

Detailed Description

Uses the following third party libraries: libjpeg, libpng, libtiff, libz, and bzip

Enums Documentation

enum ImageType

enum media::ImageType {
    INVALID = 0,
    BITMAP_1,
    GRAYSCALE_4,
    GRAYSCALE_ALPHA_4,
    GRAYSCALE_8,
    GRAYSCALE_ALPHA_8,
    GRAYSCALE_16,
    GRAYSCALE_16F,
    GRAYSCALE_ALPHA_16,
    GRAYSCALE_ALPHA_16F,
    GRAYSCALE_32F,
    GRAYSCALE_ALPHA_32F,
    RG_88,
    RG_1616,
    RG_1616F,
    RG_3232F,
    RGB_565,
    RGB_888,
    RGB_161616,
    RGB_161616F,
    RGB_323232F,
    RGB_ALPHA_5551,
    RGB_ALPHA_4444,
    RGB_ALPHA_8888,
    RGB_ALPHA_16161616,
    RGB_ALPHA_16161616F,
    RGB_ALPHA_32323232F,
    RGB_DXT1,
    RGB_ALPHA_DXT3,
    RGB_ALPHA_DXT5,
    RED_RGTC1,
    RED_GREEN_RGTC2,
    SIGNED_RED_RGTC1,
    SIGNED_RED_GREEN_RGTC2,
    CUSTOM,
};

Functions Documentation

function byteSwap16

unsigned short media::byteSwap16 (
    unsigned short Value
)

function byteSwap32

unsigned long media::byteSwap32 (
    unsigned long Value
)

function byteSwap64

unsigned long long media::byteSwap64 (
    unsigned long long Value
)

function openImageReader

ImageReader * media::openImageReader (
    const std::string & path
)

function openImageWriter

ImageWriter * media::openImageWriter (
    const std::string & path,
    int width,
    int height,
    ffw::ImageType type,
    int quality = 100,
    int mips = 1
)

function readImage

void media::readImage (
    const std::string & path,
    void ** dest,
    int * width,
    int * height,
    ffw::ImageType * format,
    int * mips = NULL
)

function writeImage

void media::writeImage (
    const std::string & path,
    const void * src,
    int width,
    int height,
    ffw::ImageType format,
    int quality = 100,
    int mips = 1
)

function readImage

void media::readImage (
    const std::string & path,
    ffw::ImageBuffer & image
)

function writeImage

void media::writeImage (
    const std::string & path,
    const ffw::ImageBuffer & image,
    int quality = 100
)