1 // Copyright (C) 2002-2012 Nikolaus Gebhardt
\r
2 // This file is part of the "Irrlicht Engine".
\r
3 // For conditions of distribution and use, see copyright notice in irrlicht.h
\r
5 #ifndef __IRR_I_VIDEO_MODE_LIST_H_INCLUDED__
\r
6 #define __IRR_I_VIDEO_MODE_LIST_H_INCLUDED__
\r
8 #include "IReferenceCounted.h"
\r
9 #include "dimension2d.h"
\r
16 //! A list of all available video modes.
\r
17 /** You can get a list via IrrlichtDevice::getVideoModeList().
\r
18 You only need the null device (EDT_NULL) to get the video-modes. */
\r
19 class IVideoModeList : public virtual IReferenceCounted
\r
23 //! Gets amount of video modes in the list.
\r
24 /** \return Returns amount of video modes. */
\r
25 virtual s32 getVideoModeCount() const = 0;
\r
27 //! Get the screen size of a video mode in pixels.
\r
28 /** \param modeNumber: zero based index of the video mode.
\r
29 \return Size of screen in pixels of the specified video mode. */
\r
30 virtual core::dimension2d<u32> getVideoModeResolution(s32 modeNumber) const = 0;
\r
32 //! Get a supported screen size with certain constraints.
\r
33 /** \param minSize: Minimum dimensions required.
\r
34 \param maxSize: Maximum dimensions allowed.
\r
35 \return Size of screen in pixels which matches the requirements.
\r
36 as good as possible. */
\r
37 virtual core::dimension2d<u32> getVideoModeResolution(const core::dimension2d<u32>& minSize, const core::dimension2d<u32>& maxSize) const = 0;
\r
39 //! Get the pixel depth of a video mode in bits.
\r
40 /** \param modeNumber: zero based index of the video mode.
\r
41 \return Size of each pixel of the specified video mode in bits. */
\r
42 virtual s32 getVideoModeDepth(s32 modeNumber) const = 0;
\r
44 //! Get current desktop screen resolution.
\r
45 /** \return Size of screen in pixels of the current desktop video mode. */
\r
46 virtual const core::dimension2d<u32>& getDesktopResolution() const = 0;
\r
48 //! Get the pixel depth of a video mode in bits.
\r
49 /** \return Size of each pixel of the current desktop video mode in bits. */
\r
50 virtual s32 getDesktopDepth() const = 0;
\r
53 } // end namespace video
\r
54 } // end namespace irr
\r