hoa_video::private_video::Context Class Reference

Retains the current graphics context. More...

#include <context.h>

Collaboration diagram for hoa_video::private_video::Context:

Collaboration graph
[legend]
List of all members.

Public Attributes

int8 blend
 Flag to indicate whether normal alpha blending is to take place.
CoordSys coordinate_system
 The coordinate system being used by this context.
std::string font
 The current font being used by this context.
ScreenRect scissor_rectangle
 A rectangle to define which portions of the viewport should be cut away when drawing.
bool scissoring_enabled
 Used to enable or disable the scissoring rectangle.
Color text_color
 The current font color being used by this context.
ScreenRect viewport
 Defines the screen subset to draw the graphics into.
int8 x_align
 Draw alignment flags to determine where an element is drawn relative to the cursor.
int8 x_flip
 Draw flip flags to determine if an element should be drawn flipped across an axis.
int8 y_align
int8 y_flip

Detailed Description

Retains the current graphics context.

****************************************************************************

The Context class holds the current state of the video engine. This is used so that the context can be pushed and popped, so that a function which changes a lot of internal settings can easily leave the video engine in the same state that it waswhen it entered in. The graphics context includes properties such as draw flags, axis transformations, and the current coordinate system. The context must be pushed and then popped by any method of the GameVideo class which modifies this context.

Note:
Transformations are actually handled separately by the OpenGL transformation stack

Definition at line 44 of file context.h.


Member Data Documentation

int8 hoa_video::private_video::Context::blend

Flag to indicate whether normal alpha blending is to take place.

Definition at line 47 of file context.h.

Referenced by hoa_video::GameVideo::_PopContext(), and hoa_video::GameVideo::_PushContext().

CoordSys hoa_video::private_video::Context::coordinate_system

The coordinate system being used by this context.

Definition at line 56 of file context.h.

Referenced by hoa_video::GameVideo::_PopContext(), and hoa_video::GameVideo::_PushContext().

std::string hoa_video::private_video::Context::font

The current font being used by this context.

Definition at line 59 of file context.h.

Referenced by hoa_video::GameVideo::_PopContext(), and hoa_video::GameVideo::_PushContext().

ScreenRect hoa_video::private_video::Context::scissor_rectangle

A rectangle to define which portions of the viewport should be cut away when drawing.

Definition at line 68 of file context.h.

Referenced by hoa_video::GameVideo::_PopContext(), and hoa_video::GameVideo::_PushContext().

bool hoa_video::private_video::Context::scissoring_enabled

Used to enable or disable the scissoring rectangle.

Definition at line 71 of file context.h.

Referenced by hoa_video::GameVideo::_PopContext(), and hoa_video::GameVideo::_PushContext().

Color hoa_video::private_video::Context::text_color

The current font color being used by this context.

Definition at line 62 of file context.h.

Referenced by hoa_video::GameVideo::_PopContext(), and hoa_video::GameVideo::_PushContext().

ScreenRect hoa_video::private_video::Context::viewport

Defines the screen subset to draw the graphics into.

Definition at line 65 of file context.h.

Referenced by hoa_video::GameVideo::_PopContext(), and hoa_video::GameVideo::_PushContext().

int8 hoa_video::private_video::Context::x_align

Draw alignment flags to determine where an element is drawn relative to the cursor.

Definition at line 50 of file context.h.

Referenced by hoa_video::GameVideo::_PopContext(), and hoa_video::GameVideo::_PushContext().

int8 hoa_video::private_video::Context::x_flip

Draw flip flags to determine if an element should be drawn flipped across an axis.

Definition at line 53 of file context.h.

Referenced by hoa_video::GameVideo::_PopContext(), and hoa_video::GameVideo::_PushContext().

int8 hoa_video::private_video::Context::y_align

Definition at line 50 of file context.h.

Referenced by hoa_video::GameVideo::_PopContext(), and hoa_video::GameVideo::_PushContext().

int8 hoa_video::private_video::Context::y_flip

Definition at line 53 of file context.h.

Referenced by hoa_video::GameVideo::_PopContext(), and hoa_video::GameVideo::_PushContext().


The documentation for this class was generated from the following file:
Generated on Fri Jul 6 23:16:43 2007 for Hero of Allacrost by  doxygen 1.5.1