---
url: /modules/display.md
---
# Display

Display and window management routines.

**Header:** `#include <asw/modules/display.h>`\
**Namespace:** `asw::display`

## Functions

### `get_renderer`

```cpp
asw::Renderer* get_renderer();
```

Get the SDL renderer. Returns `nullptr` if the display is not initialized, or if it was initialized with `init_opengl`.

### `get_window`

```cpp
asw::Window* get_window();
```

Get the SDL window. Returns `nullptr` if the display is not initialized.

### `set_title`

```cpp
void set_title(const std::string& title);
```

Set the title of the window.

### `set_icon`

```cpp
void set_icon(const std::string& path);
```

Set the icon to display on the window. Silently fails if the file does not exist.

### `set_fullscreen`

```cpp
void set_fullscreen(bool fullscreen);
```

Set the window to fullscreen or windowed mode. If the [config](./config) sets `display.fullscreen`, the config wins and this function has no effect.

### `is_fullscreen`

```cpp
bool is_fullscreen();
```

Returns `true` if the window is fullscreen. It reads the window itself, so it is correct when the config sets `display.fullscreen`. Use it to show the real state in a settings menu.

### `set_resolution`

```cpp
void set_resolution(int w, int h);
```

Set the resolution of the window.

### `set_resizable`

```cpp
void set_resizable(bool resizable);
```

Set whether the window is resizable.

### `get_size`

```cpp
asw::Vec2<int> get_size();
```

Returns the actual size of the window.

### `get_logical_size`

```cpp
asw::Vec2<int> get_logical_size();
```

Returns the logical size of the window. This may differ from the actual size if scaling is enabled.

### `get_scale`

```cpp
asw::Vec2<float> get_scale();
```

Returns how many output pixels one logical pixel covers, after letterboxing. For example, `2.0` means that the game is drawn at twice its logical size.

### `set_render_target`

```cpp
void set_render_target(const asw::Texture& texture);
```

Set the render target to a texture.

### `reset_render_target`

```cpp
void reset_render_target();
```

Reset the render target back to the default (the window).

### `clear`

```cpp
void clear();
void clear(const asw::Color& color);
```

Clear the window. The first overload clears to black. The second clears to `color`.

### `present`

```cpp
void present();
```

Present the rendered frame to the window.

### `set_blend_mode`

```cpp
void set_blend_mode(asw::BlendMode mode);
```

Set the blend mode used to draw primitives, such as rectangles, lines and circles. The default is `BlendMode::Blend`, so colors with alpha are transparent. To set the blend mode of a texture, use [`asw::draw::set_blend_mode`](./draw#set-blend-mode).

### `screenshot`

```cpp
bool screenshot(const std::string& path);
```

Save what was drawn this frame to a PNG file. Call it after you draw and before `present()`, for example at the end of a scene's `draw()`. Returns `true` if the file was written, and `false` if the frame could not be read or the file could not be written. Returns `false` when there is no SDL renderer (for example, after `init_opengl`).

On high-density screens (for example, macOS Retina), the image is at pixel size, not logical size, because ASW draws at the full pixel density of the screen.

This function works with the dummy video driver (`SDL_VIDEO_DRIVER=dummy`), so scripted runs can capture frames without a window on screen.

### `warp_mouse`

```cpp
void warp_mouse(float x, float y);
```

Move the mouse cursor to a position in the window.

### `swap_window`

```cpp
void swap_window();
```

Swap the window buffers. Use this instead of `present()` when you initialize with `asw::core::init_opengl`.

## Example

```cpp
asw::display::set_title("My Game");
asw::display::set_icon("icon.png");

// Game loop
asw::display::clear();
// draw here...
asw::display::screenshot("frame.png"); // optional
asw::display::present();
```