---

xlv_handler.h File Reference

Container of the Output handler description. More...

#include <glib.h>
#include <pthread.h>
#include "xlv_plugin_mgr.h"
#include "xlv_timer.h"
#include "xlv_renderer.h"
#include "xlv_list.h"

Go to the source code of this file.

Compounds
struct	_XLV_HandlerBuffer
	XLV_HandlerBuffer class definition. More...
struct	_XLV_OutputHandler
	Output handler class definition. More...
Defines
#define	XLV_HBUFFER_DONE   0x0001UL
#define	XLV_HBUFFER_PASSED   0x0002UL
#define	XLV_HBUFFER_SYNC   0x0004UL
#define	XLV_HBUFFER_WAITFOR   0x0008UL
#define	XLV_HBUFFER_ACCEL   0x0010UL
Typedefs
typedef _XLV_HandlerBuffer	XLV_HandlerBuffer
	XLV_HandlerBuffer class alias.
typedef _XLV_OutputHandler	XLV_OutputHandler
Functions
XLV_OutputHandler *	xlv_new_ohandler (XLV_Stream *out)
	contructor. More...
void	xlv_ohandler_release (XLV_OutputHandler *handler)
	destructor. More...
void	xlv_ohandler_use_timer (XLV_OutputHandler *handler, XLV_Timer *ref_timer)
void	xlv_ohandler_sync_on (XLV_OutputHandler *handler, XLV_OutputHandler *synch)
void	xlv_ohandler_set_frame_time (XLV_OutputHandler *handler, guint32 t)
void	xlv_ohandler_allocate_ring_buffer (XLV_OutputHandler *handler, guint ring_depth)
void	xlv_ohandler_free_ring_buffer (XLV_OutputHandler *handler)
void	xlv_ohandler_set_element_size (XLV_OutputHandler *handler, guint32 elem_size)
XLV_HandlerBuffer *	xlv_ohandler_get_buffer (XLV_OutputHandler *handler)
XLV_HandlerBuffer *	xlv_ohandler_get_sync_buffer (XLV_OutputHandler *handler)
void	xlv_ohandler_put_buffer (XLV_OutputHandler *handler, XLV_HandlerBuffer *buf)
guint	xlv_ohandler_queue (XLV_OutputHandler *handler, XLV_HandlerBuffer *buf)
void	xlv_ohandler_wait (XLV_OutputHandler *handler, XLV_HandlerBuffer *buf)
void	xlv_ohandler_halt_queue (XLV_OutputHandler *handler)
void	xlv_ohandler_resume_queue (XLV_OutputHandler *handler)
void	xlv_ohandler_resynchronize (XLV_OutputHandler *handler, guint32 time_stamp)
void	xlv_ohandler_flush (XLV_OutputHandler *handler)
void	xlv_ohandler_empty_queue (XLV_OutputHandler *handler)
gboolean	xlv_ohandler_ready (XLV_OutputHandler *handler)
gboolean	xlv_ohandler_is_critical (XLV_OutputHandler *handler)
guint16	xlv_ohandler_to_skip (XLV_OutputHandler *handler)
gboolean	xlv_ohandler_is_half_empty (XLV_OutputHandler *handler)

---

Detailed Description

Container of the Output handler description.

---

Function Documentation

XLV_OutputHandler* xlv_new_ohandler (  XLV_Stream *    out )

contructor. This is the XLV_OutputHandler constructor. It needs an already fully initialized renderer to build itself. Although many output handlers can output to a same renderer, it is advised to create only one output handler for a renderer. Parameters: out  an initialized renderer.

void xlv_ohandler_release (  XLV_OutputHandler *    handler )

destructor. Parameters: handler  a valid XLV_OutputHandler object.

void xlv_ohandler_set_frame_time (  XLV_OutputHandler *    handler, guint32    t )

This specifies how much time a frame longs roughly.

void xlv_ohandler_sync_on (  XLV_OutputHandler *    handler, XLV_OutputHandler *    synch )

The current output handler will use the timer of "synch" to synchronize

void xlv_ohandler_use_timer (  XLV_OutputHandler *    handler, XLV_Timer *    ref_timer )

This specifies which timer the handler will have to use to synchronize itself. For example, this may be a system clock or the timer of another output handler.

---