Nirtcpp 2.0.0
Nirtcpp is a high-performance c++ graphics engine.
nirt::video::IVideoModeList Class Referenceabstract

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

#include <nirtcpp/IVideoModeList.hpp>

Inheritance diagram for nirt::video::IVideoModeList:
Inheritance graph
Collaboration diagram for nirt::video::IVideoModeList:
Collaboration graph

Public Member Functions

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

Additional Inherited Members

- Protected Member Functions inherited from nirt::IReferenceCounted
void setDebugName (const c8 *newName)
 Sets the debug name of the object. More...
 

Detailed Description

A list of all available video modes.

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

Member Function Documentation

◆ getDesktopDepth()

virtual s32 nirt::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 core::dimension2d< u32 > & nirt::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 s32 nirt::video::IVideoModeList::getVideoModeCount ( ) const
pure virtual

Gets amount of video modes in the list.

Returns
Returns amount of video modes.

◆ getVideoModeDepth()

virtual s32 nirt::video::IVideoModeList::getVideoModeDepth ( s32  modeNumber) const
pure virtual

Get the pixel depth of a video mode in bits.

Parameters
modeNumberzero based index of the video mode.
Returns
Size of each pixel of the specified video mode in bits.

◆ getVideoModeResolution() [1/2]

virtual core::dimension2d< u32 > nirt::video::IVideoModeList::getVideoModeResolution ( const core::dimension2d< u32 > &  minSize,
const core::dimension2d< u32 > &  maxSize 
) const
pure virtual

Get a supported screen size with certain constraints.

Parameters
minSizeMinimum dimensions required.
maxSizeMaximum dimensions allowed.
Returns
Size of screen in pixels which matches the requirements. as good as possible.

◆ getVideoModeResolution() [2/2]

virtual core::dimension2d< u32 > nirt::video::IVideoModeList::getVideoModeResolution ( s32  modeNumber) const
pure virtual

Get the screen size of a video mode in pixels.

Parameters
modeNumberzero 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: