synfig::Layer_Bitmap Class Reference

#include <layer_bitmap.h>

Inheritance diagram for synfig::Layer_Bitmap:

List of all members.

Public Types
typedef etl::handle< Layer_Bitmap >	Handle
Public Member Functions
	Layer_Bitmap ()
virtual bool	set_param (const String &param, ValueBase value)
virtual ValueBase	get_param (const String &param) const
	Get the value of the specified parameter.
virtual Color	get_color (Context context, const Point &pos) const
	Gets the color of the Canvas at point.
virtual Vocab	get_param_vocab () const
	Gets the paramater vocabulary.
virtual Rect	get_bounding_rect () const
virtual bool	accelerated_render (Context context, Surface *surface, int quality, const RendDesc &rend_desc, ProgressCallback *callback) const
	Renders the Canvas to the given Surface in an accelerated manner.
virtual synfig::Layer::Handle	hit_check (synfig::Context context, const synfig::Point &point) const
	Checks to see if a part of the layer is directly under point.
Public Attributes
Point	tl
Point	br
int	c
Surface	surface
Real	gamma_adjust

---

Detailed Description

Todo:

writeme

---

Member Typedef Documentation

typedef etl::handle<Layer_Bitmap> synfig::Layer_Bitmap::Handle

Reimplemented from synfig::Layer.

---

Constructor & Destructor Documentation

synfig::Layer_Bitmap::Layer_Bitmap

(

)

---

Member Function Documentation

bool synfig::Layer_Bitmap::set_param	(	const String &	param,
		ValueBase	value
	)			[virtual]

ValueBase synfig::Layer_Bitmap::get_param

(

const String &

param

)

const [virtual]

Get the value of the specified parameter.

Returns:

The requested parameter value, or (upon failure) a NIL ValueBase.

See also:

set_param()

Todo:

param should be of the type const String &

Reimplemented from synfig::Layer_Composite.

Color synfig::Layer_Bitmap::get_color	(	Context	context,
		const Point &	pos
	)			const [virtual]

Gets the color of the Canvas at point.

Parameters:

	context	Context iterator refering to next Layer.
	point	Point which indicates where the desired Color should come from

Todo:

point should be of the type const Point &

See also:

Handle::get_color()

Reimplemented from synfig::Layer.

Layer::Vocab Layer_Bitmap::get_param_vocab

(

)

const [virtual]

Gets the paramater vocabulary.

Reimplemented from synfig::Layer_Composite.

Rect Layer_Bitmap::get_bounding_rect

(

)

const [virtual]

Reimplemented from synfig::Layer.

bool Layer_Bitmap::accelerated_render	(	Context	context,
		Surface *	surface,
		int	quality,
		const RendDesc &	rend_desc,
		ProgressCallback *	callback
	)			const [virtual]

Renders the Canvas to the given Surface in an accelerated manner.

Parameters:

	context	Context iterator refering to next Layer.
	surface	Pointer to Surface to render to.
	quality	The requested quality-level to render at.
	rend_desc	The associated RendDesc.
	callback	Pointer to callback object. May be NULL if there is no callback.

Returns:

true on success, false on failure

See also:

Handle::accelerated_render()

Reimplemented from synfig::Layer_Composite.

synfig::Layer::Handle Layer_Bitmap::hit_check	(	synfig::Context	context,
		const synfig::Point &	point
	)			const [virtual]

Checks to see if a part of the layer is directly under point.

Parameters:

	context	Context iterator refering to next Layer.
	point	The point to check

Returns:

The handle of the layer under point. If there is not a layer under point, then returns an empty handle.

Reimplemented from synfig::Layer.

---

Member Data Documentation

Point synfig::Layer_Bitmap::tl

Point synfig::Layer_Bitmap::br

int synfig::Layer_Bitmap::c

Surface synfig::Layer_Bitmap::surface [mutable]

Real synfig::Layer_Bitmap::gamma_adjust

---

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

• layer_bitmap.h
• layer_bitmap.cpp

---