synfig::SurfaceNew Class Reference

#include <surfacenew.h>

List of all members.

Public Types
typedef etl::handle < SurfaceNew >	Handle
typedef etl::handle < const SurfaceNew >	HandleConst
typedef etl::loose_handle < SurfaceNew >	LooseHandle
typedef SurfaceChannelLock	ChannelLock
typedef SurfaceChannelLockConst	ChannelLockConst
Public Member Functions
virtual	~SurfaceNew ()
int	get_w () const
int	get_h () const
void	set_wh (int w, int h)
ColorSystem	get_color_system () const
void	set_color_system (ColorSystem x)
Color	get_color (int x, int y) const
	Should only be used in certain circumstances.
void	lock ()
void	unlock ()
bool	trylock ()
ChannelLock	lock_channel (Channel chan)
ChannelLockConst	lock_channel_const (Channel chan) const
ChannelLock	lock_channel_alpha (Channel chan)
ChannelLockConst	lock_channel_alpha_const (Channel chan) const
bool	is_channel_defined (Channel chan) const
bool	get_premult () const
void	set_premult ()
Static Public Member Functions
static Handle	create (int w=0, int h=0, ColorSystem sys=COLORSYS_RGB)
	Normal SurfaceNew Constructor.
static Handle	create (const Surface &)
	Converts an old Surface to a SurfaceNew.
static Handle	create (HandleConst)
	Dupilcates a surface.
static Handle	crop (HandleConst, int x, int y, int w, int h)
	Creates a cropped copy of a surface.
static void	blit (Handle dest, int x_dest, int y_dest, HandleConst src, float amount=1.0, Color::BlendMethod bm=Color::BLEND_COMPOSITE)
static void	blit (Handle dest, int x_dest, int y_dest, Handle src, int x_src, int y_src, int w_src, int h_src, float amount=1.0, Color::BlendMethod bm=Color::BLEND_COMPOSITE)
static void	chan_mlt (ChannelLock &dest, float x)
static void	chan_mlt (ChannelLock &dest, const ChannelLockConst &x)
static void	chan_div (ChannelLock &dest, float x)
static void	chan_div (ChannelLock &dest, const ChannelLockConst &x)
static void	chan_add (ChannelLock &dest, float x)
static void	chan_add (ChannelLock &dest, const ChannelLockConst &x)
static void	chan_sub (ChannelLock &dest, float x)
static void	chan_sub (ChannelLock &dest, const ChannelLockConst &x)
Public Attributes
typedef	SurfaceChannel
typedef	SurfaceColorSystem
Protected Member Functions
	SurfaceNew ()
Friends
class	SurfaceChannelLock
class	Lock
Classes
class	Lock

---

Member Typedef Documentation

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

Todo:

This needs to be documented further.

typedef etl::handle<const SurfaceNew> synfig::SurfaceNew::HandleConst

Todo:

This needs to be documented further.

typedef etl::loose_handle<SurfaceNew> synfig::SurfaceNew::LooseHandle

Todo:

This needs to be documented further.

typedef SurfaceChannelLock synfig::SurfaceNew::ChannelLock

Todo:

This needs to be documented further.

typedef SurfaceChannelLockConst synfig::SurfaceNew::ChannelLockConst

Todo:

This needs to be documented further.

---

Constructor & Destructor Documentation

SurfaceNew::SurfaceNew

(

)

[protected]

Todo:

This needs to be documented further.

virtual synfig::SurfaceNew::~SurfaceNew

(

)

[virtual]

Todo:

This needs to be documented further.

---

Member Function Documentation

int SurfaceNew::get_w

(

)

const

Todo:

This needs to be documented further.

int SurfaceNew::get_h

(

)

const

Todo:

This needs to be documented further.

void SurfaceNew::set_wh	(	int	w,
		int	h
	)

Todo:

This needs to be documented further.

SurfaceNew::ColorSystem SurfaceNew::get_color_system

(

)

const

Todo:

This needs to be documented further.

void synfig::SurfaceNew::set_color_system

(

ColorSystem

x

)

Todo:

This needs to be documented further.

Color SurfaceNew::get_color	(	int	x,
		int	y
	)			const

Should only be used in certain circumstances.

void SurfaceNew::lock

(

)

Todo:

This needs to be documented further.

void SurfaceNew::unlock

(

)

Todo:

This needs to be documented further.

bool SurfaceNew::trylock

(

)

Todo:

This needs to be documented further.

ChannelLock synfig::SurfaceNew::lock_channel

(

Channel

chan

)

Todo:

This needs to be documented further.

ChannelLockConst synfig::SurfaceNew::lock_channel_const

(

Channel

chan

)

const

Todo:

This needs to be documented further.

ChannelLock synfig::SurfaceNew::lock_channel_alpha

(

Channel

chan

)

Todo:

This needs to be documented further.

ChannelLockConst synfig::SurfaceNew::lock_channel_alpha_const

(

Channel

chan

)

const

Todo:

This needs to be documented further.

bool SurfaceNew::is_channel_defined

(

Channel

chan

)

const

Todo:

This needs to be documented further.

bool SurfaceNew::get_premult

(

)

const

Todo:

This needs to be documented further.

void synfig::SurfaceNew::set_premult

(

)

Todo:

This needs to be documented further.

SurfaceNew::Handle SurfaceNew::create	(	int	w = 0,
		int	h = 0,
		ColorSystem	sys = COLORSYS_RGB
	)			[static]

Normal SurfaceNew Constructor.

SurfaceNew::Handle SurfaceNew::create

(

const Surface &

)

[static]

Converts an old Surface to a SurfaceNew.

SurfaceNew::Handle SurfaceNew::create

(

HandleConst

orig

)

[static]

Dupilcates a surface.

Handle SurfaceNew::crop	(	HandleConst	,
		int	x,
		int	y,
		int	w,
		int	h
	)			[static]

Creates a cropped copy of a surface.

static void synfig::SurfaceNew::blit	(	Handle	dest,
		int	x_dest,
		int	y_dest,
		HandleConst	src,
		float	amount = 1.0,
		Color::BlendMethod	bm = Color::BLEND_COMPOSITE
	)			[static]

static void synfig::SurfaceNew::blit	(	Handle	dest,
		int	x_dest,
		int	y_dest,
		Handle	src,
		int	x_src,
		int	y_src,
		int	w_src,
		int	h_src,
		float	amount = 1.0,
		Color::BlendMethod	bm = Color::BLEND_COMPOSITE
	)			[static]

void SurfaceNew::chan_mlt	(	ChannelLock &	dest,
		float	x
	)			[static]

void SurfaceNew::chan_mlt	(	ChannelLock &	dest,
		const ChannelLockConst &	x
	)			[static]

void SurfaceNew::chan_div	(	ChannelLock &	dest,
		float	x
	)			[static]

void SurfaceNew::chan_div	(	ChannelLock &	dest,
		const ChannelLockConst &	x
	)			[static]

void SurfaceNew::chan_add	(	ChannelLock &	dest,
		float	x
	)			[static]

void SurfaceNew::chan_add	(	ChannelLock &	dest,
		const ChannelLockConst &	x
	)			[static]

void SurfaceNew::chan_sub	(	ChannelLock &	dest,
		float	x
	)			[static]

void SurfaceNew::chan_sub	(	ChannelLock &	dest,
		const ChannelLockConst &	x
	)			[static]

---

Friends And Related Function Documentation

friend class SurfaceChannelLock [friend]

friend class Lock [friend]

---

Member Data Documentation

typedef synfig::SurfaceNew::SurfaceChannel

Todo:

This needs to be documented further.

typedef synfig::SurfaceNew::SurfaceColorSystem

Todo:

This needs to be documented further.

---

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

• surfacenew.h
• surfacenew.cpp

---