LOutputMode Class Reference

Output resolution and refresh rate. More...

Inheritance diagram for LOutputMode:

Public Member Functions
LOutput *	output () const noexcept
	Gets the output associated with this mode. More...
const LSize &	sizeB () const noexcept
	Gets the resolution of the mode. More...
UInt32	refreshRate () const noexcept
	Gets the refresh rate of the mode. More...
bool	isPreferred () const noexcept
	Check if this mode is the preferred mode for the output. More...
void *	data () const noexcept
	Backend data handle. More...

Detailed Description

Output resolution and refresh rate.

The LOutputMode class represents a possible configuration in which an LOutput can operate, specifically the refresh rate and resolution.
Each LOutput has one or more modes which can be accessed from LOutput::modes() and assigned with LOutput::setMode().

Member Function Documentation

output()

LOutput* output ( ) const

inlinenoexcept

Gets the output associated with this mode.

This method retrieves the output to which the mode belongs.

sizeB()

const LSize& sizeB ( ) const

inlinenoexcept

Gets the resolution of the mode.

This method returns the dimensions of the output when using this mode, represented in buffer coordinates.

refreshRate()

UInt32 refreshRate ( ) const

inlinenoexcept

Gets the refresh rate of the mode.

This method returns the refresh rate of the mode in Hertz (Hz) multiplied by 1000.

Returns

The refresh rate of the mode, expressed in Hz * 1000.

isPreferred()

bool isPreferred ( ) const

inlinenoexcept

Check if this mode is the preferred mode for the output.

This method indicates whether the mode is the preferred choice for the output.

Returns

true if this mode is preferred and false otherwise.

data()

void* data ( ) const

inlinenoexcept

Backend data handle.