Inheritance diagram for Clutter::Image:

Collaboration diagram for Clutter::Image:

Public Member Functions
virtual	~Image ()
ClutterImage*	gobj ()
	Provides access to the underlying C GObject. More...
const ClutterImage*	gobj () const
	Provides access to the underlying C GObject. More...
ClutterImage*	gobj_copy ()
	Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...
bool	set (const guint8* data, CoglPixelFormat pixel_format, guint width, guint height, guint row_stride)
	Sets the image data to be displayed by image. More...
bool	set (const Glib::Bytes& data, CoglPixelFormat pixel_format, guint width, guint height, guint row_stride)
	Sets the image data stored inside a Bytes to be displayed by image. More...
Public Member Functions inherited from Clutter::Content
virtual	~Content ()
ClutterContent*	gobj ()
	Provides access to the underlying C GObject. More...
const ClutterContent*	gobj () const
	Provides access to the underlying C GObject. More...
bool	get_preferred_size (float& width, float& height) const
	Retrieves the natural size of the content, if any. More...

Static Public Member Functions
static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system. More...
static Glib::RefPtr< Image >	create ()
Static Public Member Functions inherited from Clutter::Content
static void	add_interface (GType gtype_implementer)
static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system. More...

Protected Member Functions
	Image ()
Protected Member Functions inherited from Clutter::Content
	Content ()
	You should derive from this class to use it. More...
void	invalidate ()
	Invalidates a Clutter::Content. More...
virtual bool	get_preferred_size_vfunc (float& width, float& height) const
virtual void	attached_vfunc (const Glib::RefPtr< Actor >& actor)
virtual void	detached_vfunc (const Glib::RefPtr< Actor >& actor)
virtual void	invalidate_vfunc ()

Related Functions
(Note that these are not member functions.)
Glib::RefPtr< Clutter::Image >	wrap (ClutterImage* object, bool take_copy=false)
	A Glib::wrap() method for this object. More...
Related Functions inherited from Clutter::Content
Glib::RefPtr< Clutter::Content >	wrap (ClutterContent* object, bool take_copy=false)
	A Glib::wrap() method for this object. More...

Constructor & Destructor Documentation

virtual Clutter::Image::~Image ( )

virtual

Clutter::Image::Image ( )

explicitprotected

Member Function Documentation

static Glib::RefPtr<Image> Clutter::Image::create ( )

static

static GType Clutter::Image::get_type ( )

static

Get the GType for this class, for use with the underlying GObject type system.

ClutterImage* Clutter::Image::gobj ( )

inline

Provides access to the underlying C GObject.

const ClutterImage* Clutter::Image::gobj ( ) const

inline

Provides access to the underlying C GObject.

ClutterImage* Clutter::Image::gobj_copy

(

)

Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

bool Clutter::Image::set	(	const guint8 *	data,
		CoglPixelFormat	pixel_format,
		guint	width,
		guint	height,
		guint	row_stride
	)

Sets the image data to be displayed by image.

If the image data was successfully loaded, the image will be invalidated.

In case of error, the error value will be set, and this function will return false.

The image data is copied in texture memory.

Since cluttermm 1.10:

Parameters

data	The image data, as an array of bytes.
pixel_format	The Cogl pixel format of the image data.
width	The width of the image data.
height	The height of the image data.
row_stride	The length of each row inside data.

Returns

true if the image data was successfully loaded, and false otherwise.

bool Clutter::Image::set	(	const Glib::Bytes &	data,
		CoglPixelFormat	pixel_format,
		guint	width,
		guint	height,
		guint	row_stride
	)

Sets the image data stored inside a Bytes to be displayed by image.

If the image data was successfully loaded, the image will be invalidated.

In case of error, the error value will be set, and this function will return false.

The image data contained inside the Bytes is copied in texture memory, and no additional reference is acquired on the data.

Since cluttermm 1.12:

Parameters

data	The image data, as a Bytes.
pixel_format	The Cogl pixel format of the image data.
width	The width of the image data.
height	The height of the image data.
row_stride	The length of each row inside data.

Returns

true if the image data was successfully loaded, and false otherwise.

Friends And Related Function Documentation

Glib::RefPtr< Clutter::Image > wrap ( ClutterImage *  object, bool  take_copy = false  )

related

A Glib::wrap() method for this object.

Parameters

object	The C instance.
take_copy	False if the result should take ownership of the C instance. True if it should take a new copy or ref.

Returns

A C++ instance that wraps this C instance.

---

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

• cluttermm/image.h