Burger::DisplayDirectX9::DeviceSettings_t Struct Reference

Structure to describe the state of a Direct3D9 device. More...

Public Member Functions
void	SetPresentParameters (const _D3DPRESENT_PARAMETERS_ *pInput)
	Convert a D3DPRESENT_PARAMETERS to a DeviceSettings_t.
void	GetPresentParameters (_D3DPRESENT_PARAMETERS_ *pOutput) const
	Convert a DeviceSettings_t to a D3DPRESENT_PARAMETERS.
uint_t	IsMSAASwapChainCreated (void) const
uint_t	IsVSyncEnabled (void) const
	Test if vertical sync is enabled.
void	ApplyDefaults (void)
	Set up the defaults for a DirectX 9 display.

Public Attributes
HWND__ *	m_pDeviceWindow
	Pointer to the device window.
uint_t	m_uAdapterOrdinal
	Video adapter number for which display is used.
uint_t	m_uDeviceType
	D3DDEVTYPE Device type enumeration.
uint_t	m_uAdapterFormat
	D3DFORMAT Pixel format of the adapter.
uint_t	m_uBehaviorFlags
	D3DCREATE_* flags.
uint_t	m_uBackBufferWidth
	Width in pixels of the back buffer.
uint_t	m_uBackBufferHeight
	Height in pixels of the back buffer.
uint_t	m_uBackBufferFormat
	D3DFORMAT Pixel format of the back buffer.
uint_t	m_uBackBufferCount
	Number of back buffers.
uint_t	m_uMultiSampleType
	D3DMULTISAMPLE_TYPE Anti-alias type.
uint_t	m_uMultiSampleQuality
	Quality of the Anti-aliasing.
uint_t	m_uSwapEffect
	D3DSWAPEFFECT Swap effect type.
uint_t	m_uAutoDepthStencilFormat
	D3DFORMAT pixel format for stencil.
uint_t	m_uFlags
	D3DPRESENTFLAG_* Presentation flags.
uint_t	m_uFullScreen_RefreshRateInHz
	Refresh rate for VSync (set to 0 for a window)
uint_t	m_uPresentationInterval
	D3DPRESENT_INTERVAL_* valie.
uint_t	m_bWindowed
	TRUE for window mode
uint_t	m_bEnableAutoDepthStencil
	TRUE if Auto stencil is enabled

Detailed Description

Structure to describe the state of a Direct3D9 device.

---

This is a duplicate of the D3DPRESENT_PARAMETERS structure found in DirectX 9 with some extra data for internal use by DisplayDirectX9 for monitor / adapter selection.

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

@note This is only available on Windows\n

\sa DisplayDirectX9

Member Function Documentation

ApplyDefaults()

void BURGER_API Burger::DisplayDirectX9::DeviceSettings_t::ApplyDefaults

(

void

)

Set up the defaults for a DirectX 9 display.

---

Settings for default are as follows:

• Width 640
• Height 480
• Back buffer 8:8:8 RGB (32 bit with no alpha)
• Default refresh rate
• No Anti-Aliasing
• 24 bit depth buffer
• 8 bit stencil
• Windowed mode
• Focus window (NULL)
• Immediate display mode (No VSync)

GetPresentParameters()

void BURGER_API Burger::DisplayDirectX9::DeviceSettings_t::GetPresentParameters

(

_D3DPRESENT_PARAMETERS_ *

pOutput

)

const

Convert a DeviceSettings_t to a D3DPRESENT_PARAMETERS.

---

Using values in this structure, completely fill in a D3DPRESENT_PARAMETERS structure for use in DirectX 9

Parameters

pOutput

Pointer to a D3DPRESENT_PARAMETERS to fill in

See also

SetPresentParameters(const D3DPRESENT_PARAMETERS *)

IsMSAASwapChainCreated()

uint_t Burger::DisplayDirectX9::DeviceSettings_t::IsMSAASwapChainCreated ( void ) const

inline

IsVSyncEnabled()

uint_t Burger::DisplayDirectX9::DeviceSettings_t::IsVSyncEnabled ( void ) const

inline

Test if vertical sync is enabled.

---

const

\return \ref TRUE if vertical sync is turned on
\sa IsMSAASwapChainCreated(void) const

SetPresentParameters()

void BURGER_API Burger::DisplayDirectX9::DeviceSettings_t::SetPresentParameters

(

const _D3DPRESENT_PARAMETERS_ *

pInput

)

Convert a D3DPRESENT_PARAMETERS to a DeviceSettings_t.

---

Extract all of the values stored in a D3DPRESENT_PARAMETERS structure and copy them into this structure.

Parameters

pInput

Pointer to a D3DPRESENT_PARAMETERS to copy from.

See also

GetPresentParameters(D3DPRESENT_PARAMETERS *) const

Member Data Documentation

m_bEnableAutoDepthStencil

uint_t Burger::DisplayDirectX9::DeviceSettings_t::m_bEnableAutoDepthStencil

TRUE if Auto stencil is enabled

m_bWindowed

uint_t Burger::DisplayDirectX9::DeviceSettings_t::m_bWindowed

TRUE for window mode

m_pDeviceWindow

HWND__* Burger::DisplayDirectX9::DeviceSettings_t::m_pDeviceWindow

Pointer to the device window.

m_uAdapterFormat

uint_t Burger::DisplayDirectX9::DeviceSettings_t::m_uAdapterFormat

D3DFORMAT Pixel format of the adapter.

m_uAdapterOrdinal

uint_t Burger::DisplayDirectX9::DeviceSettings_t::m_uAdapterOrdinal

Video adapter number for which display is used.

m_uAutoDepthStencilFormat

uint_t Burger::DisplayDirectX9::DeviceSettings_t::m_uAutoDepthStencilFormat

D3DFORMAT pixel format for stencil.

m_uBackBufferCount

uint_t Burger::DisplayDirectX9::DeviceSettings_t::m_uBackBufferCount

Number of back buffers.

m_uBackBufferFormat

uint_t Burger::DisplayDirectX9::DeviceSettings_t::m_uBackBufferFormat

D3DFORMAT Pixel format of the back buffer.

m_uBackBufferHeight

uint_t Burger::DisplayDirectX9::DeviceSettings_t::m_uBackBufferHeight

Height in pixels of the back buffer.

m_uBackBufferWidth

uint_t Burger::DisplayDirectX9::DeviceSettings_t::m_uBackBufferWidth

Width in pixels of the back buffer.

m_uBehaviorFlags

uint_t Burger::DisplayDirectX9::DeviceSettings_t::m_uBehaviorFlags

D3DCREATE_* flags.

m_uDeviceType

uint_t Burger::DisplayDirectX9::DeviceSettings_t::m_uDeviceType

D3DDEVTYPE Device type enumeration.

m_uFlags

uint_t Burger::DisplayDirectX9::DeviceSettings_t::m_uFlags

D3DPRESENTFLAG_* Presentation flags.

m_uFullScreen_RefreshRateInHz

uint_t Burger::DisplayDirectX9::DeviceSettings_t::m_uFullScreen_RefreshRateInHz

Refresh rate for VSync (set to 0 for a window)

m_uMultiSampleQuality

uint_t Burger::DisplayDirectX9::DeviceSettings_t::m_uMultiSampleQuality

Quality of the Anti-aliasing.

m_uMultiSampleType

uint_t Burger::DisplayDirectX9::DeviceSettings_t::m_uMultiSampleType

D3DMULTISAMPLE_TYPE Anti-alias type.

m_uPresentationInterval

uint_t Burger::DisplayDirectX9::DeviceSettings_t::m_uPresentationInterval

D3DPRESENT_INTERVAL_* valie.

m_uSwapEffect

uint_t Burger::DisplayDirectX9::DeviceSettings_t::m_uSwapEffect

D3DSWAPEFFECT Swap effect type.