Lumiera  0.pre.03
»edityourfreedom«
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
GdkDisplayer Class Reference

#include "gui/output/gdkdisplayer.hpp"

Description

GdkDisplayer is a class which is responsible for rendering a video image via GDK.

Todo:
the GdkDisplayer class is not supported anymore in Gtk3. This is due to Gtk3 only supporting drawing with Cairo /////////////////////////////////////////////////////////////////////////////////////////////////////TICKET #950 : new solution for video display

Definition at line 54 of file gdkdisplayer.hpp.

Public Member Functions

 GdkDisplayer (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...
 
- Public Member Functions inherited from Displayer
virtual ~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...
 

Protected Member Functions

bool usable ()
 Indicates if this object can be used to render images on the running system. More...
 

Private Attributes

Gtk::Widget * drawingArea
 The widget that video will be drawn into. More...
 

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

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

Constructor.

Parameters
[in]drawing_areaThe widget into which the video image will be drawn. This value must not be NULL.
[in]widthThe width of the video image in pixels. This value must be greater than zero.
[in]heightThe height of the video image in pixels. This value must be greater than zero.

Definition at line 48 of file gdkdisplayer.cpp.

References Displayer::imageHeight, Displayer::imageWidth, and NULL.

Member Function Documentation

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]imageThe video image array to draw.

Implements Displayer.

Definition at line 67 of file gdkdisplayer.cpp.

References Displayer::calculateVideoLayout(), GdkDisplayer::drawingArea, NULL, Displayer::preferredHeight(), and Displayer::preferredWidth().

+ Here is the call graph for this function:

bool usable ( )
protectedvirtual

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

Reimplemented from Displayer.

Definition at line 61 of file gdkdisplayer.cpp.

Member Data Documentation

Gtk::Widget* drawingArea
private

The widget that video will be drawn into.

Remarks
This value must be a valid pointer.

Definition at line 91 of file gdkdisplayer.hpp.

Referenced by GdkDisplayer::put().

+ Inheritance diagram for GdkDisplayer:
+ Collaboration diagram for GdkDisplayer:

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