XFrontPanelGetScreenPixelFormat

Gets the pixel format of the front panel display.

Syntax

HRESULT XFrontPanelGetScreenPixelFormat(  
         DXGI_FORMAT* pixelFormat  
)  

Parameters

pixelFormat   _Out_
Type: DXGI_FORMAT*

Pointer to a value indicating the pixel format.

Return value

Type: HRESULT

Returns S_OK if successful; otherwise, returns an error code.

Remarks

The pixel format returned by this method is DXGI_FORMAT_R8_UNORM. The display supports only 4 bits per pixel; the lower four bits aren't used.

Use the pixel format to construct the buffer for the XFrontPanelPresentBuffer function.

For more information, see Xbox One X: Using the front panel display (NDA topic)Authorization required.

Requirements

Header: xfrontpaneldisplay.h

Library: xfrontpaneldisplay.lib

Supported platforms: Xbox One family consoles and Xbox Series consoles

See also

XFrontPanelDisplay