Show / Hide Table of Contents

    Interface IWindowInfo

    Information about the application window and the sub-window containing the game. Usually, the window hosting the game IS the application window, but for some scenarios (like for the editor which is hosting the game) the game can be configured to only use part of the window (a "sub window").

    Inherited Members
    System.ComponentModel.INotifyPropertyChanged.PropertyChanged
    Namespace: AGS.API
    Assembly: AGS.API.dll
    Syntax
    public interface IWindowInfo : INotifyPropertyChanged

    Properties

    | Improve this Doc View Source

    AppWindowHeight

    Gets the height of the application window.

    Declaration
    float AppWindowHeight { get; }
    Property Value
    Type Description
    System.Single

    The height of the application window.

    | Improve this Doc View Source

    AppWindowWidth

    Gets the width of the application window.

    Declaration
    float AppWindowWidth { get; }
    Property Value
    Type Description
    System.Single

    The width of the application window.

    | Improve this Doc View Source

    GameSubWindow

    Gets the rectangle (a subset of the application window) which contains the game. In the normal case this rectangle will be the entire application window. This rectangle includes possible black borders (if PreserveAspectRatio is enabled). To get the rectangle without the black borders, ScreenArea.

    Declaration
    Rectangle GameSubWindow { get; }
    Property Value
    Type Description
    Rectangle

    The game sub window.

    • Improve this Doc
    • View Source
    Back to top Generated by DocFX