Ecore Buffer Library Functions

---

Utility functions that set up and shut down the Ecore Buffer library. This group of functions is applied to an Ecore_Buffer object.

Functions
Eina_Bool	ecore_buffer_init (void)
	Initializes the Ecore_Buffer system.
Eina_Bool	ecore_buffer_shutdown (void)
	Shuts down the Ecore_Buffer system.
Eina_Bool	ecore_buffer_register (Ecore_Buffer_Backend *be)
	Registers the given buffer backend.
void	ecore_buffer_unregister (Ecore_Buffer_Backend *be)
	Unregisters the given buffer backend.
Ecore_Buffer *	ecore_buffer_new (const char *engine, unsigned int width, unsigned int height, Ecore_Buffer_Format format, unsigned int flags)
	Creates a new Ecore_Buffer given type.
Ecore_Buffer *	ecore_buffer_new_with_tbm_surface (const char *engine, void *tbm_surface, unsigned int flags)
	Creates a new Ecore_Buffer based on given tbm surface.
void	ecore_buffer_free (Ecore_Buffer *buf)
	Frees the given Ecore_Buffer.
void	ecore_buffer_free_callback_add (Ecore_Buffer *buf, Ecore_Buffer_Cb func, void *data)
	Sets a callback for Ecore_Buffer free events.
void	ecore_buffer_free_callback_remove (Ecore_Buffer *buf, Ecore_Buffer_Cb func, void *data)
	Removes a callback for Ecore_Buffer free events.
Ecore_Pixmap	ecore_buffer_pixmap_get (Ecore_Buffer *buf)
	Returns the Pixmap of given Ecore_Buffer.
void *	ecore_buffer_tbm_surface_get (Ecore_Buffer *buf)
	Returns the tbm surface handle of given Ecore_Buffer.
Eina_Bool	ecore_buffer_size_get (Ecore_Buffer *buf, unsigned int *width, unsigned int *height)
	Returns size of given Ecore_Buffer.
Ecore_Buffer_Format	ecore_buffer_format_get (Ecore_Buffer *buf)
	Returns format of given Ecore_Buffer.
unsigned int	ecore_buffer_flags_get (Ecore_Buffer *buf)
	Returns the flags of given Ecore_Buffer.
Typedefs
typedef struct _Ecore_Buffer	Ecore_Buffer
typedef struct _Ecore_Buffer_Backend	Ecore_Buffer_Backend
typedef enum _Ecore_Export_Type	Ecore_Export_Type
typedef unsigned int	Ecore_Buffer_Format
typedef unsigned long	Ecore_Pixmap
typedef void *	Ecore_Buffer_Module_Data
typedef void *	Ecore_Buffer_Data
typedef void(*	Ecore_Buffer_Cb )(Ecore_Buffer *buf, void *data)
typedef struct _Ecore_Buffer_Plane	Ecore_Buffer_Plane
typedef struct _Ecore_Buffer_Info	Ecore_Buffer_Info
Defines
#define	ECORE_BUFFER_PLANE_MAX   4
	Definition for the maximum number of Ecore_Buffer's plane.

---

Define Documentation

#define ECORE_BUFFER_PLANE_MAX   4

Definition for the maximum number of Ecore_Buffer's plane.

Since (EFL) :

1.15

---

Typedef Documentation

Ecore_Buffer

An object representing a graphic buffer.

Since (EFL) :

1.15

Ecore_Buffer_Backend

The interfaces for backend of buffer.

Since (EFL) :

1.15

Ecore_Buffer_Cb

Called whenever Ecore_Buffer is freed.

Since (EFL) :

1.15

Ecore_Buffer_Data

The data of Ecore_Buffer.

Since (EFL) :

1.15

Ecore_Buffer_Format

The format of Ecore_Buffer.

Since (EFL) :

1.15

Ecore_Buffer_Info

Types for buffer information.

Since (EFL) :

1.15

Ecore_Buffer_Module_Data

The data of module.

Since (EFL) :

1.15

Ecore_Buffer_Plane

Types for plane information.

Since (EFL) :

1.15

Ecore_Export_Type

Types for export buffer.

Since (EFL) :

1.15

Ecore_Pixmap

An Id of Pixmap.

Since (EFL) :

1.15

---

Enumeration Type Documentation

enum _Ecore_Export_Type

Types for export buffer.

Since (EFL) :

1.15

---

Function Documentation

unsigned int ecore_buffer_flags_get

(

Ecore_Buffer *

buf

)

Returns the flags of given Ecore_Buffer.

Since (EFL) :

1.15

Parameters:

[in]

buf

The Ecore_Buffer

Returns:

The flags of given Ecore_Buffer.

NOTE: Not Defined yet.

Since :

2.4

Ecore_Buffer_Format ecore_buffer_format_get

(

Ecore_Buffer *

buf

)

Returns format of given Ecore_Buffer.

Since (EFL) :

1.15

Parameters:

[in]

buf

The Ecore_Buffer

Returns:

The format of given Ecore_Buffer.

Return value can be one of those pre-defined value such as ECORE_BUFFER_FORMAT_XRGB8888.

Since :

2.4

void ecore_buffer_free

(

Ecore_Buffer *

buf

)

Frees the given Ecore_Buffer.

Since (EFL) :

1.15

Parameters:

[in]

buf

The Ecore_Buffer to free

Since :

2.4

void ecore_buffer_free_callback_add	(	Ecore_Buffer *	buf,
		Ecore_Buffer_Cb	func,
		void *	data
	)

Sets a callback for Ecore_Buffer free events.

Since (EFL) :

1.15

Parameters:

[in]	buf	The Ecore_Buffer to set callbacks on
[in]	func	The function to call
[in]	data	A pointer to the user data to store.

A call to this function will set a callback on an Ecore_Buffer, causing func to be called whenever buf is freed.

See also:

ecore_buffer_free_callback_remove()

Since :

2.4

void ecore_buffer_free_callback_remove	(	Ecore_Buffer *	buf,
		Ecore_Buffer_Cb	func,
		void *	data
	)

Removes a callback for Ecore_Buffer free events.

Since (EFL) :

1.15

Parameters:

[in]	buf	The Ecore_Buffer to remove callbacks on
[in]	func	The function to remove
[in]	data	A pointer to the user data to remove

See also:

ecore_buffer_free_callback_add()

Since :

2.4

Eina_Bool ecore_buffer_init

(

void

)

Initializes the Ecore_Buffer system.

Since (EFL) :

1.15

Returns:

EINA_TRUE on success, EINA_FALSE otherwise.

See also:

ecore_buffer_shutdown()

Since :

2.4

Ecore_Buffer* ecore_buffer_new	(	const char *	engine,
		unsigned int	width,
		unsigned int	height,
		Ecore_Buffer_Format	format,
		unsigned int	flags
	)

Creates a new Ecore_Buffer given type.

Since (EFL) :

1.15

Parameters:

[in]	engine	The name of backend
[in]	width	Width for Ecore_Buffer
[in]	height	Height for Ecore_Buffer
[in]	format	Format for Ecore_Buffer
[in]	flags	Flags for Ecore_Buffer

Returns:

Newly allocated Ecore_Buffer instance, NULL otherwise.

Since :

2.4

Ecore_Buffer* ecore_buffer_new_with_tbm_surface	(	const char *	engine,
		void *	tbm_surface,
		unsigned int	flags
	)

Creates a new Ecore_Buffer based on given tbm surface.

Since (EFL) :

1.15

Parameters:

[in]	engine	The name of backend
[in]	tbm_surface	The handle of tbm_surface_h
[in]	flags	The flags for Ecore_Buffer

Returns:

Newly allocated Ecore_Buffer instance based on tbm surface, NULL otherwise.

Since :

2.4

Ecore_Pixmap ecore_buffer_pixmap_get

(

Ecore_Buffer *

buf

)

Returns the Pixmap of given Ecore_Buffer.

Since (EFL) :

1.15

Parameters:

[in]

buf

The Ecore_Buffer

Returns:

The Pixmap instance, 0 otherwise.

Since :

2.4

Eina_Bool ecore_buffer_register

(

Ecore_Buffer_Backend *

be

)

Registers the given buffer backend.

Since (EFL) :

1.15

Parameters:

[in]

be

The backend

Returns:

EINA_TRUE if backend has been correctly registered, EINA_FALSE otherwise.

Since :

2.4

Eina_Bool ecore_buffer_shutdown

(

void

)

Shuts down the Ecore_Buffer system.

Since (EFL) :

1.15

Returns:

EINA_TRUE on success, EINA_FALSE otherwise.

See also:

ecore_buffer_init()

Since :

2.4

Eina_Bool ecore_buffer_size_get	(	Ecore_Buffer *	buf,
		unsigned int *	width,
		unsigned int *	height
	)

Returns size of given Ecore_Buffer.

Since (EFL) :

1.15

Parameters:

[in]	buf	The Ecore_Buffer
[out]	width	Where to return the width value. May be NULL.
[out]	height	Where to return the height value. May be NULL.

Returns:

EINA_TRUE on success, EINA_FALSE otherwise.

Since :

2.4

void* ecore_buffer_tbm_surface_get

(

Ecore_Buffer *

buf

)

Returns the tbm surface handle of given Ecore_Buffer.

Since (EFL) :

1.15

Parameters:

[in]

buf

The Ecore_Buffer

Returns:

The tbm surface handle, NULL otherwise.

The tbm surface handle will be used for the API of libtbm. The API is described in tbm_surface.h in libtbm.

Since :

2.4

void ecore_buffer_unregister

(

Ecore_Buffer_Backend *

be

)

Unregisters the given buffer backend.

Since (EFL) :

1.15

Parameters:

[in]

be

The backend

Since :

2.4