display_set_gui_size


Description

This function will only affect things drawn in the Draw GUI Event and can be used to set a specific width and height for all GUI components in that event, and no matter what size of display or window is used to display the GUI, it will be scaled to fit correctly. Where the GUI is positioned (ie: the (0,0) position) will depend on whether you have used the function display_set_gui_maximise() or not. If you do not use this function (the default setting) then the GUI layer will be positioned with its (0,0) point at the same position as that for the application surface (the area where your game is being drawn) and the width and height will be stretched to fit the this surface, such that setting a GUI width of 256px with this function when the application surface is 512px would stretch those 256 pixels to fit, effectively making the pixels twice as large. This is ideal for those games that have aspect ratio correction set in the global Game Settings.

If you have used the display_set_gui_maximise() function then the (0,0) position for the GUI layer will default to the top left corner of the game window (or the display when in fullscreen or on devices), with the scaling factor set by that function, and the width and height set by this one.

You can reset the GUI layer at any time to the default configuration by calling this function using -1 as both the width and height - this will set the GUI's (0, 0) position to the application_surface's top-left corner and the GUI width and height will be sized 1:1 with the application_surface.


Syntax:

display_set_gui_size(width, height);

Argument Description
width The new GUI width
height The new GUI height


Returns:

N/A


Examples:

display_set_gui_size(768, 1024);

The above code will set the GUI to the given width and height, scaling all components to fit either the application_surface or the display, using that proportion.

display_set_gui_size(-1, -1);

The above code will reset the GUI to the same position, width and height as the application_surface.