#include <ImageIo.h>

Inherits cinder::ImageIo.

Inherited by cinder::gl::ImageSourceTexture, cinder::ImageSourceChannel, cinder::ImageSourceFileWic, cinder::ImageSourcePng, and cinder::ImageSourceSurface.

Classes
class	Options
Public Types
typedef void(ImageSource::*	RowFunc )(ImageTargetRef, int32_t, const void *)
enum	ColorModel { CM_RGB, CM_GRAY, CM_UNKNOWN }
typedef enum cinder::ImageIo::ColorModel	ColorModel
enum	DataType { UINT8, UINT16, FLOAT32, DATA_UNKNOWN }
typedef enum cinder::ImageIo::DataType	DataType
enum	ChannelType { CHAN_RGB_R, CHAN_RGB_G, CHAN_RGB_B, CHAN_GRAY, CHAN_ALPHA, CHAN_MASK, CHAN_LAB_L, CHAN_LAB_A, CHAN_LAB_B, CHAN_YUV_Y, CHAN_YUV_U, CHAN_YUV_V, CHAN_CMYK_C, CHAN_CMYK_M, CHAN_CMYK_Y, CHAN_CMYK_K, CHAN_UNKNOWN }
typedef enum cinder::ImageIo::ChannelType	ChannelType
enum	ChannelOrder { RGBA, BGRA, ARGB, ABGR, RGBX, BGRX, XRGB, XBGR, RGB, BGR, Y, YA, CUSTOM }
typedef enum cinder::ImageIo::ChannelOrder	ChannelOrder
Public Member Functions
	ImageSource ()
virtual	~ImageSource ()
float	getPixelAspectRatio () const
	Returns the aspect ratio of individual pixels to accommodate non-square pixels.
bool	isPremultiplied () const
	Returns whether the ImageSource's color data has been premultiplied by its alpha channel.
virtual void	load (ImageTargetRef target)=0
int32_t	getWidth () const
int32_t	getHeight () const
ColorModel	getColorModel () const
DataType	getDataType () const
ChannelOrder	getChannelOrder () const
virtual bool	hasAlpha () const
Static Public Member Functions
static void	translateRgbColorModelToOffsets (ChannelOrder channelOrder, int8_t red, int8_t green, int8_t blue, int8_t alpha, int8_t *inc)
static void	translateGrayColorModelToOffsets (ChannelOrder channelOrder, int8_t gray, int8_t alpha, int8_t *inc)
static bool	channelOrderHasAlpha (ChannelOrder channelOrder)
static int8_t	channelOrderNumChannels (ChannelOrder channelOrder)
static uint8_t	dataTypeBytes (DataType dataType)
static std::vector< std::string >	getLoadExtensions ()
static std::vector< std::string >	getWriteExtensions ()
Protected Member Functions
void	setPixelAspectRatio (float pixelAspectRatio)
void	setPremultiplied (bool premult=true)
void	setCustomPixelInc (int8_t customPixelInc)
	Allows declaration of a pixel increment different from what its ColorModel would imply. For example a non-planar Channel.
RowFunc	setupRowFunc (ImageTargetRef target)
void	setupRowFuncRgbSource (ImageTargetRef target)
void	setupRowFuncGraySource (ImageTargetRef target)
template<typename SD , typename TD , ColorModel TCS>
RowFunc	setupRowFuncForTypesAndTargetColorModel (ImageTargetRef target)
template<typename SD , typename TD >
RowFunc	setupRowFuncForTypes (ImageTargetRef target)
template<typename SD >
RowFunc	setupRowFuncForSourceType (ImageTargetRef target)
template<typename SD , typename TD , ImageIo::ColorModel TCM, bool ALPHA>
void	rowFuncSourceRgb (ImageTargetRef target, int32_t row, const void *data)
template<typename SD , typename TD , ColorModel TCM, bool ALPHA>
void	rowFuncSourceGray (ImageTargetRef target, int32_t row, const void *data)
void	setSize (int32_t width, int32_t height)
void	setColorModel (ColorModel colorModel)
void	setDataType (DataType aDataType)
void	setChannelOrder (ChannelOrder aChannelOrder)
Protected Attributes
float	mPixelAspectRatio
bool	mIsPremultiplied
int8_t	mCustomPixelInc
int8_t	mRowFuncSourceRed
int8_t	mRowFuncSourceGreen
int8_t	mRowFuncSourceBlue
int8_t	mRowFuncSourceAlpha
int8_t	mRowFuncTargetRed
int8_t	mRowFuncTargetGreen
int8_t	mRowFuncTargetBlue
int8_t	mRowFuncTargetAlpha
int8_t	mRowFuncSourceGray
int8_t	mRowFuncTargetGray
int8_t	mRowFuncSourceInc
int8_t	mRowFuncTargetInc
int32_t	mWidth
int32_t	mHeight
ColorModel	mColorModel
DataType	mDataType
ChannelOrder	mChannelOrder

Member Typedef Documentation

typedef void(ImageSource::* cinder::ImageSource::RowFunc)(ImageTargetRef, int32_t, const void *)

typedef enum cinder::ImageIo::ColorModel cinder::ImageIo::ColorModel [inherited]

typedef enum cinder::ImageIo::DataType cinder::ImageIo::DataType [inherited]

typedef enum cinder::ImageIo::ChannelType cinder::ImageIo::ChannelType [inherited]

typedef enum cinder::ImageIo::ChannelOrder cinder::ImageIo::ChannelOrder [inherited]

Member Enumeration Documentation

enum cinder::ImageIo::ColorModel [inherited]

Enumerator:

CM_RGB
CM_GRAY
CM_UNKNOWN

enum cinder::ImageIo::DataType [inherited]

Enumerator:

UINT8
UINT16
FLOAT32
DATA_UNKNOWN

enum cinder::ImageIo::ChannelType [inherited]

Enumerator:

CHAN_RGB_R
CHAN_RGB_G
CHAN_RGB_B
CHAN_GRAY
CHAN_ALPHA
CHAN_MASK
CHAN_LAB_L
CHAN_LAB_A
CHAN_LAB_B
CHAN_YUV_Y
CHAN_YUV_U
CHAN_YUV_V
CHAN_CMYK_C
CHAN_CMYK_M
CHAN_CMYK_Y
CHAN_CMYK_K
CHAN_UNKNOWN

enum cinder::ImageIo::ChannelOrder [inherited]

Enumerator:

RGBA
BGRA
ARGB
ABGR
RGBX
BGRX
XRGB
XBGR
RGB
BGR
Y
YA
CUSTOM

Constructor & Destructor Documentation

cinder::ImageSource::ImageSource ( )

virtual cinder::ImageSource::~ImageSource ( ) [virtual]

Member Function Documentation

float cinder::ImageSource::getPixelAspectRatio ( ) const

Returns the aspect ratio of individual pixels to accommodate non-square pixels.

bool cinder::ImageSource::isPremultiplied ( ) const

Returns whether the ImageSource's color data has been premultiplied by its alpha channel.

virtual void cinder::ImageSource::load ( ImageTargetRef target ) [pure virtual]

Implemented in cinder::ImageSourcePng, and cinder::ImageSourceFileWic.

void cinder::ImageSource::setPixelAspectRatio ( float pixelAspectRatio ) [protected]

void cinder::ImageSource::setPremultiplied ( bool premult = true ) [protected]

void cinder::ImageSource::setCustomPixelInc ( int8_t customPixelInc ) [protected]

Allows declaration of a pixel increment different from what its ColorModel would imply. For example a non-planar Channel.

ImageSource::RowFunc cinder::ImageSource::setupRowFunc ( ImageTargetRef target ) [protected]

void cinder::ImageSource::setupRowFuncRgbSource ( ImageTargetRef target ) [protected]

void cinder::ImageSource::setupRowFuncGraySource ( ImageTargetRef target ) [protected]

template<typename SD , typename TD , ImageIo::ColorModel TCM>

ImageSource::RowFunc cinder::ImageSource::setupRowFuncForTypesAndTargetColorModel ( ImageTargetRef target ) [protected]

template<typename SD , typename TD >

ImageSource::RowFunc cinder::ImageSource::setupRowFuncForTypes ( ImageTargetRef target ) [protected]

template<typename SD >

ImageSource::RowFunc cinder::ImageSource::setupRowFuncForSourceType ( ImageTargetRef target ) [protected]

template<typename SD , typename TD , ImageIo::ColorModel TCM, bool ALPHA>

void cinder::ImageSource::rowFuncSourceRgb	(	ImageTargetRef	target,
		int32_t	row,
		const void *	data
	)		`[protected]`

template<typename SD , typename TD , ImageIo::ColorModel TCM, bool ALPHA>

void cinder::ImageSource::rowFuncSourceGray	(	ImageTargetRef	target,
		int32_t	row,
		const void *	data
	)		`[protected]`

int32_t cinder::ImageIo::getWidth ( ) const [inherited]

int32_t cinder::ImageIo::getHeight ( ) const [inherited]

ColorModel cinder::ImageIo::getColorModel ( ) const [inherited]

DataType cinder::ImageIo::getDataType ( ) const [inherited]

ChannelOrder cinder::ImageIo::getChannelOrder ( ) const [inherited]

virtual bool cinder::ImageIo::hasAlpha ( ) const [virtual, inherited]

void cinder::ImageIo::translateRgbColorModelToOffsets	(	ChannelOrder	channelOrder,
		int8_t *	red,
		int8_t *	green,
		int8_t *	blue,
		int8_t *	alpha,
		int8_t *	inc
	)		`[static, inherited]`

void cinder::ImageIo::translateGrayColorModelToOffsets	(	ChannelOrder	channelOrder,
		int8_t *	gray,
		int8_t *	alpha,
		int8_t *	inc
	)		`[static, inherited]`

bool cinder::ImageIo::channelOrderHasAlpha ( ChannelOrder channelOrder ) [static, inherited]

int8_t cinder::ImageIo::channelOrderNumChannels ( ChannelOrder channelOrder ) [static, inherited]

uint8_t cinder::ImageIo::dataTypeBytes ( DataType dataType ) [static, inherited]

vector< string > cinder::ImageIo::getLoadExtensions ( ) [static, inherited]

Returns a vector of the extensions ImageIo supports for loading. Suitable for the extensions parameters of getOpenFilePath()

vector< string > cinder::ImageIo::getWriteExtensions ( ) [static, inherited]

Returns a vector of the extensions ImageIo supports for writing. Suitable for the extensions parameters of getSaveFilePath()

void cinder::ImageIo::setSize	(	int32_t	width,
		int32_t	height
	)		`[protected, inherited]`

void cinder::ImageIo::setColorModel ( ColorModel colorModel ) [protected, inherited]

void cinder::ImageIo::setDataType ( DataType aDataType ) [protected, inherited]

void cinder::ImageIo::setChannelOrder ( ChannelOrder aChannelOrder ) [protected, inherited]

Member Data Documentation

float cinder::ImageSource::mPixelAspectRatio [protected]

bool cinder::ImageSource::mIsPremultiplied [protected]

int8_t cinder::ImageSource::mCustomPixelInc [protected]

int8_t cinder::ImageSource::mRowFuncSourceRed [protected]

int8_t cinder::ImageSource::mRowFuncSourceGreen [protected]

int8_t cinder::ImageSource::mRowFuncSourceBlue [protected]

int8_t cinder::ImageSource::mRowFuncSourceAlpha [protected]

int8_t cinder::ImageSource::mRowFuncTargetRed [protected]

int8_t cinder::ImageSource::mRowFuncTargetGreen [protected]

int8_t cinder::ImageSource::mRowFuncTargetBlue [protected]

int8_t cinder::ImageSource::mRowFuncTargetAlpha [protected]

int8_t cinder::ImageSource::mRowFuncSourceGray [protected]

int8_t cinder::ImageSource::mRowFuncTargetGray [protected]

int8_t cinder::ImageSource::mRowFuncSourceInc [protected]

int8_t cinder::ImageSource::mRowFuncTargetInc [protected]

int32_t cinder::ImageIo::mWidth [protected, inherited]

int32_t cinder::ImageIo::mHeight [protected, inherited]

ColorModel cinder::ImageIo::mColorModel [protected, inherited]

DataType cinder::ImageIo::mDataType [protected, inherited]

ChannelOrder cinder::ImageIo::mChannelOrder [protected, inherited]

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

include/cinder/ImageIo.h
src/cinder/ImageIo.cpp

Cinder

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation