XvDisplayer Class Reference

#include "stage/output/xvdisplayer.hpp"

Description

XvDisplayer is a class which is responsible for rendering a video image via XVideo.

Definition at line 53 of file xvdisplayer.hpp.

Public Member Functions
	XvDisplayer (Gtk::Widget *drawing_area, int width, int height)
	Constructor. More...
void	put (void *const image)
	Put an image of a given width and height with the expected input format (as indicated by the format method). More...
bool	usable ()
	Indicates if this object can be used to render images on the running system. More...
Public Member Functions inherited from Displayer
virtual DisplayerInput	format ()
	Indicates the format required by the abstract put method. More...
virtual int	preferredHeight ()
	Expected height of input to put. More...
virtual int	preferredWidth ()
	Expected width of input to put. More...

Private Attributes
Display *	display
	The display that video will be drawn into.
Gtk::Widget *	drawingArea
	The widget that video will be drawn into. More...
GC	gc
	The graphics context which will be used when rendering video.
bool	gotPort
	Specifies whether the object is currently attached to an XVideo port. More...
uint	grabbedPort
	The current port being used. More...
XShmSegmentInfo	shmInfo
	Info about the shared memory segment. More...
Window	window
	The X11 window that video will be drawn into.
XvImage *	xvImage
	The shared memory image object which video will be written into.

Additional Inherited Members
Static Protected Member Functions inherited from Displayer
static void	calculateVideoLayout (int widget_width, int widget_height, int image_width, int image_height, int &video_x, int &video_y, int &video_width, int &video_height)
	Calculates the coordinates for placing a video image inside a widget. More...
Protected Attributes inherited from Displayer
int	imageHeight
int	imageWidth

Constructor & Destructor Documentation

XvDisplayer()

XvDisplayer	(	Gtk::Widget *	drawing_area,
		int	width,
		int	height
	)

Constructor.

Parameters

drawing_area	The widget into which the video image will be drawn. This value must not be NULL.
width	The width of the video image in pixels. This value must be greater than zero.
height	The height of the video image in pixels. This value must be greater than zero.

Definition at line 36 of file xvdisplayer.cpp.

Member Function Documentation

put()

void put ( void *const  image )

virtual

Put an image of a given width and height with the expected input format (as indicated by the format method).

Parameters

[in]

image

The video image array to draw.

Implements Displayer.

Definition at line 212 of file xvdisplayer.cpp.

usable()

bool usable ( )

virtual

Indicates if this object can be used to render images on the running system.

Reimplemented from Displayer.

Definition at line 205 of file xvdisplayer.cpp.

References XvDisplayer::gotPort.

Member Data Documentation

gotPort

bool gotPort

private

Specifies whether the object is currently attached to an XVideo port.

Remarks

This value is false until the constructor has finished successfully.

Definition at line 87 of file xvdisplayer.hpp.

Referenced by XvDisplayer::usable().

grabbedPort

uint grabbedPort

private

The current port being used.

Remarks

This value is meaningless unless gotPort is true.

Definition at line 93 of file xvdisplayer.hpp.

drawingArea

Gtk::Widget* drawingArea

private

The widget that video will be drawn into.

Remarks

This value must be a valid pointer.

Definition at line 99 of file xvdisplayer.hpp.

shmInfo

XShmSegmentInfo shmInfo

private

Info about the shared memory segment.

Remarks

shmInfo.shmaddr is set to NULL, when the SHM is detached.

Definition at line 125 of file xvdisplayer.hpp.

Inheritance diagram for XvDisplayer:

Collaboration diagram for XvDisplayer:

---

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

• xvdisplayer.hpp
• xvdisplayer.cpp