vgui_overlay_helper Struct Reference

A helper class which emulates overlays using an auxiliary buffer. More...

#include <vgui_overlay_helper.h>

List of all members.

Public Member Functions
	vgui_overlay_helper (vgui_adaptor *)
	~vgui_overlay_helper ()
void	post_overlay_redraw ()
bool	dispatch (vgui_event const &e)
Private Member Functions
bool	dispatch_draw (vgui_event const &)
bool	dispatch_other (vgui_event const &)
bool	dispatch_overlay_draw (vgui_event const &)
Private Attributes
vgui_adaptor *	adaptor
bool	aux_buffer_is_back_buffer
bool	last_draw_was_overlay
bool	overlay_redraw_posted

---

Detailed Description

A helper class which emulates overlays using an auxiliary buffer.

The auxiliary buffer may be an OpenGL "aux buffer", the OpenGL back buffer, a Mesa pixmap or some other resource.

To use it, the adaptor must relinquish control of event dispatch to the vgui_overlay_helper using the dispatch method and also call post_overlay_redraw() when an overlay redraw is posted on the adaptor.

Definition at line 23 of file vgui_overlay_helper.h.

---

Constructor & Destructor Documentation

vgui_overlay_helper::vgui_overlay_helper

(

vgui_adaptor *

a

)

Definition at line 22 of file vgui_overlay_helper.cxx.

vgui_overlay_helper::~vgui_overlay_helper

(

)

Definition at line 43 of file vgui_overlay_helper.cxx.

---

Member Function Documentation

bool vgui_overlay_helper::dispatch

(

vgui_event const &

e

)

Definition at line 50 of file vgui_overlay_helper.cxx.

bool vgui_overlay_helper::dispatch_draw

(

vgui_event const &

e

)

[private]

Definition at line 61 of file vgui_overlay_helper.cxx.

bool vgui_overlay_helper::dispatch_other

(

vgui_event const &

e

)

[private]

Definition at line 81 of file vgui_overlay_helper.cxx.

bool vgui_overlay_helper::dispatch_overlay_draw

(

vgui_event const &

e

)

[private]

Definition at line 97 of file vgui_overlay_helper.cxx.

void vgui_overlay_helper::post_overlay_redraw

(

void

)

[inline]

Definition at line 29 of file vgui_overlay_helper.h.

---

Member Data Documentation

vgui_adaptor* vgui_overlay_helper::adaptor [private]

Definition at line 33 of file vgui_overlay_helper.h.

bool vgui_overlay_helper::aux_buffer_is_back_buffer [private]

Definition at line 34 of file vgui_overlay_helper.h.

bool vgui_overlay_helper::last_draw_was_overlay [private]

Definition at line 35 of file vgui_overlay_helper.h.

bool vgui_overlay_helper::overlay_redraw_posted [private]

Definition at line 36 of file vgui_overlay_helper.h.

---

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

• core/vgui/internals/vgui_overlay_helper.h
• core/vgui/internals/vgui_overlay_helper.cxx