sfVideoMode Class Reference

#include <VideoMode.hpp>

List of all members.

Public Member Functions

 sfVideoMode ()
 sfVideoMode (unsigned int ModeWidth, unsigned int ModeHeight, unsigned int ModeBpp=32)
bool IsValid () const
bool operator== (const sfVideoMode &Other) const
bool operator!= (const sfVideoMode &Other) const

Static Public Member Functions

static sfVideoMode GetDesktopMode ()
static sfVideoMode GetMode (unsigned int Index)
static unsigned int GetModesCount ()

Public Attributes

unsigned int Width
 Video mode width, in pixels.
unsigned int Height
 Video mode height, in pixels.
unsigned int BitsPerPixel
 Video mode pixel depth, in bits per pixels.


Detailed Description

sfVideoMode defines a video mode (width, height, bpp, frequency) and provides static functions for getting modes supported by the display device

Definition at line 39 of file VideoMode.hpp.


Constructor & Destructor Documentation

sfVideoMode::sfVideoMode (  ) 

Default constructor

Definition at line 65 of file VideoMode.cpp.

Referenced by GetMode().

sfVideoMode::sfVideoMode ( unsigned int  ModeWidth,
unsigned int  ModeHeight,
unsigned int  ModeBpp = 32 
)

Construct the video mode with its attributes

Parameters:
ModeWidth : Width in pixels
ModeHeight : Height in pixels
ModeBpp : Pixel depths in bits per pixel (32 by default)

Definition at line 77 of file VideoMode.cpp.


Member Function Documentation

sfVideoMode sfVideoMode::GetDesktopMode (  )  [static]

Get the current desktop video mode

Returns:
Current desktop video mode

Definition at line 89 of file VideoMode.cpp.

sfVideoMode sfVideoMode::GetMode ( unsigned int  Index  )  [static]

Get a valid video mode Index must be in range [0, GetModesCount()[ Modes are sorted from best to worst

Parameters:
Index : Index of video mode to get
Returns:
Corresponding video mode (invalid mode if index is out of range)

Definition at line 100 of file VideoMode.cpp.

References GetModesCount(), and sfVideoMode().

Referenced by sfWindow::Create().

unsigned int sfVideoMode::GetModesCount (  )  [static]

Get valid video modes count

Returns:
Number of valid video modes available

Definition at line 115 of file VideoMode.cpp.

Referenced by GetMode().

bool sfVideoMode::IsValid (  )  const

Tell whether or not the video mode is supported

Returns:
True if video mode is supported, false otherwise

Definition at line 127 of file VideoMode.cpp.

Referenced by sfWindow::Create().

bool sfVideoMode::operator== ( const sfVideoMode Other  )  const

Comparison operator overload -- tell if two video modes are equal

Parameters:
Other : Video mode to compare
Returns:
True if modes are equal

Definition at line 139 of file VideoMode.cpp.

References BitsPerPixel, Height, and Width.

bool sfVideoMode::operator!= ( const sfVideoMode Other  )  const

Comparison operator overload -- tell if two video modes are different

Parameters:
Other : Video mode to compare
Returns:
True if modes are different

Definition at line 150 of file VideoMode.cpp.


The documentation for this class was generated from the following files:
Generated for SFML by  doxygen 1.5.2