Main Page | Namespace List | Class Hierarchy | Class List | File List | Namespace Members | Class Members | File Members

CascadeScreenMessage Class Reference

message sent whenever the screen parameters change More...

#include <cascade/graphics/CascadeScreenMessage.h>

List of all members.

Public Types

enum  Type { kScreenResolutionChanged = 0, kOutputResolutionChanged = 1, kOutputScaleRectChanged = 2 }

Static Public Member Functions

static u32 MessageID ()

Public Attributes

Type m_type
u32 m_nIndex
CascadeRect m_rect
u8 m_nBitDepth
CascadeScreen::VideoConnector m_Connector
bool m_bProgressive
bool m_bDoubleBuffered

Detailed Description

message sent whenever the screen parameters change

Skip the description

CascadeScreenMessage is broadcast to all local wormholes whenever the screen parameters are changed.

class CascadeScreenMessage

Member Enumeration Documentation

enum CascadeScreenMessage::Type
 

represents the type of screen message

CascadeScreenMessages contain a member variable (m_type) of this type that indicates whether the screen message applies to the screen resolution (pixel dimensions of the screen for drawing), the output resolution (the resolution being output by the hardware to the display device), or the output scale rect.

See also:
m_type
Enumeration values:
kScreenResolutionChanged  indicates the screen resolution has changed
kOutputResolutionChanged  indicates the screen output resolution has changed
kOutputScaleRectChanged  indicates the screen output scale rect has changed

Member Function Documentation

static u32 CascadeScreenMessage::MessageID (   )  [static]
 

returns the messageID of the CascadeScreenMessage

MessageID() is used to determine if a wormhole message is a CascadeScreenMessage Use it as follows: 

        CascadeMessage * pMessage = wormhole.WaitForMessage();
        if ((NULL != pMessage) && (pMessage->ID() == CascadeScreenMessage::MessageID()))
        {
            // we have a screen message 
        }
Returns:
the messageID of the CascadeScreenMessage

Member Data Documentation

bool CascadeScreenMessage::m_bDoubleBuffered
 

whether or not the screen is now double buffered

m_bDoubleBuffered indicates whether or not the screen is now double buffered.

Note:
m_bDoubleBuffered is only valid if (m_type == kScreenResolutionChanged)

bool CascadeScreenMessage::m_bProgressive
 

whether or not the screen is now progressive scan

m_bProgressive indicates whether or not the screen is now progressive scan.

Note:
m_bProgressive is only valid if (m_type == kOutputResolutionChanged)

CascadeScreen::VideoConnector CascadeScreenMessage::m_Connector
 

the new connector of the output

m_Connector contains the new connector of the output

u8 CascadeScreenMessage::m_nBitDepth
 

the new bit depth of the screen

m_nBitDepth contains the new bit depth of the screen

u32 CascadeScreenMessage::m_nIndex
 

the index of the screen/output resolution

m_nIndex contains the new index of the screen/output resolution if m_type refers to a screen resolution or output resolution change

See also:
Type

CascadeRect CascadeScreenMessage::m_rect
 

the new rect that describes the change in placement or dimensions

m_rect contains the new rect which describes the new screen resolution, output resolution, or scale rect. In the case of a new screen resolution, or output resolution, the x and y coordinates of m_rect will be zero.

Type CascadeScreenMessage::m_type
 

the type of the screen message

m_type contains the type of the screen message the index of the screen

The documentation for this class was generated from the following file:
Generated on Sun Jul 24 14:27:20 2005 for Cascade Library by  doxygen 1.4.1