Clarisse 4.0 SP5b SDK  4.0.0.0.5.1
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions | Friends | List of all members
ImageProxy Class Reference

The ImageProxy is a proxy to an ImageCanvas. It holds data for the specified region in several float buffers (one per channel).
When creating and ImageProxy, its internal buffers are initiliazed with pixel data from the ImageCanvas it is referencing, for the requested region. More...

Inheritance diagram for ImageProxy:
CoreBaseObject CoreBaseType

Public Member Functions

const int & get_x () const
 Returns the X coordinate of the region covered.
 
const int & get_y () const
 Returns the Y coordinate of the region covered.
 
unsigned int get_width () const
 Returns the width of the region covered.
 
unsigned int get_height () const
 Returns the height of the region covered.
 
const int & get_image_width () const
 Returns the width of the image the proxy is linked to.
 
const int & get_image_height () const
 Returns the height of the image the proxy is linked to.
 
const CoreStringget_channel_name (const unsigned int &index) const
 Returns the name of the ith channel.
 
unsigned int get_channel_index (const CoreString &name) const
 Returns the index of a channel.
 
unsigned int get_channel_size () const
 Returns the number of pixel stored in the buffers.
 
const unsigned int & get_channel_count () const
 Returns the number of channels stored.
 
float * get_red_channel () const
 Returns the a pointer to the red data buffer. May be null!
 
float * get_green_channel () const
 Returns the a pointer to the green data buffer. May be null!
 
float * get_blue_channel () const
 Returns the a pointer to the blue data buffer. May be null!
 
float * get_alpha_channel () const
 Returns the a pointer to the alpha data buffer. May be null!
 
void compute_pixel_ray_intersection (const unsigned int &x, const unsigned int &y, GMathRay &ray, GeometryIntersection &intersection) const
 Computes the intersection between a region and the image the proxy is linked to.
 
- Public Member Functions inherited from CoreBaseObject
bool is_kindof (const CoreBaseObject &object) const
 
virtual size_t get_memory_size () const
 
CoreString get_class_info_name () const
 
CoreString get_class_interface () const
 
const unsigned long & get_class_info_id () const
 
bool is_kindof (const CoreClassInfo &cinfo) const
 
virtual const CoreClassInfoget_class_info () const
 
bool operator== (const CoreBaseObject &obj) const
 
template<class T >
T * cast ()
 
template<class T >
const T * cast () const
 
- Public Member Functions inherited from CoreBaseType
bool is_kindof (const CoreClassInfo &cinfo) const
 
bool operator== (const CoreBaseType &obj) const
 

Friends

class ImageCanvas
 

Additional Inherited Members

- Static Public Member Functions inherited from CoreBaseObject
static const CoreClassInfoclass_info ()
 
static bool ___class_destructor__ (void *instance, const bool &is_array)
 
template<class T >
static T * cast (CoreBaseObject *object)
 
template<class T >
static const T * cast (const CoreBaseObject *object)
 

Detailed Description

The ImageProxy is a proxy to an ImageCanvas. It holds data for the specified region in several float buffers (one per channel).
When creating and ImageProxy, its internal buffers are initiliazed with pixel data from the ImageCanvas it is referencing, for the requested region.

Note
Kernel and pixel filters do not work with an ImageCanvas or ImageMapChannels, but with an ImageProxy, which is supplied by the filter context. Creation and deletion of the ImageProxy is transparent. Once the filtering process on an ImageProxy is done, its contents are copied into the referenced image.