fs::rap::SurfCl_t Class Reference

#include <fsSurfCl.h>

Inheritance diagram for fs::rap::SurfCl_t:

Inheritance graph
[legend]
Collaboration diagram for fs::rap::SurfCl_t:

Collaboration graph
[legend]
List of all members.

Detailed Description

WinApp_t nested bitmap surface client (incomplete).

The class represents a bitmap surface. It is typically used as a target for all sorts of bitmap and drawing operations. The class is closely related to WinApp_t. It implements WinApp_t::EvRcvr_i interface so it can be registered as an event receiver of WinApp_t, it acts as its nested client.

fs_rap_SurfCl_t_01.png
Examples:

_tests/fsSurfCl/main.cpp.

Definition at line 34 of file fsSurfCl.h.

Public Member Functions

 SurfCl_t (bool bFitCl=false, int nSurfW=512, int nSurfH=512)
 Creates surface data using the given parameters.
virtual ~SurfCl_t ()
 Destroys surface data.
void Clear (const PxFmt8888_t &Clr)
 Clears the surface with the given color.
int GetW () const
 Returns the width of the surface.
int GetH () const
 Returns the height of the surface.
PxFmt8888_tGetData ()
 Returns the surface data.
virtual void OnEvent (const WinApp_t::SizeEv_t &, WinApp_t &)
virtual void OnEvent (const WinApp_t::DrawEv_t &, WinApp_t &)

Private Member Functions

 SurfCl_t (const SurfCl_t &)
 No copy.
SurfCl_toperator= (const SurfCl_t &)
 No assignment.

Private Attributes

void * m_pImpl
 The PIPML idiom is used.

Classes

struct  PxFmt8888_t
 Surface pixel format. More...


Constructor & Destructor Documentation

SurfCl_t::SurfCl_t ( bool  bFitCl = false,
int  nSurfW = 512,
int  nSurfH = 512 
) [explicit]

Creates surface data using the given parameters.

Parameters:
bFitCl Specifies whether the surface should fit the client area during resizing of the window.
nSurfW Initial width of the surface ( >= 0).
nSurfH Initial height of the surface ( >= 0).

Definition at line 217 of file fsSurfCl.cpp.

References FS_ASSERT_MSG, and m_pImpl.

SurfCl_t::~SurfCl_t (  )  [virtual]

Destroys surface data.

Definition at line 223 of file fsSurfCl.cpp.

References FS_ASSERT_MSG, and m_pImpl.

fs::rap::SurfCl_t::SurfCl_t ( const SurfCl_t  )  [private]

No copy.


Member Function Documentation

void SurfCl_t::Clear ( const PxFmt8888_t Clr  ) 

Clears the surface with the given color.

Definition at line 229 of file fsSurfCl.cpp.

References FS_ASSERT_MSG, and m_pImpl.

SurfCl_t::PxFmt8888_t * SurfCl_t::GetData (  ) 

Returns the surface data.

Examples:
_tests/fsSurfCl/main.cpp.

Definition at line 247 of file fsSurfCl.cpp.

References FS_ASSERT_MSG, and m_pImpl.

int SurfCl_t::GetH (  )  const

Returns the height of the surface.

Examples:
_tests/fsSurfCl/main.cpp.

Definition at line 241 of file fsSurfCl.cpp.

References FS_ASSERT_MSG, and m_pImpl.

int SurfCl_t::GetW (  )  const

Returns the width of the surface.

Examples:
_tests/fsSurfCl/main.cpp.

Definition at line 235 of file fsSurfCl.cpp.

References FS_ASSERT_MSG, and m_pImpl.

void SurfCl_t::OnEvent ( const WinApp_t::DrawEv_t ,
WinApp_t  
) [virtual]

Reimplemented from fs::rap::WinApp_t::EvRcvr_i.

Definition at line 259 of file fsSurfCl.cpp.

References FS_ASSERT_MSG, and m_pImpl.

void SurfCl_t::OnEvent ( const WinApp_t::SizeEv_t ,
WinApp_t  
) [virtual]

Reimplemented from fs::rap::WinApp_t::EvRcvr_i.

Definition at line 253 of file fsSurfCl.cpp.

References FS_ASSERT_MSG, and m_pImpl.

SurfCl_t& fs::rap::SurfCl_t::operator= ( const SurfCl_t  )  [private]

No assignment.


Member Data Documentation

void* fs::rap::SurfCl_t::m_pImpl [private]

The PIPML idiom is used.

Definition at line 64 of file fsSurfCl.h.


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

FipS' Code (Thu Feb 15 22:43:50 2007) - (c) Filip STOKLAS (FipS) - [ www ] [ Guest Book ]