(This is the legacy documentation for SDL2, the previous stable version; SDL3 is the current stable version.)

SDL_DXGIGetOutputInfo

Get the DXGI Adapter and Output indices for the specified display index.

Header File

Defined in SDL_system.h

Syntax

SDL_bool SDL_DXGIGetOutputInfo( int displayIndex, int *adapterIndex, int *outputIndex );

Function Parameters

int	displayIndex	the display index for which to get both indices.
int *	adapterIndex	a pointer to be filled in with the adapter index.
int *	outputIndex	a pointer to be filled in with the output index.

Return Value

(SDL_bool) Returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() for more information.

Remarks

The DXGI Adapter and Output indices can be passed to EnumAdapters and EnumOutputs respectively to get the objects required to create a DX10 or DX11 device and swap chain.

Before SDL 2.0.4 this function did not return a value. Since SDL 2.0.4 it returns an SDL_bool.

Version

This function is available since SDL 2.0.2.

---

CategoryAPI, CategoryAPIFunction, CategorySystem

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.