Burger::DisplayDirectX9::AdapterInfo Class Reference

Information for a display device. More...

Collaboration diagram for Burger::DisplayDirectX9::AdapterInfo:

Public Member Functions
	AdapterInfo (uint_t uAdapterOrdinal)
	Create a default AdapterInfo.
	~AdapterInfo ()
	Dispose of an AdapterInfo class.
const _D3DADAPTER_IDENTIFIER9 *	GetAdapterIdentifier (void) const
	Get pointer to D3DADAPTER_IDENTIFIER9 record for this adapter.
uint_t	GetAdapterOrdinal (void) const
	Get ordinal index for the adapter this class describes.
uintptr_t	GetDisplayModeListSize (void) const
	Get number of entries in the display mode list.
const DisplayMode_t *	GetDisplayModeList (void) const
	Get the pointer to the base of the DisplayMode_t array.
void	AddToList (const DisplayMode_t *pDisplayMode)
	Add a copy of a DisplayMode_t to the end of the list.
uintptr_t	GetDisplayInfoListSize (void) const
	Get number of entries in the display info list.
DeviceInfo *const *	GetDisplayInfoList (void) const
	Get the pointer to the base of the DeviceInfo * array.
void	AddToList (DeviceInfo *pDisplayInfo)
	Add a DeviceInfo * to the end of the list.
const DeviceInfo *	Find (uint_t uDeviceType) const
	Find a DeviceInfo * in the list.

Private Attributes
SimpleArray< DisplayMode_t >	m_DisplayModeList
	Array of display modes.
SimpleArray< DeviceInfo * >	m_DeviceInfoList
	Array of DeviceInfo* with pixel formats supported for rendering.
uint32_t	m_AdapterIdentifier [276]
	D3DADAPTER_IDENTIFIER9 record.
uint_t	m_uAdapterOrdinal
	DirectX 9 ordinal value for this device.

Detailed Description

Information for a display device.

---

For each display device, this class contains a list of every supported pixel resolution and a array of DeviceInfo classes describing every GPU/software renderer that is attached to it. Contained in this class is a copy of the D3DADAPTER_IDENTIFIER9 structure obtained from the adapter.

https://msdn.microsoft.com/en-us/library/windows/desktop/bb172505(v=vs.85).aspx

See also

DeviceInfo or BufferFormatGroup

Constructor & Destructor Documentation

AdapterInfo()

Burger::DisplayDirectX9::AdapterInfo::AdapterInfo

(

uint_t

uAdapterOrdinal

)

Create a default AdapterInfo.

---

All lists are empty on creation

Parameters

uAdapterOrdinal

Adapter ordinal index

~AdapterInfo()

Burger::DisplayDirectX9::AdapterInfo::~AdapterInfo

(

)

Dispose of an AdapterInfo class.

---

Member Function Documentation

AddToList() [1/2]

void BURGER_API Burger::DisplayDirectX9::AdapterInfo::AddToList

(

const DisplayMode_t *

pDisplayMode

)

Add a copy of a DisplayMode_t to the end of the list.

---

Make a copy of the passed DisplayMode_t and append the copy to the end of the array contained in this class.

Note

This is only available on Windows

Parameters

pDisplayMode

Pointer to the DisplayMode_t to copy.

AddToList() [2/2]

void BURGER_API Burger::DisplayDirectX9::AdapterInfo::AddToList

(

DeviceInfo *

pDisplayInfo

)

Add a DeviceInfo * to the end of the list.

---

Append a pointer to the DeviceInfo pointer array. This class takes ownership of the pointer and will dispose of it when the class is destructed.

Note

This is only available on Windows

Parameters

pDisplayInfo

Pointer to the DeviceInfo to take ownership and append to the pointer array.

Find()

const Burger::DisplayDirectX9::DeviceInfo *BURGER_API Burger::DisplayDirectX9::AdapterInfo::Find

(

uint_t

uDeviceType

)

const

Find a DeviceInfo * in the list.

---

Iterate over the DeviceInfo pointer array and return the entry that matches the passed device type.

Note

This is only available on Windows

Parameters

uDeviceType

Type of device to locate

Returns

Pointer to the located DeviceInfo or nullptr if not found.

GetAdapterIdentifier()

const _D3DADAPTER_IDENTIFIER9 * Burger::DisplayDirectX9::AdapterInfo::GetAdapterIdentifier ( void ) const

inline

Get pointer to D3DADAPTER_IDENTIFIER9 record for this adapter.

---

Note

This is only available on Windows

Returns

Pointer to the contained D3DADAPTER_IDENTIFIER9 structure

GetAdapterOrdinal()

uint_t Burger::DisplayDirectX9::AdapterInfo::GetAdapterOrdinal ( void ) const

inline

Get ordinal index for the adapter this class describes.

---

Note

This is only available on Windows

Returns

Adapter ordinal index

GetDisplayInfoList()

const DeviceInfo * Burger::DisplayDirectX9::AdapterInfo::GetDisplayInfoList ( void ) const

inline

Get the pointer to the base of the DeviceInfo * array.

---

Note

This is only available on Windows

Returns

Pointer to the DeviceInfo * array, it can be nullptr if the array is empty.

See also

GetDisplayInfoListSize(void) const

GetDisplayInfoListSize()

uintptr_t Burger::DisplayDirectX9::AdapterInfo::GetDisplayInfoListSize ( void ) const

inline

Get number of entries in the display info list.

---

Note

This is only available on Windows

Returns

Number of entries in the display info list, zero means the list is empty.

See also

GetDisplayInfoList(void) const

GetDisplayModeList()

const DisplayMode_t * Burger::DisplayDirectX9::AdapterInfo::GetDisplayModeList ( void ) const

inline

Get the pointer to the base of the DisplayMode_t array.

---

Note

This is only available on Windows

Returns

Pointer to the DisplayMode_t array, it can be nullptr if the array is empty.

See also

GetDisplayModeListSize(void) const

GetDisplayModeListSize()

uintptr_t Burger::DisplayDirectX9::AdapterInfo::GetDisplayModeListSize ( void ) const

inline

Get number of entries in the display mode list.

---

Note

This is only available on Windows

Returns

Number of entries in the display mode list, zero means the list is empty.

See also

GetDisplayModeList(void) const

Member Data Documentation

m_AdapterIdentifier

uint32_t Burger::DisplayDirectX9::AdapterInfo::m_AdapterIdentifier[276]

private

D3DADAPTER_IDENTIFIER9 record.

m_DeviceInfoList

SimpleArray<DeviceInfo*> Burger::DisplayDirectX9::AdapterInfo::m_DeviceInfoList

private

Array of DeviceInfo* with pixel formats supported for rendering.

m_DisplayModeList

SimpleArray<DisplayMode_t> Burger::DisplayDirectX9::AdapterInfo::m_DisplayModeList

private

Array of display modes.

m_uAdapterOrdinal

uint_t Burger::DisplayDirectX9::AdapterInfo::m_uAdapterOrdinal

private

DirectX 9 ordinal value for this device.