About this class

Surface library.

Public Member Functions
vector	Mins (void)
	Returns the top-left starting position of the surface. More...

vector	Size (void)
	The size of the surface or display. More...

float	Width (void)
	The width of the surface or display. More...

float	Height (void)
	The height of the surface or display. More...

vector	HUDMins (void)
	Returns the top-left starting position of the HUD on the surface. More...

vector	HUDSize (void)
	Returns the size of the HUD. More...

Member Function Documentation

◆ Height()

float surfaceAPI_t::Height ( void )

The height of the surface or display.

Equivalent to the [1]/y value of Size()'s return value.

◆ HUDMins()

vector surfaceAPI_t::HUDMins ( void )

Returns the top-left starting position of the HUD on the surface.

You need to use this as you start position for every 2D element you want to display to ensure it's within the bounds of the visible view area. Similarily you want to avoid this when using screen filler effects because they may not cover the whole display.

◆ HUDSize()

vector surfaceAPI_t::HUDSize ( void )

Returns the size of the HUD.

Since players may be playing with accessibility options or a VR headset - so the HUD gets passed its own canvas so it can be altered in the backend for the above reasons.

◆ Mins()

vector surfaceAPI_t::Mins ( void )

Returns the top-left starting position of the surface.

You need to use this as you start position for every 2D element you want to display to ensure it's within the bounds of the visible view area. Similarily you want to avoid this when using screen filler effects because they may not cover the whole display.

◆ Size()

vector surfaceAPI_t::Size ( void )

The size of the surface or display.

Elements with positions larger than this may not be visible. For 2D HUD elements, query HUDSize() instead.

◆ Width()

float surfaceAPI_t::Width ( void )

The width of the surface or display.

Equivalent to the [0]/x value of Size()'s return value.

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

src/client/api_func.h