solargraph-dragonruby 0.2.0

data/stubs/extensions/grid.rb

@@ -0,0 +1,247 @@
+module GTK
+  # Information about the screen and game canvas. Use the global `Grid`
+  # (or `$grid`/`args.grid`). Unless noted, values are in logical
+  # (720p-scale) units and take `origin_name` and `orientation` into account.
+  class Grid
+    # @return [Symbol] `:landscape` (default) or `:portrait`, from `game_metadata.txt`
+    def orientation; end
+
+    # @return [Boolean] true on the frame the orientation changed (window resize or device rotation)
+    def orientation_changed?; end
+
+    # @return [Symbol] `:bottom_left` (default) or `:center`
+    def origin_name; end
+
+    # Sets the coordinate system so `0, 0` is the bottom-left corner.
+    # @return [void]
+    def origin_bottom_left!; end
+
+    # Sets the coordinate system so `0, 0` is the center of the screen.
+    # @return [void]
+    def origin_center!; end
+
+    # @return [Boolean] true if `orientation` is `:portrait`
+    def portrait?; end
+
+    # @return [Boolean] true if `orientation` is `:landscape`
+    def landscape?; end
+
+    # @return [Numeric] bottom of the grid (`0`, or `-360`/`-640` with a centered origin)
+    def bottom; end
+
+    # @return [Numeric] top of the grid
+    def top; end
+
+    # @return [Numeric] left of the grid
+    def left; end
+
+    # @return [Numeric] right of the grid
+    def right; end
+
+    # @return [Typing::RectHash] a rect primitive (`x`, `y`, `w`, `h`) representing the grid
+    def rect; end
+
+    # @return [Numeric] the grid's width
+    def w; end
+
+    # @return [Numeric] the grid's height
+    def h; end
+
+    # @return [Integer] width component of the aspect ratio (`16` in landscape for the default 16:9)
+    def aspect_ratio_w; end
+
+    # @return [Integer] height component of the aspect ratio (`9` in landscape for the default 16:9)
+    def aspect_ratio_h; end
+
+    # @return [Integer] the `aspect_size` from `game_metadata.txt` (default `720`)
+    def aspect_size; end
+
+    # @!group All Screen (area outside the 16:9 safe area, when the window overflows it)
+    #
+    # Pro license: only meaningful with `hd_letterbox=false` in
+    # `game_metadata.txt` (edge-to-edge rendering). Otherwise they match the
+    # logical values.
+
+    # Pro license: only differs from the logical value with `hd_letterbox=false`.
+    # @return [Numeric]
+    def allscreen_left; end
+    # Pro license: only differs from the logical value with `hd_letterbox=false`.
+    # @return [Numeric]
+    def allscreen_x; end
+    # Pro license: only differs from the logical value with `hd_letterbox=false`.
+    # @return [Numeric]
+    def allscreen_right; end
+    # Pro license: only differs from the logical value with `hd_letterbox=false`.
+    # @return [Numeric]
+    def allscreen_y; end
+    # Pro license: only differs from the logical value with `hd_letterbox=false`.
+    # @return [Numeric]
+    def allscreen_top; end
+    # Pro license: only differs from the logical value with `hd_letterbox=false`.
+    # @return [Numeric]
+    def allscreen_bottom; end
+    # Pro license: only differs from the logical value with `hd_letterbox=false`.
+    # @return [Numeric]
+    def allscreen_w; end
+    # Pro license: only differs from the logical value with `hd_letterbox=false`.
+    # @return [Numeric]
+    def allscreen_h; end
+    # Pro license: only differs from the logical value with `hd_letterbox=false`.
+    # @return [Typing::RectHash] rect covering the whole window
+    def allscreen_rect; end
+    # Pro license: only differs from the logical value with `hd_letterbox=false`.
+    # @return [Numeric]
+    def allscreen_offset_x; end
+    # Pro license: only differs from the logical value with `hd_letterbox=false`.
+    # @return [Numeric]
+    def allscreen_offset_y; end
+    # Pro license: only differs from the logical value with `hd_letterbox=false`.
+    # @return [Typing::PointHash] `x`, `y` offsets of the safe area within the window
+    def allscreen_offset; end
+
+    # @!endgroup
+
+    # @!group Pixel category
+    #
+    # Pro license: real pixel values require `hd=true` in `game_metadata.txt`.
+    # Without it (and on Standard), they return the logical values.
+
+    # Pro license: real pixel values need `hd=true` (otherwise same as the logical value).
+    # @return [Numeric]
+    def w_px; end
+    # Pro license: real pixel values need `hd=true` (otherwise same as the logical value).
+    # @return [Numeric]
+    def h_px; end
+    # Pro license: real pixel values need `hd=true` (otherwise same as the logical value).
+    # @return [Numeric]
+    def left_px; end
+    # Pro license: real pixel values need `hd=true` (otherwise same as the logical value).
+    # @return [Numeric]
+    def right_px; end
+    # Pro license: real pixel values need `hd=true` (otherwise same as the logical value).
+    # @return [Numeric]
+    def top_px; end
+    # Pro license: real pixel values need `hd=true` (otherwise same as the logical value).
+    # @return [Numeric]
+    def bottom_px; end
+    # Pro license: real pixel values need `hd=true` (otherwise same as the logical value).
+    # @return [Numeric]
+    def allscreen_left_px; end
+    # Pro license: real pixel values need `hd=true` (otherwise same as the logical value).
+    # @return [Numeric]
+    def allscreen_right_px; end
+    # Pro license: real pixel values need `hd=true` (otherwise same as the logical value).
+    # @return [Numeric]
+    def allscreen_top_px; end
+    # Pro license: real pixel values need `hd=true` (otherwise same as the logical value).
+    # @return [Numeric]
+    def allscreen_bottom_px; end
+    # Pro license: real pixel values need `hd=true` (otherwise same as the logical value).
+    # @return [Numeric]
+    def allscreen_offset_x_px; end
+    # Pro license: real pixel values need `hd=true` (otherwise same as the logical value).
+    # @return [Numeric]
+    def allscreen_offset_y_px; end
+
+    # @!endgroup
+
+    # Pro license (HD mode, `hd=true`).
+    #
+    # @return [Float] native scale of the window compared to 720p
+    def native_scale; end
+
+    # Pro license (HD mode, `hd=true`).
+    #
+    # @return [Float] best-fit pixel-perfect render scale compared to 720p (see `hd_max_scale`)
+    def render_scale; end
+
+    # Pro license (HD mode, `hd=true`).
+    #
+    # @return [Float] rendering scale for textures (720p: `1.0`, 1080p: `1.5`, 4k: `3.0`, ...)
+    def texture_scale; end
+
+    # Pro license (HD mode, `hd=true`).
+    #
+    # @return [Integer] best-fit texture atlas scale (720p: `100`, 1080p: `150`, ...)
+    def texture_scale_enum; end
+
+    # @return [Integer] refresh rate of the current display
+    def refresh_rate; end
+
+    # @return [Numeric] same as #left
+    def x; end
+
+    # @return [Numeric] same as #bottom
+    def y; end
+
+    # @return [Numeric] x of the center of the screen
+    def center_x; end
+
+    # @return [Numeric] y of the center of the screen
+    def center_y; end
+
+    # @return [Typing::RectHash] center of the screen as `{ x:, y:, w: 0, h: 0 }`
+    def center; end
+
+    # @return [Numeric] half of #w
+    def w_half; end
+
+    # @return [Numeric] half of #h
+    def h_half; end
+
+    # @return [Boolean] true if the origin is the center of the screen (see #origin_center!)
+    def origin_center?; end
+
+    # @return [Boolean] true if the origin is the bottom left of the screen (the default)
+    def origin_bottom_left?; end
+
+    # @return [Boolean] true if the game is letterboxed
+    def letterbox?; end
+
+    # @return [Boolean] true if `hd=true` is set in `game_metadata.txt` (Pro license)
+    def hd?; end
+
+    # @return [Boolean] true if `highdpi=true` is set in `game_metadata.txt`
+    def highdpi?; end
+
+    # @return [Float] high DPI scale of the display the window is on
+    def high_dpi_scale; end
+
+    # @return [Array<Symbol>] orientations from `game_metadata.txt` (`:landscape`, `:portrait`)
+    def supported_orientations; end
+
+    # Pro license: real pixel values need `hd=true` (otherwise same as the logical value).
+    # @return [Numeric]
+    def x_px; end
+    # Pro license: real pixel values need `hd=true` (otherwise same as the logical value).
+    # @return [Numeric]
+    def y_px; end
+    # Pro license: real pixel values need `hd=true` (otherwise same as the logical value).
+    # @return [Typing::RectHash] `{ x:, y:, w:, h: }`
+    def rect_px; end
+    # Pro license: real pixel values need `hd=true` (otherwise same as the logical value).
+    # @return [Numeric]
+    def allscreen_x_px; end
+    # Pro license: real pixel values need `hd=true` (otherwise same as the logical value).
+    # @return [Numeric]
+    def allscreen_y_px; end
+    # Pro license: real pixel values need `hd=true` (otherwise same as the logical value).
+    # @return [Numeric]
+    def allscreen_w_px; end
+    # Pro license: real pixel values need `hd=true` (otherwise same as the logical value).
+    # @return [Numeric]
+    def allscreen_h_px; end
+    # Pro license: real pixel values need `hd=true` (otherwise same as the logical value).
+    # @return [Typing::RectHash] `{ x:, y:, w:, h: }`
+    def allscreen_rect_px; end
+    # Pro license: real pixel values need `hd=true` (otherwise same as the logical value).
+    # @return [Typing::PointHash] `{ x:, y: }`
+    def allscreen_offset_px; end
+  end
+end
+
+# @return [GTK::Grid]
+Grid = GTK::Grid.new
+
+# @type [GTK::Grid]
+$grid = GTK::Grid.new