Public Member Functions | Friends

sp::SoftPixelDeviceWin32 Class Reference

SoftPixelDevice class for the Microsoft(c) Windows(c) platform. More...

#include <spSoftPixelDeviceWindows.hpp>

Inheritance diagram for sp::SoftPixelDeviceWin32:
sp::SoftPixelDevice

List of all members.

Public Member Functions

 SoftPixelDeviceWin32 (const video::ERenderSystems RendererType, const dim::size2di &Resolution, s32 ColorDepth, const io::stringc &Title, bool isFullscreen, const SDeviceFlags &Flags, void *ParentWindow)
 ~SoftPixelDeviceWin32 ()
virtual bool updateDeviceSettings (const dim::size2di &Resolution, s32 ColorDepth=DEF_COLORDEPTH, bool isFullscreen=false, const SDeviceFlags &Flags=SDeviceFlags(), void *ParentWindow=0)
bool updateEvents ()
void beep (u32 Milliseconds=100, u32 Frequency=1000)
 Occurs a beep sound with the specified frequency and for the spcified duration.
s32 registerFontResource (const io::stringc &Filename)
void unregisterFontResource (const io::stringc &Filename)
 Unregisters the specifies font resource file.
io::stringc getDropFilename ()

Friends

SP_EXPORT LRESULT CALLBACK SpWin32Callback (HWND hWnd, UINT Message, WPARAM wParam, LPARAM lParam)

Detailed Description

SoftPixelDevice class for the Microsoft(c) Windows(c) platform.


Constructor & Destructor Documentation

sp::SoftPixelDeviceWin32::SoftPixelDeviceWin32 ( const video::ERenderSystems  RendererType,
const dim::size2di Resolution,
s32  ColorDepth,
const io::stringc Title,
bool  isFullscreen,
const SDeviceFlags Flags,
void *  ParentWindow 
)
sp::SoftPixelDeviceWin32::~SoftPixelDeviceWin32 (  ) 

Member Function Documentation

void sp::SoftPixelDeviceWin32::beep ( u32  Milliseconds = 100,
u32  Frequency = 1000 
) [virtual]

Occurs a beep sound with the specified frequency and for the spcified duration.

Reimplemented from sp::SoftPixelDevice.

io::stringc sp::SoftPixelDeviceWin32::getDropFilename (  ) 
s32 sp::SoftPixelDeviceWin32::registerFontResource ( const io::stringc Filename  )  [virtual]

Registers a new font resource file. This is currently only supported on MS/Windows.

Parameters:
Filename,: Specifies the filename for the font resource which is to be registerd. On MS/Windows this should be a TTF (TrueType Font) file.
Returns:
Number of fonts added to the system.

Reimplemented from sp::SoftPixelDevice.

void sp::SoftPixelDeviceWin32::unregisterFontResource ( const io::stringc Filename  )  [virtual]

Unregisters the specifies font resource file.

Reimplemented from sp::SoftPixelDevice.

virtual bool sp::SoftPixelDeviceWin32::updateDeviceSettings ( const dim::size2di Resolution,
s32  ColorDepth = DEF_COLORDEPTH,
bool  isFullscreen = false,
const SDeviceFlags Flags = SDeviceFlags(),
void *  ParentWindow = 0 
) [virtual]

Updates the device settings. This recreated the main window, device- and render context. If any settings has changed all resources will automatically updated. If you want to change the render system you need to delete the device, create a new one and load all resources again. This feature is only supported on desktop platforms like Windows and Linux.

Parameters:
Resolution,: Specifies the new device resolution.
ColorDepth,: Specifies the new color depth (in bits). By default 32.
isFullscreen,: Specifies whether the new device is to be in window mode or fullscreen.
Flags,: Specifies the new devices flags.
ParentWindow,: Specifies the new parent window. On Windows this must be a pointer to a HWND instance.
Returns:
True on success otherwise false.
Deprecated:

Reimplemented from sp::SoftPixelDevice.

bool sp::SoftPixelDeviceWin32::updateEvents (  )  [virtual]

Updates all window events. This functions needs to be called every frame. Typically in the main "while" loop. It will update the input states (keyboard, mouse etc.), window callback function on a MS/Windows platform, and some other global state functionality..

Returns:
False if the user clicked the close button in the window title bar. Otherwise true.

Implements sp::SoftPixelDevice.


Friends And Related Function Documentation

SP_EXPORT LRESULT CALLBACK SpWin32Callback ( HWND  hWnd,
UINT  Message,
WPARAM  wParam,
LPARAM  lParam 
) [friend]

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines