dcpp::video::IVideoModeList Class Reference

A list of all available video modes. More...

#include <duckcpp/core/engine/IVideoModeList.hpp>

Inheritance diagram for dcpp::video::IVideoModeList:

Collaboration diagram for dcpp::video::IVideoModeList:

Public Member Functions
virtual i32	getVideoModeCount () const =0
	Gets amount of video modes in the list.
virtual nub::dimension2d< u32 >	getVideoModeResolution (i32 modeNumber) const =0
	Get the screen size of a video mode in pixels.
virtual nub::dimension2d< u32 >	getVideoModeResolution (const nub::dimension2d< u32 > &minSize, const nub::dimension2d< u32 > &maxSize) const =0
	Get a supported screen size with certain constraints.
virtual i32	getVideoModeDepth (i32 modeNumber) const =0
	Get the pixel depth of a video mode in bits.
virtual const nub::dimension2d< u32 > &	getDesktopResolution () const =0
	Get current desktop screen resolution.
virtual i32	getDesktopDepth () const =0
	Get the pixel depth of a video mode in bits.
Public Member Functions inherited from dcpp::IReferenceCounted
	IReferenceCounted ()
	Constructor.
virtual	~IReferenceCounted ()
	Destructor.
void	grab () const
	Grabs the object. Increments the reference counter by one.
bool	drop () const
	Drops the object. Decrements the reference counter by one.
i32	getReferenceCount () const
	Get the reference count.
const c8 *	getDebugName () const
	Returns the debug name of the object.

Additional Inherited Members
Protected Member Functions inherited from dcpp::IReferenceCounted
void	setDebugName (const c8 *newName)
	Sets the debug name of the object.

Detailed Description

A list of all available video modes.

You can get a list via DuckcppDevice::getVideoModeList(). You only need the null device (EDT_NULL) to get the video-modes.

Member Function Documentation

getDesktopDepth()

virtual i32 dcpp::video::IVideoModeList::getDesktopDepth ( ) const

pure virtual

Get the pixel depth of a video mode in bits.

Returns

Size of each pixel of the current desktop video mode in bits.

getDesktopResolution()

virtual const nub::dimension2d< u32 > & dcpp::video::IVideoModeList::getDesktopResolution ( ) const

pure virtual

Get current desktop screen resolution.

Returns

Size of screen in pixels of the current desktop video mode.

getVideoModeCount()

virtual i32 dcpp::video::IVideoModeList::getVideoModeCount ( ) const

pure virtual

Gets amount of video modes in the list.

Returns

Returns amount of video modes.

getVideoModeDepth()

virtual i32 dcpp::video::IVideoModeList::getVideoModeDepth ( i32  modeNumber ) const

pure virtual

Get the pixel depth of a video mode in bits.

Parameters

modeNumber

zero based index of the video mode.

Returns

Size of each pixel of the specified video mode in bits.

getVideoModeResolution() [1/2]

virtual nub::dimension2d< u32 > dcpp::video::IVideoModeList::getVideoModeResolution ( const nub::dimension2d< u32 > &  minSize, const nub::dimension2d< u32 > &  maxSize  ) const

pure virtual

Get a supported screen size with certain constraints.

Parameters

minSize	Minimum dimensions required.
maxSize	Maximum dimensions allowed.

Returns

Size of screen in pixels which matches the requirements. as good as possible.

getVideoModeResolution() [2/2]

virtual nub::dimension2d< u32 > dcpp::video::IVideoModeList::getVideoModeResolution ( i32  modeNumber ) const

pure virtual

Get the screen size of a video mode in pixels.

Parameters

modeNumber

zero based index of the video mode.

Returns

Size of screen in pixels of the specified video mode.

---

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

• include/duckcpp/core/engine/IVideoModeList.hpp