Stage

---

Object Hierarchy:

Description:

Content:

Properties:

• public bool accept_focus { get; set; }
  Whether the Stage should accept key focus when shown.
• public Color color { get; set; }
  The background color of the main stage.
• public bool cursor_visible { get; set; }
  Whether the mouse pointer should be visible
• public Fog fog { get; set; }
  The settings for the GL "fog", used only if use_fog is set to true
• public bool fullscreen_set { get; }
• public Actor key_focus { get; set; }
  The Actor that will receive key events from the underlying windowing system.
• public bool no_clear_hint { get; set; }
  Whether or not the Stage should clear its contents before each paint cycle.
• public bool offscreen { get; set; }
  Whether the stage should be rendered in an offscreen buffer.
• public Perspective perspective { get; set; }
  The parameters used for the perspective projection from 3D coordinates to 2D
• public string title { get; set; }
  The stage's title - usually displayed in stage windows title decorations.
• public bool use_alpha { get; set; }
  Whether the Stage should honour the alpha component of the color property when painting.
• public bool use_fog { get; set; }
  Whether the stage should use a linear GL "fog" in creating the depth-cueing effect, to enhance the perception of depth by fading actors farther from the viewpoint.
• public bool user_resizable { get; set; }
  Whether the stage is resizable via user interaction.

Static methods:

• public static unowned Stage get_default ()
  Retrieves a Stage singleton.

Creation methods:

• public Stage ()
  Creates a new, non-default stage.

Methods:

• public bool emit_event (Event event)
  This function is used to emit an event on the main stage.
• public void ensure_current ()
  This function essentially makes sure the right GL context is current for the passed stage.
• public void ensure_redraw ()
  Ensures that this is redrawn
• public void ensure_viewport ()
  Ensures that the GL viewport is updated with the current stage window size.
• public bool get_accept_focus ()
  Retrieves the value set with set_accept_focus.
• public unowned Actor get_actor_at_pos (PickMode pick_mode, int x, int y)
  Checks the scene at the coordinates x and y and returns a pointer to the Actor at those coordinates.
• public Color get_color ()
  Retrieves the stage color.
• public Fog get_fog ()
  Retrieves the current depth cueing settings from the stage.
• public bool get_fullscreen ()
  Retrieves whether the stage is full screen or not
• public unowned Actor get_key_focus ()
  Retrieves the actor that is currently under key focus.
• public void get_minimum_size (out uint width, out uint height)
  Retrieves the minimum size for a stage window as set using set_minimum_size.
• public bool get_motion_events_enabled ()
  Retrieves the value set using set_motion_events_enabled.
• public bool get_no_clear_hint ()
  Retrieves the hint set with set_no_clear_hint
• public Perspective get_perspective ()
  Retrieves the stage perspective.
• public RectangleInt get_redraw_clip_bounds ()
  Gets the bounds of the current redraw for this in stage pixel coordinates.
• public bool get_throttle_motion_events ()
  Retrieves the value set with set_throttle_motion_events
• public unowned string get_title ()
  Gets the stage title.
• public bool get_use_alpha ()
  Retrieves the value set using set_use_alpha
• public bool get_use_fog ()
  Gets whether the depth cueing effect is enabled on this.
• public bool get_user_resizable ()
  Retrieves the value set with set_user_resizable.
• public void hide_cursor ()
  Makes the cursor invisible on the stage window
• public bool is_default ()
  Checks if this is the default stage, or an instance created using Stage but internally using the same implementation.
• public void queue_redraw ()
  Queues a redraw for the passed stage.
• public uint8[] read_pixels (int x, int y, int width = -1, int height = -1)
  Makes a screenshot of the stage in RGBA 8bit data, returns a linear buffer with width * 4 as rowstride.
• public void redraw ()
  Forces a redraw of the entire stage.
• public void set_accept_focus (bool accept_focus)
  Sets whether the this should accept the key focus when shown.
• public void set_color (Color color)
  Sets the stage color.
• public void set_fog (Fog fog)
  Sets the fog (also known as "depth cueing") settings for the this.
• public void set_fullscreen (bool fullscreen)
  Asks to place the stage window in the fullscreen or unfullscreen states.
• public void set_key_focus (Actor? actor)
  Sets the key focus on actor.
• public void set_minimum_size (uint width, uint height)
  Sets the minimum size for a stage window, if the default backend uses Stage inside a window
• public void set_motion_events_enabled (bool enabled)
  Sets whether per-actor motion events (and relative crossing events) should be disabled or not.
• public void set_no_clear_hint (bool no_clear)
  Sets whether the this should clear itself at the beginning of each paint cycle or not.
• public void set_perspective (Perspective perspective)
  Sets the stage perspective.
• public void set_throttle_motion_events (bool throttle)
  Sets whether motion events received between redraws should be throttled or not.
• public void set_title (string title)
  Sets the stage title.
• public void set_use_alpha (bool use_alpha)
  Sets whether the this should honour the opacity and the alpha channel of the color
• public void set_use_fog (bool fog)
  Sets whether the depth cueing effect on the stage should be enabled or not.
• public void set_user_resizable (bool resizable)
  Sets if the stage is resizable by user interaction (e.g. via window manager controls)
• public void show_cursor ()
  Shows the cursor on the stage window

Signals:

• public virtual signal void activate ()
  The activate signal is emitted when the stage receives key focus from the underlying window system.
• public signal void after_paint ()
  The after_paint signal is emitted after the stage is painted, but before the results are displayed on the screen.
• public virtual signal void deactivate ()
  The deactivate signal is emitted when the stage loses key focus from the underlying window system.
• public virtual signal bool delete_event (Event event)
  The delete_event signal is emitted when the user closes a Stage window using the window controls.
• public virtual signal void fullscreen ()
  The fullscreen signal is emitted when the stage is made fullscreen.
• public virtual signal void unfullscreen ()
  The unfullscreen signal is emitted when the stage leaves a fullscreen state.

Inherited Members: