drawAPI_t Struct Reference

About this class

Draw library.

Public Member Functions
void	Rect (vector rectPos, vector rectSize, vector rectRGB, float rectAlpha)
	Displays a solid colored rectangle at the specified position with a specified size. More...
void	RectOutline (vector rectPos, vector rectSize, float outlineThickness, vector rectColor, float rectAlpha)
	Displays a colored rectangle outline at the specified position with a specified size. More...
void	RoundedBox (vector boxPos, vector boxSize, vector boxColor, float boxAlpha)
	Displays a colored rounded box at the specified position with a specified size. More...
void	Line (float lineThickness, vector startPos, vector endPos, vector lineColor, float lineAlpha)
	Displays a line with a specified thickness and color. More...
void	Pic (vector imagePos, string imageName, vector imageSize, vector imageColor, float imageAlpha, float imageFlags)
	Draws an image from either the virtual file-system, or the materials. More...
void	Text (vector vecOrigin, string strText, font_s fnt)
	Draw text on the screen at the desired position with a desired font. More...
void	Text_A (vector vecOrigin, string strText, float a, font_s fnt)
	Draw alpha-blended text on the screen at the desired position with a desired font. More...
void	Text_RGB (vector vecOrigin, string strText, vector col, font_s fnt)
	Draw tinted text on the screen at the desired position with a desired font. More...
void	Text_RGBA (vector vecOrigin, string strText, vector col, float a, font_s fnt)
	Draw tinted and alpha blended text on the screen at the desired position with a desired font. More...
void	RText (vector vecOrigin, string strText, font_s fnt)
	Right-aligned variant of Text(). More...
void	RText_A (vector vecOrigin, string strText, float a, font_s fnt)
	Right-aligned variant of Text_A(). More...
void	RText_RGB (vector vecOrigin, string strText, vector col, font_s fnt)
	Right-aligned variant of Text_RGB(). More...
void	RText_RGBA (vector vecOrigin, string strText, vector col, float a, font_s fnt)
	Right-aligned variant of Text_RGBA(). More...
void	TextField (vector vecOrigin, vector vecSize, string strText, font_s fnt, alignflags_t iAlignFlags)
	Draws a textfield with line wrapping. More...
void	TextFieldAtHeight (vector vecOrigin, vector vecSize, int iTextHeight, string strText, font_s fnt, alignflags_t iAlignFlags)
	Draws a textfield with line wrapping at a custom text height. More...

Member Function Documentation

Line()

void drawAPI_t::Line	(	float	lineThickness,
		vector	startPos,
		vector	endPos,
		vector	lineColor,
		float	lineAlpha
	)

Displays a line with a specified thickness and color.

Parameters

lineThickness	is the thickness of the line in pixels.
startPos	is the 'starting' point of the line.
endPos	is the second, 'endpoint' of the line.
lineColor	is the color of the line, in normalized RGB values. E.g. [0.0f, 1.0f, 0.0f] for green.
lineAlpha	is the alpha channel of the rectangle. 0.0 is invisible, 1.0 is fully visible.

Pic()

void drawAPI_t::Pic	(	vector	imagePos,
		string	imageName,
		vector	imageSize,
		vector	imageColor,
		float	imageAlpha,
		float	imageFlags
	)

Draws an image from either the virtual file-system, or the materials.

Parameters

imagePosis	the position at which the pic will be drawn.
imageName	is the path/name of the image. Can be a material as well. E.g. "gfx/foo.png" or "conback".
imageSize	is the size at which we draw the pic, in pixels.
imageColor	is the color/tint of the pic, in normalized RGB values. E.g. [0.5f, 0.5f, 0.5f] for gray/grey.
imageAlpha	is the alpha channel of the rectangle. 0.0 is invisible, 1.0 is fully visible.

Rect()

void drawAPI_t::Rect	(	vector	rectPos,
		vector	rectSize,
		vector	rectRGB,
		float	rectAlpha
	)

Displays a solid colored rectangle at the specified position with a specified size.

Parameters

rectPos	is the position at which the rectangle will be drawn.
rectSize	is the size at which we draw the rectangle, in pixels.
rectRGB	is the color of the rectangle, in normalized RGB values. E.g. [1.0f, 0.0f, 0.0f] for red.
rectAlpha	is the alpha channel of the rectangle. 0.0 is invisible, 1.0 is fully visible.

RectOutline()

void drawAPI_t::RectOutline	(	vector	rectPos,
		vector	rectSize,
		float	outlineThickness,
		vector	rectColor,
		float	rectAlpha
	)

Displays a colored rectangle outline at the specified position with a specified size.

Parameters

rectPos	is the position at which the rectangle will be drawn.
rectSize	is the size at which we draw the rectangle, in pixels.
outlineThickness	is the thickness of the outline. In pixels.
rectRGB	is the color of the rectangle, in normalized RGB values. E.g. [0.0f, 0.0f, 1.0f] for blue.
rectAlpha	is the alpha channel of the rectangle. 0.0 is invisible, 1.0 is fully visible.

RoundedBox()

void drawAPI_t::RoundedBox	(	vector	boxPos,
		vector	boxSize,
		vector	boxColor,
		float	boxAlpha
	)

Displays a colored rounded box at the specified position with a specified size.

Parameters

boxPos	is the position at which the box will be drawn.
boxSize	is the size at which we draw the box, in pixels.
boxColor	is the color of the box, in normalized RGB values. E.g. [1.0f, 1.0f, 0.0f] for yellow.
boxAlpha	is the alpha channel of the box. 0.0 is invisible, 1.0 is fully visible.

RText()

void drawAPI_t::RText	(	vector	vecOrigin,
		string	strText,
		font_s	fnt
	)

Right-aligned variant of Text().

See also

Text

RText_A()

void drawAPI_t::RText_A	(	vector	vecOrigin,
		string	strText,
		float	a,
		font_s	fnt
	)

Right-aligned variant of Text_A().

See also

Font_DrawText_A

RText_RGB()

void drawAPI_t::RText_RGB	(	vector	vecOrigin,
		string	strText,
		vector	col,
		font_s	fnt
	)

Right-aligned variant of Text_RGB().

See also

Font_DrawText_RGB

RText_RGBA()

void drawAPI_t::RText_RGBA	(	vector	vecOrigin,
		string	strText,
		vector	col,
		float	a,
		font_s	fnt
	)

Right-aligned variant of Text_RGBA().

See also

Font_DrawText_RGBA

Text()

void drawAPI_t::Text	(	vector	vecOrigin,
		string	strText,
		font_s	fnt
	)

Draw text on the screen at the desired position with a desired font.

Parameters

vecOrigin	is the absolute starting position.
strText	is the text to be drawn.
fnt	is the font to be used.

Text_A()

void drawAPI_t::Text_A	(	vector	vecOrigin,
		string	strText,
		float	a,
		font_s	fnt
	)

Draw alpha-blended text on the screen at the desired position with a desired font.

Parameters

vecOrigin	is the absolute starting position.
strText	is the text to be drawn.
a	is the alpha value to blend with.
fnt	is the font to be used.

Text_RGB()

void drawAPI_t::Text_RGB	(	vector	vecOrigin,
		string	strText,
		vector	col,
		font_s	fnt
	)

Draw tinted text on the screen at the desired position with a desired font.

Parameters

vecOrigin	is the absolute starting position.
strText	is the text to be drawn.
col	is the normalized color value to tint the text with.
fnt	is the font to be used.

Text_RGBA()

void drawAPI_t::Text_RGBA	(	vector	vecOrigin,
		string	strText,
		vector	col,
		float	a,
		font_s	fnt
	)

Draw tinted and alpha blended text on the screen at the desired position with a desired font.

Parameters

vecOrigin	is the absolute starting position.
strText	is the text to be drawn.
col	is the normalized color value to tint the text with.
a	is the alpha value to blend with.
fnt	is the font to be used.

TextField()

void drawAPI_t::TextField	(	vector	vecOrigin,
		vector	vecSize,
		string	strText,
		font_s	fnt,
		alignflags_t	iAlignFlags
	)

Draws a textfield with line wrapping.

Parameters

vecOrigin	is the absolute starting position.
vecSize	is the total area in pixels that the field takes up on the screen.
strText	is the text to be drawn onto the screen.
fnt	is the font to be used for rendering the text.
iAlignFlags	sets how the text may be aligned.

TextFieldAtHeight()

void drawAPI_t::TextFieldAtHeight	(	vector	vecOrigin,
		vector	vecSize,
		int	iTextHeight,
		string	strText,
		font_s	fnt,
		alignflags_t	iAlignFlags
	)

Draws a textfield with line wrapping at a custom text height.

Parameters

vecOrigin	is the absolute starting position.
vecSize	is the total area in pixels that the field takes up on the screen.
iTextHeight	is the desired text height in pixels.
strText	is the text to be drawn onto the screen.
fnt	is the font to be used for rendering the text.
iAlignFlags	sets how the text may be aligned.

---

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

• src/client/api_func.h