Stage

---

Object Hierarchy:

Description:

Content:

Properties:

• public bool accept_focus { set; get; }
  Whether the Stage should accept key focus when shown.
• public Color color { set; get; }
  The color of the main stage.
• public bool cursor_visible { set; get; }
  Whether the mouse pointer should be visible
• public Fog fog { set; get; }
  The settings for the GL "fog", used only if use_fog is set to true
• public bool fullscreen_set { get; }
• public Actor key_focus { set; get; }
  The Actor that will receive key events from the underlying windowing system.
• public bool no_clear_hint { set; get; }
  Whether or not the Stage should clear its contents before each paint cycle.
• public bool offscreen { set; get; }
  Whether the stage should be rendered in an offscreen buffer.
• public Perspective perspective { set; get; }
  The parameters used for the perspective projection from 3D coordinates to 2D
• public string title { set; get; }
  The stage's title - usually displayed in stage windows title decorations.
• public bool use_alpha { set; get; }
  Whether the Stage should honour the alpha component of the color property when painting. If Clutter is run under a compositing manager this will result in the stage being blended with the underlying window(s)
• public bool use_fog { set; get; }
  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 { set; get; }
  Whether the stage is resizable via user interaction.

Static methods:

• public static weak Stage get_default ()
  Returns the main stage. The default Stage is a singleton, so the stage will be created the first time this function is called (typically, inside init ); all the subsequent calls to get_default will return the same instance.

Creation methods:

• public Stage ()
  Creates a new, non-default stage. A non-default stage is a new top-level actor which can be used as another container. It works exactly like the default stage, but while get_default will always return the same instance, you will have to keep a pointer to any Stage returned by 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. It is not intended to be used by applications.
• public void ensure_redraw ()
  Ensures that stage 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 weak 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 weak 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 stage in stage pixel coordinates. E.g., if only a single actor has queued a redraw then Clutter may redraw the stage with a clip so that it doesn't have to paint every pixel in the stage. This function would then return the bounds of that clip. An application can use this information to avoid some extra work if it knows that some regions of the stage aren't going to be painted. This should only be called while the stage is being painted. If there is no current redraw clip then this function will set clip to the full extents of the stage.
• 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 stage.
• 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 stage 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. Applications should never use this function, but queue a redraw using queue_redraw.
• public void set_accept_focus (bool accept_focus)
  Sets whether the stage 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 stage.
• 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. An actor with key focus will receive all the key events. If actor is null, the stage will receive focus.
• 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 stage should clear itself at the beginning of each paint cycle or not.
• public void set_perspective (Perspective perspective)
  Sets the stage perspective. Using this function is not recommended because it will disable Clutter's attempts to generate an appropriate perspective based on the size of the stage.
• public void set_throttle_motion_events (bool throttle)
  Sets whether motion events received between redraws should be throttled or not. If motion events are throttled, those events received by the windowing system between redraws will be compressed so that only the last event will be propagated to the stage and its actors.
• public void set_title (string title)
  Sets the stage title.
• public void set_use_alpha (bool use_alpha)
  Sets whether the stage 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 void activate ()
  The activate signal is emitted when the stage receives key focus from the underlying window system.
• public virtual void deactivate ()
  The activate signal is emitted when the stage loses key focus from the underlying window system.
• public virtual bool delete_event (Event event)
  The delete_event signal is emitted when the user closes a Stage window using the window controls.
• public virtual void fullscreen ()
  The fullscreen signal is emitted when the stage is made fullscreen.
• public virtual void unfullscreen ()
  The unfullscreen signal is emitted when the stage leaves a fullscreen state.