Clarisse 5.0 SP8 SDK  5.0.5.8.0
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Static Public Member Functions | List of all members
ImageIO Class Reference

Image Input/Output. This class offers statics methods to load and save image from and to the disk. More...

Inheritance diagram for ImageIO:
CoreBaseType

Public Types

enum  SavingStatus {
  SAVING_STATUS_OK = 0,
  SAVING_STATUS_NO_DATA,
  SAVING_STATUS_CREATION_ERROR,
  SAVING_STATUS_WRITE_ERROR,
  SAVING_STATUS_COUNT
}
 

Static Public Member Functions

static bool init (OfApp *of_app)
 
static bool get_image_specs (const CoreBasicString &filename, ImageHeader &specs)
 Reads the header and the specified filename and fill the ImageHeader structure.
 
static CoreString get_color_space_from_file (const CoreBasicString &filename)
 
static ImageCanvasload_image (const CoreString &filename, const ImageLoadOptions &options, OfApp *of_app=0, AppProgressBar *progress_bar=0, ImagePixel::RepeatMode u_mode=ImagePixel::RESET, ImagePixel::RepeatMode v_mode=ImagePixel::RESET)
 Loads the specified file into an ImageCanvas.
 
static SavingStatus save (const CoreString &filename, ImageSaveOptions &options, const ImageCanvas &image, OfApp *of_app=0, AppProgressBar *progress_bar=0, const GMathVec4f *data_render_region=0)
 Saves an image canvas to the disk.
 
static bool save_image (const CoreString &filename, const unsigned char *buffer, unsigned int nbchannels, unsigned int width, unsigned int height)
 Saves an RGBA interlaced buffer to the disk.
 
static bool save_image (const CoreString &filename, const float *buffer, unsigned int nbchannels, unsigned int width, unsigned int height)
 Saves an RGBA interlaced gloat buffer to the disk.
 
- Static Public Member Functions inherited from CoreBaseType
static const CoreClassInfoclass_info ()
 Get the type descriptor of this instance.
 

Additional Inherited Members

- Public Member Functions inherited from CoreBaseType
bool is_kindof (const CoreClassInfo &cinfo) const
 

Detailed Description

Image Input/Output. This class offers statics methods to load and save image from and to the disk.

Member Function Documentation

CoreString ImageIO::get_color_space_from_file ( const CoreBasicString filename)
static
Returns
the file colorspace from its filename
ImageIO::SavingStatus ImageIO::save ( const CoreString filename,
ImageSaveOptions options,
const ImageCanvas image,
OfApp of_app = 0,
AppProgressBar progress_bar = 0,
const GMathVec4f *  data_render_region = 0 
)
static

Saves an image canvas to the disk.

Parameters
formatOutput file format. Tiled images are created for EXR(16/32) and TIFF file formats.
color_spaceColor space that will be applied before writing the file to the disk.
bool ImageIO::save_image ( const CoreString filename,
const unsigned char *  buffer,
unsigned int  nbchannels,
unsigned int  width,
unsigned int  height 
)
static

Saves an RGBA interlaced buffer to the disk.

Parameters
nbchannelsNumber of channels in the image. 1 <= nbchannels <= 4
bool ImageIO::save_image ( const CoreString filename,
const float *  buffer,
unsigned int  nbchannels,
unsigned int  width,
unsigned int  height 
)
static

Saves an RGBA interlaced gloat buffer to the disk.

Parameters
nbchannelsNumber of channels in the image. 1 <= nbchannels <= 4