PgmRenderBaseWindow

PgmRenderBaseWindow — Base class for Window.

Synopsis




            PgmRenderBaseWindow;
PgmRenderBaseWindow* pgm_render_base_window_new
                                            (void);
PgmRenderError pgm_render_base_window_update
                                            (PgmRenderBaseWindow *window);
PgmRenderError pgm_render_base_window_set_title
                                            (PgmRenderBaseWindow *window,
                                             const gchar *window_title,
                                             const gchar *icon_title);
PgmRenderError pgm_render_base_window_set_fullscreen
                                            (PgmRenderBaseWindow *window,
                                             gboolean fullscreen,
                                             gint width,
                                             gint height);
PgmRenderError pgm_render_base_window_get_fullscreen
                                            (PgmRenderBaseWindow *window,
                                             gboolean *fullscreen);
PgmRenderError pgm_render_base_window_get_screen_resolution
                                            (PgmRenderBaseWindow *window,
                                             gint *width,
                                             gint *height);
PgmRenderError pgm_render_base_window_get_screen_size
                                            (PgmRenderBaseWindow *window,
                                             gint *width,
                                             gint *height);
PgmRenderError pgm_render_base_window_get_events
                                            (PgmRenderBaseWindow *window,
                                             GList **events);
PgmRenderError pgm_render_base_window_add_drawable
                                            (PgmRenderBaseWindow *window,
                                             PgmRenderDrawable *drawable,
                                             PgmRenderDrawableOrder order);
PgmRenderError pgm_render_base_window_del_drawable
                                            (PgmRenderBaseWindow *window,
                                             PgmRenderDrawable *drawable);
PgmRenderError pgm_render_base_window_reorder_drawable
                                            (PgmRenderBaseWindow *window,
                                             PgmRenderDrawable *drawable,
                                             gint position);

Description

PgmRenderBaseWindow is a base class for Window render class.

Details

PgmRenderBaseWindow

typedef struct {
  GObject                  parent;

  GStaticMutex             *lock;
  GList                    *far_drawable;
  GList                    *z_ordered_drawable;
  GList                    *near_drawable;
  gboolean                 dirty;
  gint                     width;
  gint                     height;
  gint                     canvas_width;
  gint                     canvas_height;
  gfloat                   sx;
  gfloat                   sy;
  PgmRenderWindowScaleMode scale_mode;
  PgmRenderCursor          cursor;
} PgmRenderBaseWindow;

pgm_render_base_window_new ()

PgmRenderBaseWindow* pgm_render_base_window_new
                                            (void);

Creates a new PgmRenderBaseWindow instance.

Returns : A new PgmRenderBaseWindow.

pgm_render_base_window_update ()

PgmRenderError pgm_render_base_window_update
                                            (PgmRenderBaseWindow *window);

Update the window.

window : A PgmRenderBaseWindow object.
Returns : An error status.

pgm_render_base_window_set_title ()

PgmRenderError pgm_render_base_window_set_title
                                            (PgmRenderBaseWindow *window,
                                             const gchar *window_title,
                                             const gchar *icon_title);

Set the titles appearing in the title bar and in the iconified window list.

window : A PgmRenderBaseWindow object.
window_title : The window title.
icon_title : The icon title.
Returns : An error status.

pgm_render_base_window_set_fullscreen ()

PgmRenderError pgm_render_base_window_set_fullscreen
                                            (PgmRenderBaseWindow *window,
                                             gboolean fullscreen,
                                             gint width,
                                             gint height);

Set/unset fullscreen mode in the specified width/height mode.

window : A PgmRenderBaseWindow object.
fullscreen : The fullscreen state.
width : The width size of the fullscreen mode.
height : The height size of the fullscreen mode.
Returns : An error status.

pgm_render_base_window_get_fullscreen ()

PgmRenderError pgm_render_base_window_get_fullscreen
                                            (PgmRenderBaseWindow *window,
                                             gboolean *fullscreen);

Retrieves the fullscreen mode.

window : A PgmRenderBaseWindow object.
fullscreen : The fullscreen state to fill.
Returns : An error status.

pgm_render_base_window_get_screen_resolution ()

PgmRenderError pgm_render_base_window_get_screen_resolution
                                            (PgmRenderBaseWindow *window,
                                             gint *width,
                                             gint *height);

Retrieves the (width, height) screen resolution in pixels of the window.

window : A PgmRenderBaseWindow object.
width : The width in pixels to fill.
height : The height in pixels to fill.
Returns : An error status.

pgm_render_base_window_get_screen_size ()

PgmRenderError pgm_render_base_window_get_screen_size
                                            (PgmRenderBaseWindow *window,
                                             gint *width,
                                             gint *height);

Retrieves the (width, height) screen size in pixels of the window.

window : A PgmRenderBaseWindow object.
width : The width in pixels to fill.
height : The height in pixels to fill.
Returns : An error status.

pgm_render_base_window_get_events ()

PgmRenderError pgm_render_base_window_get_events
                                            (PgmRenderBaseWindow *window,
                                             GList **events);

Retrieves the generated events since the last get_events.

window : A PgmRenderBaseWindow object.
events : The event list to fill. Must be freed after usage.
Returns : An error status. MT safe.

pgm_render_base_window_add_drawable ()

PgmRenderError pgm_render_base_window_add_drawable
                                            (PgmRenderBaseWindow *window,
                                             PgmRenderDrawable *drawable,
                                             PgmRenderDrawableOrder order);

Add a PgmRenderDrawable object to the window with the given order type.

window : A PgmRenderBaseWindow object.
drawable : The PgmRenderDrawable object to add.
order : The ordering type.
Returns : An error status.

pgm_render_base_window_del_drawable ()

PgmRenderError pgm_render_base_window_del_drawable
                                            (PgmRenderBaseWindow *window,
                                             PgmRenderDrawable *drawable);

Del a PgmRenderDrawable object from the window.

window : A PgmRenderBaseWindow object.
drawable : The PgmRenderDrawable object to del.
Returns : An error status.

pgm_render_base_window_reorder_drawable ()

PgmRenderError pgm_render_base_window_reorder_drawable
                                            (PgmRenderBaseWindow *window,
                                             PgmRenderDrawable *drawable,
                                             gint position);

Reorder a PgmRenderDrawable object in the window at the given position. A position of -1 put the drawable at the end.

window : A PgmRenderBaseWindow object.
drawable : The PgmRenderDrawable object to reorder.
position : the new position of the object.
Returns : An error status. FIXME: Not needed anymore