FineMedia

namespace ffw

Class List > ffw

Classes

Type Name
class BmpLoader
class BmpSaver
class DdsLoader
class DdsSaver
class ImageBuffer
class ImageException
class ImageFormat
class ImageReader
class ImageWriter
class JpgLoader
class JpgSaver
class PbmLoader
class PbmSaver
class PngLoader
class PngSaver
class SwapWrapper
class TgaLoader
class TgaSaver
class TifLoader
class 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)

Enums Documentation

enum ImageType

enum ffw::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 ffw::byteSwap16 (
    unsigned short Value
)

function byteSwap32

unsigned long ffw::byteSwap32 (
    unsigned long Value
)

function byteSwap64

unsigned long long ffw::byteSwap64 (
    unsigned long long Value
)

function openImageReader

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

function openImageWriter

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

function readImage

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

function writeImage

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

function readImage

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

function writeImage

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

The documentation for this class was generated from the following file: include/ffw/media/bmploader.h