Duckcpp 2.1.0
Duckcpp is a high-performance c++ graphics engine.
Loading...
Searching...
No Matches
dcpp::video::IVideoModeList Class Referenceabstract

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

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

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

Public Member Functions

virtual dcpp::int32_kt getVideoModeCount () const =0
 Gets amount of video modes in the list.
 
virtual dcpp::nub::dimension2du getVideoModeResolution (dcpp::int32_kt modeNumber) const =0
 Get the screen size of a video mode in pixels.
 
virtual dcpp::nub::dimension2du getVideoModeResolution (const dcpp::nub::dimension2du &minSize, const dcpp::nub::dimension2du &maxSize) const =0
 Get a supported screen size with certain constraints.
 
virtual dcpp::int32_kt getVideoModeDepth (dcpp::int32_kt modeNumber) const =0
 Get the pixel depth of a video mode in bits.
 
virtual const dcpp::nub::dimension2dugetDesktopResolution () const =0
 Get current desktop screen resolution.
 
virtual dcpp::int32_kt 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.
 
dcpp::int32_kt getReferenceCount () const
 Get the reference count.
 
const dcpp::char_ktgetDebugName () const
 Returns the debug name of the object.
 

Additional Inherited Members

- Protected Member Functions inherited from dcpp::IReferenceCounted
void setDebugName (const dcpp::char_kt *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 dcpp::int32_kt 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 dcpp::nub::dimension2du & 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 dcpp::int32_kt dcpp::video::IVideoModeList::getVideoModeCount ( ) const
pure virtual

Gets amount of video modes in the list.

Returns
Returns amount of video modes.

◆ getVideoModeDepth()

virtual dcpp::int32_kt dcpp::video::IVideoModeList::getVideoModeDepth ( dcpp::int32_kt  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 dcpp::nub::dimension2du dcpp::video::IVideoModeList::getVideoModeResolution ( const dcpp::nub::dimension2du minSize,
const dcpp::nub::dimension2du 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 dcpp::nub::dimension2du dcpp::video::IVideoModeList::getVideoModeResolution ( dcpp::int32_kt  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:

Duckcpp    @cppfx.xyz