Cinder  0.9.1
Public Member Functions | Protected Attributes | List of all members
cinder::ImageSource::Options Class Reference

#include <ImageIo.h>

Public Member Functions

 Options ()
 
Optionsindex (int32_t index)
 
OptionsthrowOnFirstException (bool b=true)
 
int32_t getIndex () const
 
bool getThrowOnFirstException ()
 

Protected Attributes

int32_t mIndex
 
bool mThrowOnFirstException
 

Detailed Description

Optional parameters passed when creating an Image.

See also
loadImage()

Constructor & Destructor Documentation

cinder::ImageSource::Options::Options ( )

Member Function Documentation

Options& cinder::ImageSource::Options::index ( int32_t  index)

Specifies an image index for multi-part images, like animated GIFs. 0-based index.

Options& cinder::ImageSource::Options::throwOnFirstException ( bool  b = true)

If an exception occurs, enabling this will prevent any attempts at using other handlers to load the image. Default = false, all handlers are tried and if none succeed, the last exception is rethrown.

See also
ImageIoException
int32_t cinder::ImageSource::Options::getIndex ( ) const

Returns image index.

See also
index()
bool cinder::ImageSource::Options::getThrowOnFirstException ( )

Returns whether throwOnFirstException() is enabled or not.

Member Data Documentation

int32_t cinder::ImageSource::Options::mIndex
protected
bool cinder::ImageSource::Options::mThrowOnFirstException
protected

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