game_stream_hw_framebuffer_properties Struct Reference

Hardware framebuffer properties More...

#include <game.h>

Public Attributes
unsigned int	max_width
	The largest frame width the client will render, in pixels.
unsigned int	max_height
	The largest frame height the client will render, in pixels.
float	nominal_display_aspect_ratio
	The nominal display aspect ratio (DAR) used to show the video frame.

Detailed Description

Hardware framebuffer properties

The remaining hardware rendering properties are passed earlier, via EnableHardwareRendering(). Display geometry is carried here, because it comes from the client's system AV info, which is not available that early.

Member Data Documentation

max_height

unsigned int game_stream_hw_framebuffer_properties::max_height

The largest frame height the client will render, in pixels.

max_width

unsigned int game_stream_hw_framebuffer_properties::max_width

The largest frame width the client will render, in pixels.

The frontend allocates its framebuffer at this size, so the client can render any frame into it without it being reallocated mid-game.

The framebuffer must exist before the stream is opened, because clients typically ask for it from inside HwContextReset(), which the frontend invokes as soon as the stream is open.

nominal_display_aspect_ratio

float game_stream_hw_framebuffer_properties::nominal_display_aspect_ratio

The nominal display aspect ratio (DAR) used to show the video frame.

An aspect ratio of 0.0 indicates square pixels, i.e. a DAR of W/H.

---

The documentation for this struct was generated from the following file:

• c-api/addon-instance/Game.h