This stores all the basic configuration options a game window supports. More...

#include <resolution.h>

Public Member Functions
	Resolution ()
	Blank constructor.

	Resolution (const Whole ResWidth, const Whole ResHeight)
	Descriptive constructor. More...

	~Resolution ()
	Class destructor.

String	GetAsString () const
	Converts the values of this Resolution to a human readable string. More...

Boole	operator!= (const Resolution &Other) const
	Inequality comparison operator. More...

Boole	operator< (const Resolution &Other) const
	Less-than operator. More...

Resolution &	operator= (const Resolution &Other)
	Assignment operator. More...

Boole	operator== (const Resolution &Other) const
	Equality comparison operator. More...

Boole	operator> (const Resolution &Other) const
	Greater-than operator. More...

void	ProtoDeSerialize (const XML::Node &SelfRoot)
	Take the data stored in an XML Node and overwrite this object with it. More...

void	ProtoSerialize (XML::Node &ParentNode) const
	Convert this class to an XML::Node ready for serialization. More...

void	SetResolution (const Whole ResWidth, const Whole ResHeight)
	Sets the width and height of this resolution. More...

Static Public Member Functions
static String	GetSerializableName ()
	Get the name of the the XML tag the class will leave behind as its instances are serialized. More...

Public Attributes
Whole	Height
	The pixel height of the window.

Whole	Width
	The pixel width of the window.

Detailed Description

This stores all the basic configuration options a game window supports.

Definition at line 57 of file resolution.h.

Constructor & Destructor Documentation

Mezzanine::Graphics::Resolution::Resolution	(	const Whole	ResWidth,
		const Whole	ResHeight
	)

inline

Descriptive constructor.

Parameters

ResWidth	The pixel width of the window.
ResHeight	The pixel height of the window.

Definition at line 80 of file resolution.h.

Member Function Documentation

String Mezzanine::Graphics::Resolution::GetAsString ( ) const

inline

Converts the values of this Resolution to a human readable string.

Remarks: The format for the presented string is "[Width]x[Height]". For example: "1024x768".

Returns: Returns a string containing the width and height of this resolution.

Definition at line 104 of file resolution.h.

static String Mezzanine::Graphics::Resolution::GetSerializableName ( )

inlinestatic

Get the name of the the XML tag the class will leave behind as its instances are serialized.

Returns: A string containing the name of this class.

Definition at line 202 of file resolution.h.

Boole Mezzanine::Graphics::Resolution::operator!= ( const Resolution & Other ) const

inline

Inequality comparison operator.

Parameters

Other The other Resolution to compare with.

Returns: Returns true if this Resolution is not equal to the other Resolution, false otherwise.

Definition at line 134 of file resolution.h.

Boole Mezzanine::Graphics::Resolution::operator< ( const Resolution & Other ) const

inline

Less-than operator.

Parameters

Other The other Resolution to compare with.

Returns: Returns true if this Resolution is smaller than the other Resolution, false otherwise.

Definition at line 141 of file resolution.h.

Resolution& Mezzanine::Graphics::Resolution::operator= ( const Resolution & Other )

inline

Assignment operator.

Parameters

Other The other Resolution to copy from.

Returns: Returns a reference to this.

Definition at line 117 of file resolution.h.

Boole Mezzanine::Graphics::Resolution::operator== ( const Resolution & Other ) const

inline

Equality comparison operator.

Parameters

Other The other Resolution to compare with.

Returns: Returns true if this Resolution is equal to the other Resolution, false otherwise.

Definition at line 127 of file resolution.h.

Boole Mezzanine::Graphics::Resolution::operator> ( const Resolution & Other ) const

inline

Greater-than operator.

Parameters

Other The other Resolution to compare with.

Returns: Returns true if this Resolution is larger than the other Resolution, false otherwise.

Definition at line 152 of file resolution.h.

void Mezzanine::Graphics::Resolution::ProtoDeSerialize ( const XML::Node & SelfRoot )

inline

Take the data stored in an XML Node and overwrite this object with it.

Parameters

SelfRoot An XML::Node containing the data to populate this class with.

Definition at line 181 of file resolution.h.

void Mezzanine::Graphics::Resolution::ProtoSerialize ( XML::Node & ParentNode ) const

inline

Convert this class to an XML::Node ready for serialization.

Parameters

ParentNode The point in the XML hierarchy that all this Resolution should be appended to.

Definition at line 166 of file resolution.h.

void Mezzanine::Graphics::Resolution::SetResolution	(	const Whole	ResWidth,
		const Whole	ResHeight
	)

inline

Sets the width and height of this resolution.

Parameters

ResWidth	The pixel width of the window.
ResHeight	The pixel height of the window.

Definition at line 95 of file resolution.h.

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

/home/sqeaky/Code/MezzanineFresh/Mezzanine/src/Graphics/resolution.h

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation