Burger::DisplayDirectX9::DeviceInfo Class Reference

Information for a GPU device. More...

Collaboration diagram for Burger::DisplayDirectX9::DeviceInfo:

Public Member Functions
	DeviceInfo (uint_t uAdapterOrdinal, uint_t uDeviceType)
	Create a default DeviceInfo.
	~DeviceInfo ()
	Dispose of a DeviceInfo.
uint_t	GetAdapterOrdinal (void) const
	Get the adapter ordinal.
uint_t	GetDeviceType (void) const
	Get the adapter device type.
const _D3DCAPS9 *	GetCaps (void) const
	Obtain a pointer to the contained D3DCAPS9 structure.
uintptr_t	GetBufferListSize (void) const
	Get number of BufferFormatGroup entries stored in this class.
BufferFormatGroup *const *	GetBufferList (void) const
	Get the pointer to the base of the BufferFormatGroup * array.
void	AddToList (BufferFormatGroup *pBufferFormatGroup)
	Add a BufferFormatGroup * to the list.
const BufferFormatGroup *	Find (uint_t uAdapterFormat, uint_t uBackBufferFormat, uint_t bWindowed) const
	Search for a BufferFormatGroup.

Private Attributes
uint_t	m_uAdapterOrdinal
	Device ordinal type.
uint_t	m_uDeviceType
	D3DDEVTYPE.
uint32_t	m_D3DCaps [76]
	D3DCAPS9 record.
SimpleArray< BufferFormatGroup * >	m_BufferFormatList
	All of the settings for this device.

Detailed Description

Information for a GPU device.

---

For each rendering device, this class contains a list of every supported pixel format for rendering. Devices are hardware, software, or reference. A copy of the D3DCAPS9 for the rendering device is also stored in this class

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

See also

BufferFormatGroup or AdapterInfo

Constructor & Destructor Documentation

DeviceInfo()

Burger::DisplayDirectX9::DeviceInfo::DeviceInfo	(	uint_t	uAdapterOrdinal,
		uint_t	uDeviceType )

Create a default DeviceInfo.

---

Zero out the D3DCAPS9 record and the list and set the description defaults to the passed in values.

Parameters

uAdapterOrdinal	Ordinal value for this adapter from DirectX 9
uDeviceType	Device type of adapter (Hardware/Software)

~DeviceInfo()

Burger::DisplayDirectX9::DeviceInfo::~DeviceInfo

(

)

Dispose of a DeviceInfo.

---

All BufferFormatGroup pointers added to this class are disposed of in the destructor.

Member Function Documentation

AddToList()

void BURGER_API Burger::DisplayDirectX9::DeviceInfo::AddToList

(

BufferFormatGroup *

pBufferFormatGroup

)

Add a BufferFormatGroup * to the list.

---

Add the passed in pointer to the end of an internal list of entries that belong to this adapter.

Parameters

pBufferFormatGroup

A pointer to a BufferFormatGroup * entry

Find()

const Burger::DisplayDirectX9::BufferFormatGroup *BURGER_API Burger::DisplayDirectX9::DeviceInfo::Find	(	uint_t	uAdapterFormat,
		uint_t	uBackBufferFormat,
		uint_t	bWindowed ) const

Search for a BufferFormatGroup.

---

Given an adapter driver format, a back buffer format and if it's windowed, locate the BufferFormatGroup that matches the criteria.

Parameters

uAdapterFormat	Hardware/Software format
uBackBufferFormat	D3DFORMAT of the back buffer
bWindowed	TRUE if in a window, FALSE if full screen.

Returns

A pointer to a BufferFormatGroup * entry or NULL if not found

GetAdapterOrdinal()

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

inline

Get the adapter ordinal.

---

const

\return The adapter ordinal for which adapter this class is describing.

GetBufferList()

BufferFormatGroup *const * Burger::DisplayDirectX9::DeviceInfo::GetBufferList ( void ) const

inline

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

---

Returns

A pointer to an array of BufferFormatGroup * entries

See also

GetBufferListSize(void) const

GetBufferListSize()

uintptr_t Burger::DisplayDirectX9::DeviceInfo::GetBufferListSize ( void ) const

inline

Get number of BufferFormatGroup entries stored in this class.

---

Returns

The size of the BufferFormatGroup list in entries.

See also

GetBufferList(void) const

GetCaps()

const _D3DCAPS9 * Burger::DisplayDirectX9::DeviceInfo::GetCaps ( void ) const

inline

Obtain a pointer to the contained D3DCAPS9 structure.

---

Use this accessor to query the D3DCAPS9 for this specific rendering device.

Note

This is a read-only pointer by design. The contents are managed internally.

Returns

Read-only pointer to the D3DCAP9 data in this structure.

GetDeviceType()

uint_t Burger::DisplayDirectX9::DeviceInfo::GetDeviceType ( void ) const

inline

Get the adapter device type.

---

Returns

The adapter device type for which adapter this class is describing.

Member Data Documentation

m_BufferFormatList

SimpleArray<BufferFormatGroup*> Burger::DisplayDirectX9::DeviceInfo::m_BufferFormatList

private

All of the settings for this device.

m_D3DCaps

uint32_t Burger::DisplayDirectX9::DeviceInfo::m_D3DCaps[76]

private

D3DCAPS9 record.

m_uAdapterOrdinal

uint_t Burger::DisplayDirectX9::DeviceInfo::m_uAdapterOrdinal

private

Device ordinal type.

m_uDeviceType

uint_t Burger::DisplayDirectX9::DeviceInfo::m_uDeviceType

private

D3DDEVTYPE.